ilog.views.gantt.property

Class IlvActivityReservationsProperty

java.lang.Object

ilog.views.gantt.property.IlvActivityReservationsProperty

All Implemented Interfaces:

IlvProperty, IlvStringProperty

public class IlvActivityReservationsProperty
extends Object
implements IlvStringProperty

IlvActivityReservationsProperty is an adapter that allows an IlvActivity's list of reserved resources to be accessed via the generic IlvStringProperty interface.

Constructor Summary

Constructors

Constructor and Description
IlvActivityReservationsProperty(IlvHierarchyChart chart) Creates a new IlvActivityReservationsProperty that will format a comma-separated list of reserved resource IDs for an activity.
IlvActivityReservationsProperty(IlvHierarchyChart chart, IlvStringProperty resourceProperty) Creates a new IlvActivityReservationsProperty that will format a comma-separated list of reserved resources for an activity.

Method Summary

Modifier and Type	Method and Description
Iterator<IlvHierarchyNode>	changedRowsIterator(EventObject event) Returns an iterator over the activities that the specified event reports have changed with respect to this property.
Class	getEventClass() Returns the class of events that are triggered when an activity's list of reserved resources changes value.
IlvListFormat	getListFormat() Returns the list formatter used to format the list of resources for an activity.
Comparator<IlvReservation>	getSortingCriterion() Returns the sorting criterion for the reservations belonging to a single activity.
String	getValue(Object activity) Returns the specified IlvActivity's list of reserved resources.
boolean	isPropertyChangedEvent(EventObject event) Returns whether the specified event is a changed event for this property.
void	setListFormat(IlvListFormat listFormat) Sets the list formatter used to format the list of resources for an activity.
void	setSortingCriterion(Comparator<IlvReservation> sortingCriterion) Sets the sorting criterion for the reservations belonging to a single activity, as reported by getValue(Object).
void	setValue(Object activity, String s) Sets the specified IlvActivity's list of reserved resources.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvActivityReservationsProperty

public IlvActivityReservationsProperty(IlvHierarchyChart chart,
                                       IlvStringProperty resourceProperty)

Creates a new IlvActivityReservationsProperty that will format a comma-separated list of reserved resources for an activity. Each resource in the list is formatted using the specified resourceProperty.

Parameters:

chart - The chart that will be using this property.

resourceProperty - The format of each resource in the list.

Since:

JViews 5.5

IlvActivityReservationsProperty

public IlvActivityReservationsProperty(IlvHierarchyChart chart)

Creates a new IlvActivityReservationsProperty that will format a comma-separated list of reserved resource IDs for an activity.

Parameters:

chart - The chart that will be using this property.

Since:

JViews 5.5

Method Detail

getSortingCriterion

public Comparator<IlvReservation> getSortingCriterion()

Returns the sorting criterion for the reservations belonging to a single activity.

Since:

JViews 8.7

See Also:

setSortingCriterion(Comparator), getValue(Object)

setSortingCriterion

public void setSortingCriterion(Comparator<IlvReservation> sortingCriterion)

Sets the sorting criterion for the reservations belonging to a single activity, as reported by getValue(Object).

The default sorting criterion sorts the strings produced by the resourceProperty in ascending order.

Parameters:

sortingCriterion - A sorting criterion that compares two reservations, or null for no sorting at all (random order of resources).

Since:

JViews 8.7

See Also:

getSortingCriterion()

getListFormat

public IlvListFormat getListFormat()

Returns the list formatter used to format the list of resources for an activity.

Since:

JViews 8.7

See Also:

setListFormat(IlvListFormat), getValue(Object)

setListFormat

public void setListFormat(IlvListFormat listFormat)

Sets the list formatter used to format the list of resources for an activity.

Since:

JViews 8.7

See Also:

getListFormat()

getValue

public String getValue(Object activity)

Returns the specified IlvActivity's list of reserved resources.

Specified by:

getValue in interface IlvProperty

Specified by:

getValue in interface IlvStringProperty

Parameters:

activity - The activity.

Returns:

A comma-separated list of the reserved resource for the activity.

See Also:

getSortingCriterion(), getListFormat()

setValue

public void setValue(Object activity,
                     String s)
              throws ParseException

Sets the specified IlvActivity's list of reserved resources.

Specified by:

setValue in interface IlvStringProperty

Parameters:

activity - the activity

s - the new name for the activity

Throws:

ParseException - if the specified string is invalid

getEventClass

public Class getEventClass()

Returns the class of events that are triggered when an activity's list of reserved resources changes value.

Specified by:

getEventClass in interface IlvProperty

Returns:

The class of events that indicates that this property has changed value.

isPropertyChangedEvent

public boolean isPropertyChangedEvent(EventObject event)

Returns whether the specified event is a changed event for this property.

Specified by:

isPropertyChangedEvent in interface IlvProperty

Parameters:

event - The event.

Returns:

Whether the event is a changed event for this property.

changedRowsIterator

public Iterator<IlvHierarchyNode> changedRowsIterator(EventObject event)

Returns an iterator over the activities that the specified event reports have changed with respect to this property.

Specified by:

changedRowsIterator in interface IlvProperty

Parameters:

event - The event.

Returns:

The activity iterator.