ilog.views.gantt.model.general

Class IlvGeneralConstraint

java.lang.Object

ilog.views.gantt.model.IlvAbstractConstraint

ilog.views.gantt.model.IlvSimpleConstraint

ilog.views.gantt.model.general.IlvGeneralConstraint

All Implemented Interfaces:

IlvConstraint, IlvUserPropertyHolder, Serializable

public class IlvGeneralConstraint
extends IlvSimpleConstraint
implements IlvUserPropertyHolder

IlvGeneralConstraint is an extension of IlvSimpleConstraint that adds support for user-defined properties. IlvGeneralConstraint fires an ConstraintUserPropertyEvent both before and after a user-defined property is modified. Immediately before a property is modified, IlvGeneralConstraint fires an aboutToChange ConstraintUserPropertyEvent 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 IlvGeneralConstraint fires a changed ConstraintUserPropertyEvent to all listeners registered with the Gantt data model.

IlvGeneralConstraint predefines 3 properties that are inherited from its IlvSimpleConstraint 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 ConstraintUserPropertyEvents 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
constraintType	IlvConstraintType	getType	setType	ConstraintTypeEvent
fromActivity	IlvActivity	getFromActivity	n/a	n/a
toActivity	IlvActivity	getToActivity	n/a	n/a

Since:

JViews 5.5

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	FROM_ACTIVITY_PROPERTY Identifies the constraint's from-activity property.
static String	TO_ACTIVITY_PROPERTY Identifies the constraint's to-activity property.
static String	TYPE_PROPERTY Identifies the constraint's type property.

Constructor Summary

Constructors

Constructor and Description
IlvGeneralConstraint(IlvActivity fromActivity, IlvActivity toActivity, IlvConstraintType type) Creates a new IlvGeneralConstraint from the specified from-activity, to-activity, and type.

Method Summary

Modifier and Type	Method and Description
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 constraint.
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 constraint.
Iterator<String>	propertyNameIterator() Returns an iterator over all the property names of this constraint.
Object	setProperty(String property, Object value) Stores a user-defined property in this constraint's property table.

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

getFromActivity, getToActivity, getType, setType

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

fireEvent, fireTypeAboutToChange, fireTypeChanged, getGanttModel, setGanttModelImpl, toString

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_PROPERTY

public static final String TYPE_PROPERTY

Identifies the constraint's type property. The value is "constraintType".

See Also:

Constant Field Values

FROM_ACTIVITY_PROPERTY

public static final String FROM_ACTIVITY_PROPERTY

Identifies the constraint's from-activity property. The value is "fromActivity".

See Also:

Constant Field Values

TO_ACTIVITY_PROPERTY

public static final String TO_ACTIVITY_PROPERTY

Identifies the constraint's to-activity property. The value is "toActivity".

See Also:

Constant Field Values

Constructor Detail

IlvGeneralConstraint

public IlvGeneralConstraint(IlvActivity fromActivity,
                            IlvActivity toActivity,
                            IlvConstraintType type)

Creates a new IlvGeneralConstraint from the specified from-activity, to-activity, and type.

Parameters:

fromActivity - The source activity of the constraint.

toActivity - The destination activity of the constraint.

type - The type of the constraint.

Method Detail

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 constraint'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 constraint.

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 constraint.

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.

paramString

protected String paramString()

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

Overrides:

paramString in class IlvAbstractConstraint

Returns:

A string representing the status of the constraint.