ilog.views.gantt.model

Class IlvAbstractResource

java.lang.Object

ilog.views.gantt.model.IlvAbstractResource

All Implemented Interfaces:

IlvHierarchyNode, IlvResource, Serializable

Direct Known Subclasses:

IlvSimpleResource, IlvTableResource

public abstract class IlvAbstractResource
extends Object
implements IlvResource, Serializable

IlvAbstractResource is the superclass of all IlvResource implementations. It provides a basic framework of event and property support that can be used by all concrete subclasses. All resource events are routed to the Gantt data model where interested listeners can register. Resources do not handle listener subscription and notification directly. Subclasses should always use the method fireEvent(ilog.views.gantt.event.ResourceEvent) to fire ResourceEvent instances so that generated events will be routed properly.

Since:

JViews 5.5

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvAbstractResource() Creates a new IlvAbstractResource.

Method Summary

Modifier and Type	Method and Description
protected void	fireEvent(ResourceEvent event) Fires an event from this resource.
protected ResourceIDEvent	fireIDAboutToChange(String newID) Fires an idAboutToChange event and returns the event after dispatching it to all listeners.
protected void	fireIDChanged(String oldID) Fires an idChanged event.
protected ResourceNameEvent	fireNameAboutToChange(String newName) Fires a nameAboutToChange event and returns the event after dispatching it to all listeners.
protected void	fireNameChanged(String oldName) Fires a nameChanged event.
protected ResourceQuantityEvent	fireQuantityAboutToChange(float newQuantity) Fires a quantityAboutToChange event and returns the event after dispatching it to all listeners.
protected void	fireQuantityChanged(float oldQuantity) Fires a quantityChanged event.
IlvUnaryPredicate<ResourceEvent>	getChildEventFilter() Returns a predicate that will be used to determine the events from this resource's children that should be dispatched to this resource's processChildEvent(ilog.views.gantt.event.ResourceEvent) method.
protected IlvGanttModel	getGanttModel() Returns the data model that is managing this resource.
protected String	paramString() Returns a parameter string that represents the status of this resource.
void	processChildEvent(ResourceEvent event) This method is invoked by the Gantt data model for any events fired by the children of this resource and for which the predicate returned by getChildEventFilter() evaluates to true.
void	setGanttModelImpl(IlvGanttModel model) This method is invoked by the IlvGanttModel when the resource is added or removed.
String	toString() Returns a string representation of this resource.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ilog.views.gantt.IlvResource

getID, getName, getQuantity, setID, setName, setQuantity

Constructor Detail

IlvAbstractResource

public IlvAbstractResource()

Creates a new IlvAbstractResource.

Method Detail

getGanttModel

protected IlvGanttModel getGanttModel()

Returns the data model that is managing this resource. This will be null if this resource has not been added to a data model yet.

Returns:

The Gantt data model managing the resource.

setGanttModelImpl

public void setGanttModelImpl(IlvGanttModel model)

This method is invoked by the IlvGanttModel when the resource is added or removed.

Warning: This method is considered to be part of an IlvResource's internal implementation and is not a public API. You should only invoke this method directly if you have created your own IlvGanttModel implementation.

Specified by:

setGanttModelImpl in interface IlvResource

Parameters:

model - The data model that this resource has been added to, or null if this resource has been removed from the data model.

fireEvent

protected final void fireEvent(ResourceEvent event)

Fires an event from this resource. Subclasses should always use this method to fire resource events because it properly routes the event. If the parent of the resource indicates, via the getChildEventFilter() method, that it is interested in the event, then the Gantt data model dispatches the event to the processChildEvent(ilog.views.gantt.event.ResourceEvent) method of the parent resource.

Parameters:

event - The resource event.

getChildEventFilter

public IlvUnaryPredicate<ResourceEvent> getChildEventFilter()

Returns a predicate that will be used to determine the events from this resource's children that should be dispatched to this resource's processChildEvent(ilog.views.gantt.event.ResourceEvent) method. The Gantt data model applies the predicate to all ResourceEvent events fired by the children of this resource. If the predicate evaluates to true, the Gantt data model dispatches the child's event to the processChildEvent() method. This allows you to easily implement a parent resource property that is automatically computed from one or more properties of its children.

This default implementation returns a predicate that always evaluates to false, indicating that this resource should not receive any events from its children. Subclasses can override this method as needed.

Specified by:

getChildEventFilter in interface IlvResource

Returns:

The predicate used to filter events from the resource's children.

processChildEvent

public void processChildEvent(ResourceEvent event)

This method is invoked by the Gantt data model for any events fired by the children of this resource and for which the predicate returned by getChildEventFilter() evaluates to true. This allows you to easily implement a parent resource property that is automatically computed from one or more properties of its children.

This default implementation does nothing. Subclasses can override this method as needed.

Specified by:

processChildEvent in interface IlvResource

Parameters:

event - The child resource event.

fireIDAboutToChange

protected ResourceIDEvent fireIDAboutToChange(String newID)

Fires an idAboutToChange event and returns the event after dispatching it to all listeners.

Parameters:

newID - The new identifier proposed for the resource.

Returns:

The event after dispatching to all listeners.

See Also:

ResourceIDEvent

fireIDChanged

protected void fireIDChanged(String oldID)

Fires an idChanged event.

Parameters:

oldID - The previous identifier of the resource.

See Also:

ResourceIDEvent

fireNameAboutToChange

protected ResourceNameEvent fireNameAboutToChange(String newName)

Fires a nameAboutToChange event and returns the event after dispatching it to all listeners.

Parameters:

newName - The new name proposed for the resource.

Returns:

The event after dispatching to all listeners.

See Also:

ResourceNameEvent

fireNameChanged

protected void fireNameChanged(String oldName)

Fires a nameChanged event.

Parameters:

oldName - The previous name of the resource.

See Also:

ResourceNameEvent

fireQuantityAboutToChange

protected ResourceQuantityEvent fireQuantityAboutToChange(float newQuantity)

Fires a quantityAboutToChange event and returns the event after dispatching it to all listeners.

Parameters:

newQuantity - The new quantity proposed for the resource.

Returns:

The event after dispatching to all listeners.

See Also:

ResourceQuantityEvent

fireQuantityChanged

protected void fireQuantityChanged(float oldQuantity)

Fires a quantityChanged event.

Parameters:

oldQuantity - The previous resource quantity.

See Also:

ResourceQuantityEvent

paramString

protected String paramString()

Returns a parameter string that represents the status of this resource.

Returns:

A string representing the status of the resource.

toString

public String toString()

Returns a string representation of this resource.

Overrides:

toString in class Object

Returns:

A string representing the resource.