ilog.views.gantt.model.general

Class IlvGeneralResource

java.lang.Object

ilog.views.gantt.model.IlvAbstractResource

ilog.views.gantt.model.IlvSimpleResource

ilog.views.gantt.model.general.IlvGeneralResource

All Implemented Interfaces:

IlvHierarchyNode, IlvResource, IlvUserPropertyHolder, Serializable

public class IlvGeneralResource
extends IlvSimpleResource
implements IlvUserPropertyHolder

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

IlvGeneralResource predefines 3 properties that are inherited from its IlvSimpleResource 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 ResourceUserPropertyEvents 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	ResourceIDEvent
name	String	getName	setName	ResourceNameEvent
quantity	Number	getQuantity	setQuantity	ResourceQuantityEvent

Since:

JViews 5.5

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID_PROPERTY Identifies the resource's ID property.
static String	NAME_PROPERTY Identifies the resource's name property.
static String	QUANTITY_PROPERTY Identifies the resource's quantity property.

Constructor Summary

Constructors

Constructor and Description
IlvGeneralResource(String id, String name) Creates a new IlvGeneralResource from the specified ID and name.
IlvGeneralResource(String id, String name, float quantity) Creates a new IlvGeneralResource from the specified ID, name, and quantity.

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

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

getID, getName, getQuantity, setID, setName, setQuantity

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

fireEvent, fireIDAboutToChange, fireIDChanged, fireNameAboutToChange, fireNameChanged, fireQuantityAboutToChange, fireQuantityChanged, getChildEventFilter, getGanttModel, processChildEvent, setGanttModelImpl, toString

Methods inherited from class java.lang.Object

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

Field Detail

ID_PROPERTY

public static final String ID_PROPERTY

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

See Also:

Constant Field Values

NAME_PROPERTY

public static final String NAME_PROPERTY

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

See Also:

Constant Field Values

QUANTITY_PROPERTY

public static final String QUANTITY_PROPERTY

Identifies the resource's quantity property. The value is "quantity".

See Also:

Constant Field Values

Constructor Detail

IlvGeneralResource

public IlvGeneralResource(String id,
                          String name,
                          float quantity)

Creates a new IlvGeneralResource from the specified ID, name, and quantity.

Parameters:

id - The resource ID.

name - The descriptive resource name.

quantity - The quantity of the resource.

IlvGeneralResource

public IlvGeneralResource(String id,
                          String name)

Creates a new IlvGeneralResource from the specified ID and name. The new resource will have a default quantity of 1.

Parameters:

id - The resource ID.

name - The descriptive resource name.

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

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

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

Overrides:

paramString in class IlvAbstractResource

Returns:

A string representing the status of the resource.