ilog.views.gantt.model

Class IlvAbstractGanttModel

java.lang.Object

ilog.views.gantt.model.IlvAbstractGanttModel

All Implemented Interfaces:

IlvGanttModel, Serializable

Direct Known Subclasses:

IlvDefaultGanttModel, IlvFilterGanttModel, IlvTableGanttModel

public abstract class IlvAbstractGanttModel
extends Object
implements IlvGanttModel, Serializable

IlvAbstractGanttModel is the superclass of all IlvGanttModel implementations. It provides a basic framework of event support that can be used by all concrete subclasses.

Since:

JViews 5.5

See Also:

Serialized Form

Field Summary

Fields inherited from interface ilog.views.gantt.IlvGanttModel

ADJUSTING_PROPERTY, BATCHING_PROPERTY

Constructor Summary

Constructors

Constructor and Description
IlvAbstractGanttModel() Creates a new IlvAbstractGanttModel.

Method Summary

Modifier and Type	Method and Description
Iterator<IlvActivity>	activityPreorderIterator() Returns an iterator that traverses all activities in preorder.
Iterator<IlvActivity>	activityPreorderIterator(IlvActivity parent) Returns an iterator that will traverse the parent activity and all of its descendants in preorder.
void	addActivity(IlvActivity newActivity, IlvActivity parent) Appends newActivity as the last child of the parent activity.
void	addActivityHierarchyListener(ActivityHierarchyListener aListener) Adds the specified listener to receive activity hierarchy events from this data model.
void	addActivityListener(ActivityListener aListener) Adds the specified listener to receive activity events from this data model.
void	addConstraintListener(ConstraintListener aListener) Adds the specified listener to receive constraint events from this data model.
void	addGanttModelPropertyListener(GanttModelPropertyListener listener) Adds the specified listener to receive notification of changes to properties of the data model.
void	addReservationListener(ReservationListener aListener) Adds the specified listener to receive reservation events from this data model.
void	addResource(IlvResource newResource, IlvResource parent) Appends newResource as the last child of the parent resource.
void	addResourceHierarchyListener(ResourceHierarchyListener aListener) Adds the specified listener to receive resource hierarchy events from this data model.
void	addResourceListener(ResourceListener aListener) Adds the specified listener to receive resource events from this data model.
Iterator<IlvActivity>	childActivityIterator(IlvActivity parent) Returns an iterator over the parent activity's children.
Iterator<IlvResource>	childResourceIterator(IlvResource parent) Returns an iterator over the parent resource's children.
void	clear() Removes all objects from the data model.
protected void	fireActivitiesInserted(IlvActivity parent, int[] childIndices) Fires an ActivitiesInsertedEvent.
protected void	fireActivitiesInserted(IlvActivity parent, List<IlvActivity> children) Fires an ActivitiesInsertedEvent.
protected void	fireActivitiesRemoved(IlvActivity parent, List<IlvActivity> children, int[] childIndices) Fires an ActivitiesRemovedEvent.
protected void	fireActivitiesRemoved(IlvActivity parent, List<IlvActivity> children, List<Integer> childIndices) Fires an ActivitiesRemovedEvent.
void	fireActivityEvent(ActivityEvent event) Fires an activityChanged event.
protected void	fireActivityInserted(IlvActivity parent, IlvActivity child) Fires an ActivitiesInsertedEvent.
protected void	fireActivityMoved(IlvActivity activity, IlvActivity oldParent, int oldIndex, IlvActivity newParent, int newIndex) Fires an ActivityMovedEvent.
protected void	fireActivityRemoved(IlvActivity parent, IlvActivity child, int childIndex) Fires an ActivitiesRemovedEvent.
void	fireConstraintEvent(ConstraintEvent event) Fires a constraint event to all subscribed listeners.
protected void	fireConstraintInserted(IlvConstraint constraint) Fires a ConstraintInsertedEvent.
protected void	fireConstraintRemoved(IlvConstraint constraint) Fires a ConstraintRemovedEvent.
protected void	fireConstraintRemoved(IlvConstraint constraint, boolean removingActivity) Fires a ConstraintRemovedEvent.
protected void	fireGanttModelPropertyEvent(GanttModelPropertyEvent event) Fires a Gantt model property change event.
void	fireReservationEvent(ReservationEvent event) Fires a reservation event to all subscribed listeners.
protected void	fireReservationInserted(IlvReservation reservation) Fires a ReservationInsertedEvent.
protected void	fireReservationRemoved(IlvReservation reservation) Fires a ReservationRemovedEvent.
protected void	fireReservationRemoved(IlvReservation reservation, int removingEntity) Fires a ReservationRemovedEvent.
void	fireResourceEvent(ResourceEvent event) Fires a resourceChanged event.
protected void	fireResourceInserted(IlvResource parent, IlvResource child) Fires a ResourcesInsertedEvent.
protected void	fireResourceMoved(IlvResource resource, IlvResource oldParent, int oldIndex, IlvResource newParent, int newIndex) Fires a ResourceMovedEvent.
protected void	fireResourceRemoved(IlvResource parent, IlvResource child, int childIndex) Fires a ResourcesRemovedEvent.
protected void	fireResourcesInserted(IlvResource parent, int[] childIndices) Fires a ResourcesInsertedEvent.
protected void	fireResourcesInserted(IlvResource parent, List<IlvResource> children) Fires a ResourcesInsertedEvent.
protected void	fireResourcesRemoved(IlvResource parent, List<IlvResource> children, int[] childIndices) Fires a ResourcesRemovedEvent.
protected void	fireResourcesRemoved(IlvResource parent, List<IlvResource> children, List<Integer> childIndices) Fires a ResourcesRemovedEvent.
protected Iterator<ActivityHierarchyListener>	getActivityHierarchyListeners() Returns an iterator over the data model's activity hierarchy event listeners.
protected Iterator<ActivityListener>	getActivityListeners() Returns an iterator over the data model's activity event listeners.
IlvHierarchyNode	getChild(IlvHierarchyNode parent, int index) Returns the child of the specified parent activity or resource at index index.
int	getChildCount(IlvHierarchyNode parent) Returns the number of children of the specified parent activity or resource.
int	getChildIndex(IlvHierarchyNode parent, IlvHierarchyNode child) Returns the index of the specified child in the parent activity or resource's list of children.
IlvHierarchyNode	getParent(IlvHierarchyNode activityOrResource) Returns the parent of the specified activity or resource.
int	getParentIndex(IlvHierarchyNode activityOrResource) Returns the index of the specified activity or resource within its parent.
protected Iterator<ResourceHierarchyListener>	getResourceHierarchyListeners() Returns an iterator over the data model's resource hierarchy event listeners.
protected Iterator<ResourceListener>	getResourceListeners() Returns an iterator over the data model's resource event listeners.
boolean	isAdjusting() Returns whether an adjustment session is currently active.
boolean	isBatching() Returns whether a batching session is currently active.
protected boolean	registerEventListener(String key, Object listener) Registers the specified event listener, which has just been deserialized, with this data model.
void	removeActivityHierarchyListener(ActivityHierarchyListener aListener) Removes the specified listener so that it no longer receives activity hierarchy events from this data model.
void	removeActivityListener(ActivityListener aListener) Removes the specified listener so that it no longer receives activity events from this data model.
void	removeConstraintListener(ConstraintListener aListener) Removes the specified listener so that it no longer receives constraint events from this data model.
void	removeGanttModelPropertyListener(GanttModelPropertyListener listener) Removes the specified listener so that it no longer receives notification of changes to properties of the data model.
void	removeReservationListener(ReservationListener aListener) Removes the specified listener so that it no longer receives reservation events from this data model.
void	removeResourceHierarchyListener(ResourceHierarchyListener aListener) Removes the specified listener so that it no longer receives resource hierarchy events from this data model.
void	removeResourceListener(ResourceListener aListener) Removes the specified listener so that it no longer receives resource events from this data model.
Iterator<IlvResource>	resourcePreorderIterator() Returns an iterator that traverses all resources in preorder.
Iterator<IlvResource>	resourcePreorderIterator(IlvResource parent) Returns an iterator that will traverse the parent resource and all of its descendants in preorder.
void	setAdjusting(boolean adjusting) Starts or ends an adjustment session.
void	setBatching(boolean batching) Starts or ends a batching session.
protected void	writeEventListeners(ObjectOutputStream stream) Serializes the transient event listeners of this data model to the specified stream.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ilog.views.gantt.IlvGanttModel

addActivity, addConstraint, addReservation, addResource, constraintIterator, constraintIteratorFromActivity, constraintIteratorToActivity, contains, contains, contains, getChildActivity, getChildActivityCount, getChildActivityIndex, getChildResource, getChildResourceCount, getChildResourceIndex, getParentActivity, getParentActivityIndex, getParentResource, getParentResourceIndex, getRootActivity, getRootResource, moveActivity, moveResource, removeActivity, removeActivity, removeConstraint, removeReservation, removeResource, removeResource, reservationIterator, reservationIterator, reservationIterator, reservationIterator, setRootActivity, setRootResource

Constructor Detail

IlvAbstractGanttModel

public IlvAbstractGanttModel()

Creates a new IlvAbstractGanttModel.

Method Detail

clear

public void clear()

Removes all objects from the data model.

Since:

JViews 8.0

setAdjusting

public void setAdjusting(boolean adjusting)

Starts or ends an adjustment session. Adjustment sessions can be nested and each call to setAdjusting(true) must be paired with a call to setAdjusting(false). An adjusting property event is fired when the outermost adjustment session begins and ends.

Specified by:

setAdjusting in interface IlvGanttModel

Parameters:

adjusting - True to start an adjustment session or false to end an adjustment session.

Since:

JViews 7.5

See Also:

isAdjusting()

isAdjusting

public boolean isAdjusting()

Returns whether an adjustment session is currently active.

Specified by:

isAdjusting in interface IlvGanttModel

Returns:

Whether an adjustment session is active.

Since:

JViews 7.5

See Also:

setAdjusting(boolean)

setBatching

public void setBatching(boolean batching)

Starts or ends a batching session. Batching sessions can be nested and each call to setBatching(true) must be paired with a call to setBatching(false). A batching property event is fired when the outermost batching session begins and ends.

Specified by:

setBatching in interface IlvGanttModel

Parameters:

batching - True to start a batching session or false to end a batching session.

Since:

JViews 8.7

See Also:

isBatching()

isBatching

public boolean isBatching()

Returns whether a batching session is currently active.

Specified by:

isBatching in interface IlvGanttModel

Returns:

true if a batching session is active.

Since:

JViews 8.7

See Also:

setBatching(boolean)

addGanttModelPropertyListener

public void addGanttModelPropertyListener(GanttModelPropertyListener listener)

Adds the specified listener to receive notification of changes to properties of the data model. The listener is registered for all bound properties of the model, including the following:

• IlvGanttModel.ADJUSTING_PROPERTY
• IlvGanttModel.BATCHING_PROPERTY

Note that the listener will only be notified of changes to properties of the data model itself. It will not be notified of changes to the properties of activities, resources, constraints, or reservations that are members of the data model.

Specified by:

addGanttModelPropertyListener in interface IlvGanttModel

Parameters:

listener - The listener that will be subscribed to subsequent GanttModelPropertyEvents.

Since:

JViews 7.5

See Also:

removeGanttModelPropertyListener(ilog.views.gantt.event.GanttModelPropertyListener)

removeGanttModelPropertyListener

public void removeGanttModelPropertyListener(GanttModelPropertyListener listener)

Removes the specified listener so that it no longer receives notification of changes to properties of the data model.

Specified by:

removeGanttModelPropertyListener in interface IlvGanttModel

Parameters:

listener - The listener that will be unsubscribed from receiving. GanttModelPropertyEvents.

Since:

JViews 7.5

See Also:

addGanttModelPropertyListener(ilog.views.gantt.event.GanttModelPropertyListener)

fireGanttModelPropertyEvent

protected void fireGanttModelPropertyEvent(GanttModelPropertyEvent event)

Fires a Gantt model property change event.

Parameters:

event - The property change event.

Since:

JViews 7.5

See Also:

addGanttModelPropertyListener(ilog.views.gantt.event.GanttModelPropertyListener), GanttModelPropertyListener.propertyChanged(ilog.views.gantt.event.GanttModelPropertyEvent)

getParent

public IlvHierarchyNode getParent(IlvHierarchyNode activityOrResource)

Returns the parent of the specified activity or resource. This method returns null if the activity is the root activity of the data model or if the resource is the root resource of the data model.

Specified by:

getParent in interface IlvGanttModel

Parameters:

activityOrResource - The activity or resource.

Returns:

The parent of the specified activity or resource.

Throws:

IllegalArgumentException - if activityOrResource is not a member of this data model.

getParentIndex

public int getParentIndex(IlvHierarchyNode activityOrResource)

Returns the index of the specified activity or resource within its parent. If the activity is the root activity of the data model or the resource is the root resource of the data model, then -1 is returned.

Specified by:

getParentIndex in interface IlvGanttModel

Parameters:

activityOrResource - The activity or resource.

Returns:

The index of the specified activity or resource.

Throws:

IllegalArgumentException - if activityOrResource is not a member of this data model.

getChildCount

public int getChildCount(IlvHierarchyNode parent)

Returns the number of children of the specified parent activity or resource.

Specified by:

getChildCount in interface IlvGanttModel

Parameters:

parent - The parent activity or resource.

Returns:

The number of child activities or resources.

Throws:

IllegalArgumentException - if parent is not a member of this data model.

getChild

public IlvHierarchyNode getChild(IlvHierarchyNode parent,
                                 int index)

Returns the child of the specified parent activity or resource at index index.

Specified by:

getChild in interface IlvGanttModel

Parameters:

parent - The parent activity or resource.

index - The child index.

Returns:

The child at index index.

Throws:

IllegalArgumentException - if parent is not a member of this data model.

IndexOutOfBoundsException - if index is out of range (index < 0 || index >= getChildCount(parent)).

getChildIndex

public int getChildIndex(IlvHierarchyNode parent,
                         IlvHierarchyNode child)

Returns the index of the specified child in the parent activity or resource's list of children.

Specified by:

getChildIndex in interface IlvGanttModel

Parameters:

parent - The parent activity or resource.

child - The child activity or resource to find the index of.

Returns:

The index of the child, or -1 if it is not a child of parent.

Throws:

IllegalArgumentException - if parent is not a member of this data model.

addActivity

public void addActivity(IlvActivity newActivity,
                        IlvActivity parent)

Appends newActivity as the last child of the parent activity. After the activity has been added, the data model fires an ActivitiesInsertedEvent.

Specified by:

addActivity in interface IlvGanttModel

Parameters:

newActivity - The activity to add.

parent - The parent activity to which newActivity is added. The implementation of this method uses IlvGanttModelUtil.checkValidMemberActivity(ilog.views.gantt.IlvActivity, ilog.views.gantt.IlvGanttModel) to validate parent.

Throws:

IllegalArgumentException - if newActivity is null or parent is not a member of this data model.

See Also:

ActivityHierarchyListener.activitiesInserted(ilog.views.gantt.event.ActivitiesInsertedEvent)

childActivityIterator

public Iterator<IlvActivity> childActivityIterator(IlvActivity parent)

Returns an iterator over the parent activity's children.

This implementation of childActivityIterator is based on the methods IlvGanttModel.getChildActivityCount(IlvActivity) and IlvGanttModel.getChildActivity(IlvActivity, int).

Specified by:

childActivityIterator in interface IlvGanttModel

Parameters:

parent - The parent activity.

Returns:

An iterator over the children of parent.

activityPreorderIterator

public Iterator<IlvActivity> activityPreorderIterator(IlvActivity parent)

Returns an iterator that will traverse the parent activity and all of its descendants in preorder. The first activity returned by the iterator's next() method will be parent.

This implementation of activityPreorderIterator is based on the method childActivityIterator(IlvActivity).

Specified by:

activityPreorderIterator in interface IlvGanttModel

Parameters:

parent - The parent of the activity subtree.

Returns:

An iterator for traversing the subtree of activities in preorder.

See Also:

activityPreorderIterator(), IlvGanttModelUtil.activityPreorderIterator(ilog.views.gantt.IlvGanttModel)

activityPreorderIterator

public Iterator<IlvActivity> activityPreorderIterator()

Returns an iterator that traverses all activities in preorder. The first activity returned by the next() method of the iterator is the root activity of the model.

This implementation of activityPreorderIterator is based on the method childActivityIterator(IlvActivity).

Returns:

An iterator for traversing the hierarchy of activities in preorder.

Since:

JViews 6.0

See Also:

activityPreorderIterator(IlvActivity), IlvGanttModelUtil.activityPreorderIterator(ilog.views.gantt.IlvGanttModel)

addActivityHierarchyListener

public void addActivityHierarchyListener(ActivityHierarchyListener aListener)

Adds the specified listener to receive activity hierarchy events from this data model.

Specified by:

addActivityHierarchyListener in interface IlvGanttModel

Parameters:

aListener - The listener that will be subscribed to subsequent ActivityHierarchyListener events.

See Also:

removeActivityHierarchyListener(ilog.views.gantt.event.ActivityHierarchyListener)

removeActivityHierarchyListener

public void removeActivityHierarchyListener(ActivityHierarchyListener aListener)

Removes the specified listener so that it no longer receives activity hierarchy events from this data model.

Specified by:

removeActivityHierarchyListener in interface IlvGanttModel

Parameters:

aListener - The listener that will be unsubscribed from receiving ActivityHierarchyListener events.

See Also:

addActivityHierarchyListener(ilog.views.gantt.event.ActivityHierarchyListener)

getActivityHierarchyListeners

protected Iterator<ActivityHierarchyListener> getActivityHierarchyListeners()

Returns an iterator over the data model's activity hierarchy event listeners.

Returns:

An iterator over the data model's activity hierarchy event listeners.

See Also:

addActivityHierarchyListener(ilog.views.gantt.event.ActivityHierarchyListener), removeActivityHierarchyListener(ilog.views.gantt.event.ActivityHierarchyListener)

fireActivitiesInserted

protected void fireActivitiesInserted(IlvActivity parent,
                                      int[] childIndices)

Fires an ActivitiesInsertedEvent. Note: This method cannot be used to notify listeners when the root activity has been added.

Parameters:

parent - The parent activity to which child activities have been added.

childIndices - An int array that specifies the index values of the inserted activities. The indices represent the final state of the activity tree, after the child activities have been inserted. The indices do not have to be pre-sorted.

See Also:

ActivityHierarchyListener.activitiesInserted(ilog.views.gantt.event.ActivitiesInsertedEvent)

fireActivitiesInserted

protected void fireActivitiesInserted(IlvActivity parent,
                                      List<IlvActivity> children)

Fires an ActivitiesInsertedEvent.

Parameters:

parent - The parent activity to which child activities have been added. If the reported insertion is that of the root activity, parent should be null and children should be a single-element list containing the root activity.

children - The list of child activities that have been inserted. The activities do not have to be pre-sorted.

See Also:

ActivityHierarchyListener.activitiesInserted(ilog.views.gantt.event.ActivitiesInsertedEvent)

fireActivityInserted

protected void fireActivityInserted(IlvActivity parent,
                                    IlvActivity child)

Fires an ActivitiesInsertedEvent.

Parameters:

parent - The parent activity to which child activities have been added. If the reported insertion is that of the root activity, parent should be null and child should be the root activity.

child - The child activity that has been inserted.

Since:

JViews 7.5

See Also:

ActivityHierarchyListener.activitiesInserted(ilog.views.gantt.event.ActivitiesInsertedEvent)

fireActivitiesRemoved

protected void fireActivitiesRemoved(IlvActivity parent,
                                     List<IlvActivity> children,
                                     int[] childIndices)

Fires an ActivitiesRemovedEvent.

Parameters:

parent - The parent activity from which child activities have been removed. If the reported deletion is that of the root activity, parent should be null, children should be a single-element list containing the root activity, and childIndices should be a single-element array with childIndices[0]=0.

children - The list of child activities that have been removed. The activities do not have to be pre-sorted, but must be arranged in parallel with childIndices. In other words, childIndices[i] must contain the index that the activity (IlvActivity)children.get(i) had before it was removed.

childIndices - An int array that specifies the index values that the child activities had before they were removed. The indices do not have to be pre-sorted, but must be arranged in parallel with children.

See Also:

ActivityHierarchyListener.activitiesRemoved(ilog.views.gantt.event.ActivitiesRemovedEvent)

fireActivitiesRemoved

protected void fireActivitiesRemoved(IlvActivity parent,
                                     List<IlvActivity> children,
                                     List<Integer> childIndices)

Fires an ActivitiesRemovedEvent.

Parameters:

parent - The parent activity from which child activities have been removed. If the reported deletion is that of the root activity, parent should be null, children should be a single-element list containing the root activity, and childIndices should be a single-element list containing Integer(0).

children - The list of child activities that have been removed. The activities do not have to be pre-sorted, but must be arranged in parallel with childIndices. In other words, childIndices[i] must contain the index that the activity (IlvActivity)children.get(i) had before it was removed.

childIndices - A list of Integers that specifies the index values that the child activities had before they were removed. The indices do not have to be pre-sorted, but must be arranged in parallel with children.

Since:

JViews 7.5

See Also:

ActivityHierarchyListener.activitiesRemoved(ilog.views.gantt.event.ActivitiesRemovedEvent)

fireActivityRemoved

protected void fireActivityRemoved(IlvActivity parent,
                                   IlvActivity child,
                                   int childIndex)

Fires an ActivitiesRemovedEvent.

Parameters:

parent - The parent activity from which the child activity has been removed. If the reported deletion is that of the root activity, parent should be null, child should be the root activity, and childIndex should be 0.

child - The child activity that has been removed.

childIndex - The index value that the child activity had before it was removed.

Since:

JViews 7.5

See Also:

ActivityHierarchyListener.activitiesRemoved(ilog.views.gantt.event.ActivitiesRemovedEvent)

fireActivityMoved

protected void fireActivityMoved(IlvActivity activity,
                                 IlvActivity oldParent,
                                 int oldIndex,
                                 IlvActivity newParent,
                                 int newIndex)

Fires an ActivityMovedEvent.

Parameters:

activity - The activity that has been moved.

oldParent - The previous parent of the activity.

oldIndex - The index of the activity within oldParent before it was moved.

newParent - The new parent of the activity.

newIndex - The index of the activity within newParent after it has been moved.

See Also:

ActivityHierarchyListener.activityMoved(ilog.views.gantt.event.ActivityMovedEvent)

addActivityListener

public void addActivityListener(ActivityListener aListener)

Adds the specified listener to receive activity events from this data model.

Specified by:

addActivityListener in interface IlvGanttModel

Parameters:

aListener - The listener that will be subscribed to subsequent ActivityListener events.

See Also:

removeActivityListener(ilog.views.gantt.event.ActivityListener)

removeActivityListener

public void removeActivityListener(ActivityListener aListener)

Removes the specified listener so that it no longer receives activity events from this data model.

Specified by:

removeActivityListener in interface IlvGanttModel

Parameters:

aListener - The listener that will be unsubscribed from receiving ActivityListener events.

See Also:

addActivityListener(ilog.views.gantt.event.ActivityListener)

getActivityListeners

protected Iterator<ActivityListener> getActivityListeners()

Returns an iterator over the data model's activity event listeners.

Returns:

An iterator over the data model's activity event listeners.

See Also:

addActivityListener(ilog.views.gantt.event.ActivityListener), removeActivityListener(ilog.views.gantt.event.ActivityListener)

fireActivityEvent

public void fireActivityEvent(ActivityEvent event)

Fires an activityChanged event.

Warning: This method is considered to be part of an IlvGanttModel internal implementation rather than of the public API. Do not invoke this method directly unless you have created an IlvActivity implementation that does not subclass IlvAbstractActivity.

Specified by:

fireActivityEvent in interface IlvGanttModel

Parameters:

event - The activity event.

See Also:

ActivityListener.activityChanged(ilog.views.gantt.event.ActivityEvent)

addResource

public void addResource(IlvResource newResource,
                        IlvResource parent)

Appends newResource as the last child of the parent resource. After the resource has been added, the data model will fire a ResourcesInsertedEvent.

Specified by:

addResource in interface IlvGanttModel

Parameters:

newResource - The resource to add.

parent - The parent resource to which newResource is added. The implementation of this method uses IlvGanttModelUtil.checkValidMemberResource(ilog.views.gantt.IlvResource, ilog.views.gantt.IlvGanttModel) to validate parent.

Throws:

IllegalArgumentException - if newResource is null or parent is not a member of this data model.

See Also:

ResourceHierarchyListener.resourcesInserted(ilog.views.gantt.event.ResourcesInsertedEvent)

childResourceIterator

public Iterator<IlvResource> childResourceIterator(IlvResource parent)

Returns an iterator over the parent resource's children.

This implementation of childResourceIterator is based on the methods IlvGanttModel.getChildResourceCount(IlvResource) and IlvGanttModel.getChildResource(IlvResource, int).

Specified by:

childResourceIterator in interface IlvGanttModel

Parameters:

parent - The parent resource.

Returns:

An iterator over the children of parent.

resourcePreorderIterator

public Iterator<IlvResource> resourcePreorderIterator(IlvResource parent)

Returns an iterator that will traverse the parent resource and all of its descendants in preorder. The first resource returned by the iterator's next() method will be parent.

This implementation of resourcePreorderIterator is based on the method childResourceIterator(IlvResource).

Specified by:

resourcePreorderIterator in interface IlvGanttModel

Parameters:

parent - The parent of the resource subtree.

Returns:

An iterator for traversing the subtree of resources in preorder.

See Also:

resourcePreorderIterator(), IlvGanttModelUtil.resourcePreorderIterator(ilog.views.gantt.IlvGanttModel)

resourcePreorderIterator

public Iterator<IlvResource> resourcePreorderIterator()

Returns an iterator that traverses all resources in preorder. The first resource returned by the next() method of the iterator is the root resource of the model.

This implementation of resourcePreorderIterator is based on the method childResourceIterator(IlvResource).

Returns:

An iterator for traversing the hierarchy of resources in preorder.

Since:

JViews 6.0

See Also:

resourcePreorderIterator(IlvResource), IlvGanttModelUtil.resourcePreorderIterator(ilog.views.gantt.IlvGanttModel)

addResourceHierarchyListener

public void addResourceHierarchyListener(ResourceHierarchyListener aListener)

Adds the specified listener to receive resource hierarchy events from this data model.

Specified by:

addResourceHierarchyListener in interface IlvGanttModel

Parameters:

aListener - The listener that will be subscribed to subsequent ResourceHierarchyListener events.

See Also:

removeResourceHierarchyListener(ilog.views.gantt.event.ResourceHierarchyListener)

removeResourceHierarchyListener

public void removeResourceHierarchyListener(ResourceHierarchyListener aListener)

Removes the specified listener so that it no longer receives resource hierarchy events from this data model.

Specified by:

removeResourceHierarchyListener in interface IlvGanttModel

Parameters:

aListener - The listener that will be unsubscribed from receiving ResourceHierarchyListener events.

See Also:

addResourceHierarchyListener(ilog.views.gantt.event.ResourceHierarchyListener)

getResourceHierarchyListeners

protected Iterator<ResourceHierarchyListener> getResourceHierarchyListeners()

Returns an iterator over the data model's resource hierarchy event listeners.

Returns:

An iterator over the data model's resource hierarchy event listeners.

See Also:

addResourceHierarchyListener(ilog.views.gantt.event.ResourceHierarchyListener), removeResourceHierarchyListener(ilog.views.gantt.event.ResourceHierarchyListener)

fireResourcesInserted

protected void fireResourcesInserted(IlvResource parent,
                                     int[] childIndices)

Fires a ResourcesInsertedEvent. Note: This method cannot be used to notify listeners when the root resource has been added.

Parameters:

parent - The parent resource to which child resources have been added.

childIndices - An int array that specifies the index values of the inserted resources. The indices represent the final state of the resource tree, after the new child resources have been added. The indices do not have to be pre-sorted.

See Also:

ResourceHierarchyListener.resourcesInserted(ilog.views.gantt.event.ResourcesInsertedEvent)

fireResourcesInserted

protected void fireResourcesInserted(IlvResource parent,
                                     List<IlvResource> children)

Fires a ResourcesInsertedEvent.

Parameters:

parent - The parent resource to which child resources have been added. If the reported insertion is that of the root resource, parent should be null and children should be a single-element list containing the root resource.

children - The list of child resources that have been inserted. The resources do not have to be pre-sorted.

See Also:

ResourceHierarchyListener.resourcesInserted(ilog.views.gantt.event.ResourcesInsertedEvent)

fireResourceInserted

protected void fireResourceInserted(IlvResource parent,
                                    IlvResource child)

Fires a ResourcesInsertedEvent.

Parameters:

parent - The parent resource to which child resources have been added. If the reported insertion is that of the root resource, parent should be null and child should be the root resource.

child - The child resource that has been inserted.

Since:

JViews 7.5

See Also:

ResourceHierarchyListener.resourcesInserted(ilog.views.gantt.event.ResourcesInsertedEvent)

fireResourcesRemoved

protected void fireResourcesRemoved(IlvResource parent,
                                    List<IlvResource> children,
                                    int[] childIndices)

Fires a ResourcesRemovedEvent.

Parameters:

parent - The parent resource from which child resources have been removed. If the reported deletion is that of the root resource, parent should be null, children should be a single-element list containing the root resource, and childIndices should be a single-element array with childIndices[0]=0.

children - The list of child resources that have been removed. The resources do not have to be pre-sorted, but must be arranged parallel to childIndices. In other words, childIndices[i] must contain the index that resource (IlvResource)children.get(i) had before it was removed.

childIndices - An int array that specifies the index values that the child resources had before they were removed. The indices do not have to be pre-sorted, but must be arranged parallel to children.

See Also:

ResourceHierarchyListener.resourcesRemoved(ilog.views.gantt.event.ResourcesRemovedEvent)

fireResourcesRemoved

protected void fireResourcesRemoved(IlvResource parent,
                                    List<IlvResource> children,
                                    List<Integer> childIndices)

Fires a ResourcesRemovedEvent.

Parameters:

parent - The parent resource from which child resources have been removed. If the reported deletion is that of the root resource, parent should be null, children should be a single-element list containing the root resource, and childIndices should be a single-element list containing Integer(0).

children - The list of child resources that have been removed. The resources do not have to be pre-sorted, but must be arranged in parallel with childIndices. In other words, childIndices[i] must contain the index that the resource (IlvResource)children.get(i) had before it was removed.

childIndices - A list of Integers that specifies the index values that the child resources had before they were removed. The indices do not have to be pre-sorted, but must be arranged in parallel with children.

Since:

JViews 7.5

See Also:

ResourceHierarchyListener.resourcesRemoved(ilog.views.gantt.event.ResourcesRemovedEvent)

fireResourceRemoved

protected void fireResourceRemoved(IlvResource parent,
                                   IlvResource child,
                                   int childIndex)

Fires a ResourcesRemovedEvent.

Parameters:

parent - The parent resource from which the child resource has been removed. If the reported deletion is that of the root resource, parent should be null, child should be the root resource, and childIndex should be 0.

child - The child resource that has been removed.

childIndex - The index value that the child resource had before it was removed.

Since:

JViews 7.5

See Also:

ResourceHierarchyListener.resourcesRemoved(ilog.views.gantt.event.ResourcesRemovedEvent)

fireResourceMoved

protected void fireResourceMoved(IlvResource resource,
                                 IlvResource oldParent,
                                 int oldIndex,
                                 IlvResource newParent,
                                 int newIndex)

Fires a ResourceMovedEvent.

Parameters:

resource - The resource that has been moved.

oldParent - The previous parent of the resource.

oldIndex - The index of the resource within oldParent before it was moved.

newParent - The new parent of the resource.

newIndex - The index of the resource within newParent after it has been moved.

See Also:

ResourceHierarchyListener.resourceMoved(ilog.views.gantt.event.ResourceMovedEvent)

addResourceListener

public void addResourceListener(ResourceListener aListener)

Adds the specified listener to receive resource events from this data model.

Specified by:

addResourceListener in interface IlvGanttModel

Parameters:

aListener - The listener that will be subscribed to subsequent ResourceListener events.

See Also:

removeResourceListener(ilog.views.gantt.event.ResourceListener)

removeResourceListener

public void removeResourceListener(ResourceListener aListener)

Removes the specified listener so that it no longer receives resource events from this data model.

Specified by:

removeResourceListener in interface IlvGanttModel

Parameters:

aListener - The listener that will be unsubscribed from receiving ResourceListener events.

See Also:

addResourceListener(ilog.views.gantt.event.ResourceListener)

getResourceListeners

protected Iterator<ResourceListener> getResourceListeners()

Returns an iterator over the data model's resource event listeners.

Returns:

An iterator over the data model's resource event listeners.

See Also:

addResourceListener(ilog.views.gantt.event.ResourceListener), removeResourceListener(ilog.views.gantt.event.ResourceListener)

fireResourceEvent

public void fireResourceEvent(ResourceEvent event)

Fires a resourceChanged event.

Warning: This method is considered to be part of the internal implementation of an IlvGanttModel rather than of the public API. Do not invoke this method directly unless you have created an IlvResource implementation that does not subclass IlvAbstractResource.

Specified by:

fireResourceEvent in interface IlvGanttModel

Parameters:

event - The resource event.

See Also:

ResourceListener.resourceChanged(ilog.views.gantt.event.ResourceEvent)

addConstraintListener

public void addConstraintListener(ConstraintListener aListener)

Adds the specified listener to receive constraint events from this data model.

Specified by:

addConstraintListener in interface IlvGanttModel

Parameters:

aListener - The listener that will be subscribed to subsequent ConstraintListener events.

removeConstraintListener

public void removeConstraintListener(ConstraintListener aListener)

Removes the specified listener so that it no longer receives constraint events from this data model.

Specified by:

removeConstraintListener in interface IlvGanttModel

Parameters:

aListener - The listener that will be unsubscribed from receiving ConstraintListener events.

fireConstraintEvent

public void fireConstraintEvent(ConstraintEvent event)

Fires a constraint event to all subscribed listeners.

Warning: This method is considered to be part of an IlvGanttModel internal implementation rather than of the public API. Do not invoke this method directly unless you have created an IlvConstraint implementation that does not subclass IlvAbstractConstraint.

Specified by:

fireConstraintEvent in interface IlvGanttModel

Parameters:

event - The constraint event.

See Also:

ConstraintListener.constraintChanged(ilog.views.gantt.event.ConstraintEvent)

fireConstraintInserted

protected void fireConstraintInserted(IlvConstraint constraint)

Fires a ConstraintInsertedEvent.

Parameters:

constraint - The constraint that has been inserted.

See Also:

ConstraintInsertedEvent, ConstraintListener.constraintChanged(ilog.views.gantt.event.ConstraintEvent), IlvGanttModel.addConstraint(ilog.views.gantt.IlvConstraint)

fireConstraintRemoved

protected void fireConstraintRemoved(IlvConstraint constraint,
                                     boolean removingActivity)

Fires a ConstraintRemovedEvent.

Parameters:

constraint - The constraint that has been removed.

removingActivity - Indicates whether the constraint was removed as the side effect of removing an activity from the data model. This flag should be set to true when constraints are removed by the IlvGanttModel.setRootActivity(IlvActivity), IlvGanttModel.removeActivity(IlvActivity), or IlvGanttModel.removeActivity(IlvActivity,int) methods. It should be set to false at all other times.

Since:

JViews 5.0

See Also:

ConstraintRemovedEvent, ConstraintListener.constraintChanged(ilog.views.gantt.event.ConstraintEvent), IlvGanttModel.removeConstraint(ilog.views.gantt.IlvConstraint)

fireConstraintRemoved

protected void fireConstraintRemoved(IlvConstraint constraint)

Fires a ConstraintRemovedEvent. The event indicates that the constraint was not removed as a side effect of an activity removal.

Parameters:

constraint - The constraint that has been removed.

See Also:

ConstraintRemovedEvent, ConstraintListener.constraintChanged(ilog.views.gantt.event.ConstraintEvent), IlvGanttModel.removeConstraint(ilog.views.gantt.IlvConstraint)

addReservationListener

public void addReservationListener(ReservationListener aListener)

Adds the specified listener to receive reservation events from this data model.

Specified by:

addReservationListener in interface IlvGanttModel

Parameters:

aListener - The listener that will be subscribed to subsequent ReservationListener events.

removeReservationListener

public void removeReservationListener(ReservationListener aListener)

Removes the specified listener so that it no longer receives reservation events from this data model.

Specified by:

removeReservationListener in interface IlvGanttModel

Parameters:

aListener - The listener that will be unsubscribed from receiving ReservationListener events.

fireReservationEvent

public void fireReservationEvent(ReservationEvent event)

Fires a reservation event to all subscribed listeners.

Warning: This method is considered to be part of an IlvGanttModel internal implementation rather than of a public API. Do not invoke this method directly unless you have created an IlvReservation implementation that does not subclass IlvAbstractReservation.

Specified by:

fireReservationEvent in interface IlvGanttModel

Parameters:

event - The reservation event.

See Also:

ReservationListener.reservationChanged(ilog.views.gantt.event.ReservationEvent)

fireReservationInserted

protected void fireReservationInserted(IlvReservation reservation)

Fires a ReservationInsertedEvent.

Parameters:

reservation - The reservation that has been inserted.

See Also:

ReservationInsertedEvent, ReservationListener.reservationChanged(ilog.views.gantt.event.ReservationEvent), IlvGanttModel.addReservation(ilog.views.gantt.IlvReservation)

fireReservationRemoved

protected void fireReservationRemoved(IlvReservation reservation,
                                      int removingEntity)

Fires a ReservationRemovedEvent.

Parameters:

reservation - The reservation that has been removed.

removingEntity - Indicates whether the reservation was removed as the side effect of removing an activity or resource from the data model. The value should be set to ReservationRemovedEvent.REMOVING_ACTIVITY when reservations are removed by the IlvGanttModel.setRootActivity(IlvActivity), IlvGanttModel.removeActivity(IlvActivity), or IlvGanttModel.removeActivity(IlvActivity,int) methods. The value should be ReservationRemovedEvent.REMOVING_RESOURCE when reservations are removed by the IlvGanttModel.setRootResource(IlvResource), IlvGanttModel.removeResource(IlvResource), or IlvGanttModel.removeResource(IlvResource,int) methods. The value should be ReservationRemovedEvent.REMOVING_NONE at all other times.

Since:

JViews 5.0

See Also:

ReservationRemovedEvent, ReservationListener.reservationChanged(ilog.views.gantt.event.ReservationEvent), IlvGanttModel.removeReservation(ilog.views.gantt.IlvReservation)

fireReservationRemoved

protected void fireReservationRemoved(IlvReservation reservation)

Fires a ReservationRemovedEvent. The event indicates that the reservation was not removed as a side effect of an activity or resource removal.

Parameters:

reservation - The reservation that has been removed.

See Also:

ReservationRemovedEvent, ReservationListener.reservationChanged(ilog.views.gantt.event.ReservationEvent), IlvGanttModel.removeReservation(ilog.views.gantt.IlvReservation)

writeEventListeners

protected void writeEventListeners(ObjectOutputStream stream)
                            throws IOException

Serializes the transient event listeners of this data model to the specified stream. Subclasses should override this, invoke super, and then save their class-specific event listeners:

   protected void writeEventListeners (ObjectOutputStream stream)
        throws IOException {
      super.writeEventListeners(stream);
      anIlvEventListenerCollection.save(stream, "uniqueFooEventKey");
      .. etc ...
      }
 

Throws:

IOException

See Also:

registerEventListener(java.lang.String, java.lang.Object)

registerEventListener

protected boolean registerEventListener(String key,
                                        Object listener)

Registers the specified event listener, which has just been deserialized, with this data model. Subclasses should override this method and immediately invoke super. If super returns false, you should check whether the listener is class-specific and needs to be registered. A typical subclass implementation looks like this:

   protected boolean registerEventListener (String key, Object listener)
        throws IOException {
     if (super.registerEventListener(key, listener))
       return true;
     if ("uniqueFooEventKey".intern() == key) {
       addFooListener((FooListener)listener);
       return true;
     }
     ... etc ...
     return false;
   }
 

Parameters:

key - Key string identifying the event listener. This key has already been interned, so its identity can be tested against another interned string.

listener - The deserialized event listener.

Returns:

true if this data model recognized the event listener and registered it, or false otherwise.

See Also:

writeEventListeners(java.io.ObjectOutputStream)