ilog.views.gantt.model.general

Class IlvGeneralActivity

java.lang.Object

ilog.views.gantt.model.IlvAbstractActivity

ilog.views.gantt.model.IlvSimpleActivity

ilog.views.gantt.model.general.IlvGeneralActivity

All Implemented Interfaces:

IlvActivity, IlvHierarchyNode, IlvPropertyHolderActivity, IlvUserPropertyHolder, Serializable

public class IlvGeneralActivity
extends IlvSimpleActivity
implements IlvPropertyHolderActivity

IlvGeneralActivity is an extension of IlvSimpleActivity that adds support for user-defined properties. IlvGeneralActivity fires an ActivityUserPropertyEvent both before and after a user-defined property is modified. Immediately before a property is modified, IlvGeneralActivity fires an aboutToChange ActivityUserPropertyEvent to all listeners registered with the Gantt data model. This gives the listeners an opportunity to constrain or veto the proposed property change. If the property change is not vetoed, then the change is applied and IlvGeneralActivity fires a changed ActivityUserPropertyEvent to all listeners registered with the Gantt data model.

IlvGeneralActivity predefines 6 properties that are inherited from its IlvSimpleActivity superclass. These predefined properties can be accessed through the getProperty(java.lang.String) and setProperty(java.lang.String, java.lang.Object) methods in the same manner as user-defined properties. However, the predefined properties fire specific event types. They do not fire ActivityUserPropertyEvents as described above for user-defined properties. The predefined events are shown in the following table:

Property	Value Type	Equivalent getXXX Method	Equivalent setXXX Method	Event Type
id	String	getID	setID	ActivityIDEvent
name	String	getName	setName	ActivityNameEvent
startTime	Date	getStartTime	setStartTime	ActivityTimeIntervalEvent
endTime	Date	getEndTime	setEndTime	ActivityTimeIntervalEvent
duration	IlvDuration	getDuration	setDuration	ActivityTimeIntervalEvent
timeInterval	IlvTimeInterval	getTimeInterval	setTimeInterval	ActivityTimeIntervalEvent

Since:

JViews 5.5

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IlvGeneralActivity.Factory IlvGeneralActivity.Factory is a factory that creates instances of IlvGeneralActivity.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DURATION_PROPERTY Identifies the activity's duration property.
static String	ID_PROPERTY Identifies the activity's ID property.
static String	NAME_PROPERTY Identifies the activity's name property.
static String	TIME_INTERVAL_PROPERTY Identifies the activity's time interval property.

Fields inherited from interface ilog.views.gantt.model.IlvPropertyHolderActivity

END_TIME_PROPERTY, START_TIME_PROPERTY, TIME_PROPERTIES_PROPERTY

Constructor Summary

Constructors

Constructor and Description
IlvGeneralActivity(String id, String name, Date start, Date end) Creates a new IlvGeneralActivity from the specified ID, name, and time interval.
IlvGeneralActivity(String id, String name, Date start, IlvDuration duration) Creates a new IlvGeneralActivity from the specified ID, name, start time, and duration.
IlvGeneralActivity(String id, String name, IlvTimeInterval interval) Creates a new IlvGeneralActivity from the specified ID, name, and time interval.

Method Summary

Modifier and Type	Method and Description
protected ActivityUserPropertyEvent	firePropertyAboutToChange(String property, Object oldValue, Object newValue) Fires a user property aboutToChange event and returns the event after dispatching it to all listeners.
protected void	firePropertyChanged(String property, Object oldValue, Object newValue) Fires a user property changed event.
Object	getProperty(String property) Returns the value of a user-defined property or null if the property does not exist.
Collection<String>	getPropertyNames() Returns a collection that contains the names of all the properties of this activity.
String[]	getTimeProperties() Returns the names of the properties that denote the specific time points of this activity.
boolean	isUserProperty(String name) Returns true if the property is a user-defined property.
protected String	paramString() Returns a parameter string that represents the state of this activity.
Iterator<String>	propertyNameIterator() Returns an iterator over all the property names of this activity.
Object	setProperty(String property, Object value) Stores a user-defined property in this activity's property table.
void	setTimeInterval(IlvTimeInterval interval) Overridden to take into account the getTimeProperties() result.
void	setTimeProperties(String[] timeProperties) Changes the set of properties that are the specific time points of this activity and from which the start time and the end time are computed.

Methods inherited from class ilog.views.gantt.model.IlvSimpleActivity

computeTimeIntervalFromChildren, getAutoCalcTimeIntervalFromChildren, getChildEventFilter, getID, getName, getTimeInterval, processChildEvent, setAutoCalcTimeIntervalFromChildren, setGanttModelImpl, setID, setName, updateTimeInterval

Methods inherited from class ilog.views.gantt.model.IlvAbstractActivity

fireEvent, fireIDAboutToChange, fireIDChanged, fireNameAboutToChange, fireNameChanged, fireTimeIntervalAboutToChange, fireTimeIntervalChanged, getDuration, getEndTime, getGanttModel, getStartTime, setDuration, setEndTime, setStartTime, setTimeInterval, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ilog.views.gantt.IlvActivity

getChildEventFilter, getEndTime, getID, getName, getStartTime, getTimeInterval, processChildEvent, setEndTime, setGanttModelImpl, setID, setName, setStartTime, setTimeInterval

Field Detail

ID_PROPERTY

public static final String ID_PROPERTY

Identifies the activity's ID property. The value is "id".

See Also:

Constant Field Values

NAME_PROPERTY

public static final String NAME_PROPERTY

Identifies the activity's name property. The value is "name".

See Also:

Constant Field Values

DURATION_PROPERTY

public static final String DURATION_PROPERTY

Identifies the activity's duration property. The value is "duration".

See Also:

Constant Field Values

TIME_INTERVAL_PROPERTY

public static final String TIME_INTERVAL_PROPERTY

Identifies the activity's time interval property. The value is "timeInterval".

See Also:

Constant Field Values

Constructor Detail

IlvGeneralActivity

public IlvGeneralActivity(String id,
                          String name,
                          IlvTimeInterval interval)

Creates a new IlvGeneralActivity from the specified ID, name, and time interval.

Parameters:

id - The activity ID.

name - The descriptive activity name.

interval - The start and end time of the activity.

IlvGeneralActivity

public IlvGeneralActivity(String id,
                          String name,
                          Date start,
                          Date end)

Creates a new IlvGeneralActivity from the specified ID, name, and time interval.

Parameters:

id - The activity ID.

name - The descriptive activity name.

start - The activity start time.

end - The activity end time.

IlvGeneralActivity

public IlvGeneralActivity(String id,
                          String name,
                          Date start,
                          IlvDuration duration)

Creates a new IlvGeneralActivity from the specified ID, name, start time, and duration.

Parameters:

id - The activity ID.

name - The descriptive activity name.

start - The activity start time.

duration - The activity duration.

Method Detail

getTimeProperties

public final String[] getTimeProperties()

Returns the names of the properties that denote the specific time points of this activity.

The default value in this class is null.

Specified by:

getTimeProperties in interface IlvPropertyHolderActivity

Returns:

An unmodifiable array of property names, or null.

Since:

JViews 8.5

setTimeProperties

public void setTimeProperties(String[] timeProperties)

Changes the set of properties that are the specific time points of this activity and from which the start time and the end time are computed.

Specified by:

setTimeProperties in interface IlvPropertyHolderActivity

Parameters:

timeProperties - A nonempty set of properties whose values are always of type Date, excluding IlvPropertyHolderActivity.START_TIME_PROPERTY and IlvPropertyHolderActivity.END_TIME_PROPERTY, or null.

Since:

JViews 8.5

setTimeInterval

public void setTimeInterval(IlvTimeInterval interval)

Overridden to take into account the getTimeProperties() result.

Specified by:

setTimeInterval in interface IlvActivity

Overrides:

setTimeInterval in class IlvSimpleActivity

Parameters:

interval - The start and end times.

getProperty

public Object getProperty(String property)

Returns the value of a user-defined property or null if the property does not exist.

Specified by:

getProperty in interface IlvUserPropertyHolder

Parameters:

property - The name of the property.

Returns:

The value of the property or null if the property does not exist.

See Also:

setProperty(java.lang.String, java.lang.Object), getPropertyNames()

setProperty

public Object setProperty(String property,
                          Object value)

Stores a user-defined property in this activity's property table.

Specified by:

setProperty in interface IlvUserPropertyHolder

Parameters:

property - The name of the property.

value - The value of the property. If the value is null then the property is removed.

Returns:

The value of the property set or the old value of the property if the value is being removed.

See Also:

getProperty(java.lang.String), getPropertyNames()

propertyNameIterator

public Iterator<String> propertyNameIterator()

Returns an iterator over all the property names of this activity.

Specified by:

propertyNameIterator in interface IlvUserPropertyHolder

Returns:

The iterator.

Since:

JViews 6.0

getPropertyNames

public Collection<String> getPropertyNames()

Returns a collection that contains the names of all the properties of this activity.

isUserProperty

public boolean isUserProperty(String name)

Returns true if the property is a user-defined property.

Specified by:

isUserProperty in interface IlvUserPropertyHolder

Parameters:

name - The name of the property.

Returns:

Returns true if the property is a user-defined property, false otherwise.

firePropertyAboutToChange

protected ActivityUserPropertyEvent firePropertyAboutToChange(String property,
                                                              Object oldValue,
                                                              Object newValue)

Fires a user property aboutToChange event and returns the event after dispatching it to all listeners.

Parameters:

property - The name of the property being changed.

oldValue - The property's value before the change.

newValue - The property's value after the change.

Since:

JViews 8.5

See Also:

ActivityUserPropertyEvent

firePropertyChanged

protected void firePropertyChanged(String property,
                                   Object oldValue,
                                   Object newValue)

Fires a user property changed event.

Parameters:

property - The name of the property that has changed.

oldValue - The property's value before the change.

newValue - The property's value after the change.

Since:

JViews 8.5

See Also:

ActivityUserPropertyEvent

paramString

protected String paramString()

Returns a parameter string that represents the state of this activity.

Overrides:

paramString in class IlvAbstractActivity

Returns:

A string representing the status of the activity.