ilog.views.gantt.model

Class IlvDefaultGanttModel

java.lang.Object

ilog.views.gantt.model.IlvAbstractGanttModel

ilog.views.gantt.model.IlvDefaultGanttModel

All Implemented Interfaces:

IlvGanttModel, Serializable

public class IlvDefaultGanttModel
extends IlvAbstractGanttModel

IlvDefaultGanttModel is a default implementation of the IlvGanttModel interface, suitable for many applications.

An instance of IlvDefaultGanttModel has several parameters that affect its performance in two categories: initial capacity and load factor. The capacity is the number of buckets in each collection of data model entities, and the initial capacity is simply the capacity at the time that the data model is created. The load factor is a measure of how full a collection is allowed to get before its capacity is automatically increased. When the number of entries in a collection exceeds the product of the load factor and the current capacity, the capacity of the collection is roughly doubled. As a general rule, the default load factor (0.75) offers a good trade-off between time and space costs. The expected number of data model entities and the load factor should be taken into account when setting the initial capacities. It is desirable to minimize the number of times that a collection has its capacity increased, as this is an expensive operation time-wise. If the initial capacity of a collection is greater than the maximum number of data model entities divided by the load factor, the collection will never have its capacity increased.

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
IlvDefaultGanttModel() Constructs a new instance of IlvDefaultGanttModel that is empty.
IlvDefaultGanttModel(int initialActivityCapacity, int initialResourceCapacity, int initialConstraintCapacity, int initialReservationCapacity) Constructs a new instance of IlvDefaultGanttModel that is empty.
IlvDefaultGanttModel(int initialActivityCapacity, int initialResourceCapacity, int initialConstraintCapacity, int initialReservationCapacity, float loadFactor) Constructs a new instance of IlvDefaultGanttModel that is empty.

Method Summary

Modifier and Type	Method and Description
void	addActivity(IlvActivity newActivity, IlvActivity parent, int index) Adds newActivity as a child of parent activity at the specified location in its list of child activities.
void	addConstraint(IlvConstraint newConstraint) Adds newConstraint to the data model.
void	addReservation(IlvReservation newReservation) Adds newReservation to the data model.
void	addResource(IlvResource newResource, IlvResource parent, int index) Adds newResource as a child of parent resource at the specified location in its list of child resources.
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.
Iterator<IlvConstraint>	constraintIterator() Returns an iterator over all the constraints in the data model.
Iterator<IlvConstraint>	constraintIteratorFromActivity(IlvActivity fromActivity) Returns an iterator over the constraints in the data model that have the specified activity as their source or from activity.
Iterator<IlvConstraint>	constraintIteratorToActivity(IlvActivity toActivity) Returns an iterator over the constraints in the data model that have the specified activity as their target or to activity.
boolean	contains(IlvConstraint constraint) Returns whether the specified constraint is a member of the data model.
boolean	contains(IlvHierarchyNode activityOrResource) Returns whether the specified activity or resource is a member of the data model.
boolean	contains(IlvReservation reservation) Returns whether the specified reservation is a member of the data model.
void	fireReservationEvent(ReservationEvent event) Fires a reservation event to all subscribed listeners.
IlvActivity	getChildActivity(IlvActivity parent, int index) Returns the child of the specified parent activity at index index.
int	getChildActivityCount(IlvActivity parent) Returns the number of children of the specified parent activity.
int	getChildActivityIndex(IlvActivity parent, IlvActivity child) Returns the index of the specified child in the parent activity's list of children.
IlvResource	getChildResource(IlvResource parent, int index) Returns the child of the specified parent resource at index index.
int	getChildResourceCount(IlvResource parent) Returns the number of children of the specified parent resource.
int	getChildResourceIndex(IlvResource parent, IlvResource child) Returns the index of the specified child in the parent resource's list of children.
IlvActivity	getParentActivity(IlvActivity activity) Returns the parent activity of the specified activity or null if the activity is the root activity of the data model.
int	getParentActivityIndex(IlvActivity activity) Returns the index of the specified activity within its parent activity.
IlvResource	getParentResource(IlvResource resource) Returns the parent resource of the specified resource or null if the resource is the root resource of the data model.
int	getParentResourceIndex(IlvResource resource) Returns the index of the specified resource within its parent resource.
IlvActivity	getRootActivity() Returns the root activity of the data model or null if the data model contains no activities.
IlvResource	getRootResource() Returns the root resource of the data model or null if the data model contains no resources.
void	moveActivity(IlvActivity activity, IlvActivity newParent, int newIndex) Moves the specified activity from its current location in the tree to a new location.
void	moveResource(IlvResource resource, IlvResource newParent, int newIndex) Moves the specified resource from its current location in the tree to a new location.
void	removeActivity(IlvActivity activity) Removes the specified child activity from its parent.
void	removeActivity(IlvActivity parent, int index) Removes the child activity from parent that is at the specified location in its list of child activities.
void	removeConstraint(IlvConstraint constraint) Removes the specified constraint from the data model.
void	removeReservation(IlvReservation reservation) Removes the specified reservation from the data model.
void	removeResource(IlvResource resource) Removes the specified child resource from its parent.
void	removeResource(IlvResource parent, int index) Removes the child resource from parent that is at the specified location in its list of child resources.
Iterator<IlvReservation>	reservationIterator() Returns an iterator over all the reservations in the data model.
Iterator<IlvReservation>	reservationIterator(IlvActivity activity) Returns an iterator over all the reservations in the data model that are associated with the specified activity.
Iterator<IlvReservation>	reservationIterator(IlvResource resource) Returns an iterator over all the reservations in the data model that are associated with the specified resource.
Iterator<IlvReservation>	reservationIterator(IlvResource resource, IlvTimeInterval interval) Returns an iterator over all the reservations in the data model that are associated with the specified resource and where the assigned activity intersects the specified time interval.
void	setRootActivity(IlvActivity root) Sets the root activity of the data model.
void	setRootResource(IlvResource root) Sets the root resource of the data model.

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

activityPreorderIterator, activityPreorderIterator, addActivity, addActivityHierarchyListener, addActivityListener, addConstraintListener, addGanttModelPropertyListener, addReservationListener, addResource, addResourceHierarchyListener, addResourceListener, clear, fireActivitiesInserted, fireActivitiesInserted, fireActivitiesRemoved, fireActivitiesRemoved, fireActivityEvent, fireActivityInserted, fireActivityMoved, fireActivityRemoved, fireConstraintEvent, fireConstraintInserted, fireConstraintRemoved, fireConstraintRemoved, fireGanttModelPropertyEvent, fireReservationInserted, fireReservationRemoved, fireReservationRemoved, fireResourceEvent, fireResourceInserted, fireResourceMoved, fireResourceRemoved, fireResourcesInserted, fireResourcesInserted, fireResourcesRemoved, fireResourcesRemoved, getActivityHierarchyListeners, getActivityListeners, getChild, getChildCount, getChildIndex, getParent, getParentIndex, getResourceHierarchyListeners, getResourceListeners, isAdjusting, isBatching, registerEventListener, removeActivityHierarchyListener, removeActivityListener, removeConstraintListener, removeGanttModelPropertyListener, removeReservationListener, removeResourceHierarchyListener, removeResourceListener, resourcePreorderIterator, resourcePreorderIterator, setAdjusting, setBatching, writeEventListeners

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvDefaultGanttModel

public IlvDefaultGanttModel(int initialActivityCapacity,
                            int initialResourceCapacity,
                            int initialConstraintCapacity,
                            int initialReservationCapacity,
                            float loadFactor)

Constructs a new instance of IlvDefaultGanttModel that is empty. The data model has the specified initial capacities and load factor.

Parameters:

initialActivityCapacity - The initial activity capacity.

initialResourceCapacity - The initial resource capacity.

initialConstraintCapacity - The initial constraint capacity.

initialReservationCapacity - The initial reservation capacity.

loadFactor - The load factor.

Since:

JViews 5.0

IlvDefaultGanttModel

public IlvDefaultGanttModel(int initialActivityCapacity,
                            int initialResourceCapacity,
                            int initialConstraintCapacity,
                            int initialReservationCapacity)

Constructs a new instance of IlvDefaultGanttModel that is empty. The data model has the specified initial capacities and a default load factor of 0.75.

Parameters:

initialActivityCapacity - The initial activity capacity.

initialResourceCapacity - The initial resource capacity.

initialConstraintCapacity - The initial constraint capacity.

initialReservationCapacity - The initial reservation capacity.

Since:

JViews 5.0

IlvDefaultGanttModel

public IlvDefaultGanttModel()

Constructs a new instance of IlvDefaultGanttModel that is empty. The data model has an initial capacity of 101 activities, 101 resources, 101 constraints, and 211 reservations. The data model has a default load factor of 0.75.

Method Detail

contains

public boolean contains(IlvHierarchyNode activityOrResource)

Returns whether the specified activity or resource is a member of the data model.

Parameters:

activityOrResource - The activity or resource.

Returns:

Whether the specified activity or resource is a member of the data model.

getRootActivity

public IlvActivity getRootActivity()

Returns the root activity of the data model or null if the data model contains no activities.

Returns:

The root activity or null.

setRootActivity

public void setRootActivity(IlvActivity root)

Sets the root activity of the data model. This also causes all constraints and reservations to be removed from the data model. The data model will first fire ConstraintRemovedEvents and ReservationRemovedEvents for each removed constraint and reservation. The removingActivity property of these events will be true. Then, if there was a previous root activity, the data model will fire an ActivitiesRemovedEvent for the old root. Finally, if the new root activity is not null, the data model will fire an ActivitiesInsertedEvent for the new root.

Parameters:

root - The new root activity or null if the data model is to contain no activities.

See Also:

ActivityHierarchyListener.activitiesInserted(ilog.views.gantt.event.ActivitiesInsertedEvent), ActivityHierarchyListener.activitiesRemoved(ilog.views.gantt.event.ActivitiesRemovedEvent)

childActivityIterator

public Iterator<IlvActivity> childActivityIterator(IlvActivity parent)

Returns an iterator over the parent activity's children.

Specified by:

childActivityIterator in interface IlvGanttModel

Overrides:

childActivityIterator in class IlvAbstractGanttModel

Parameters:

parent - The parent activity.

Returns:

An iterator over the children of parent.

getParentActivity

public IlvActivity getParentActivity(IlvActivity activity)

Returns the parent activity of the specified activity or null if the activity is the root activity of the data model.

Parameters:

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

Returns:

The parent activity or null.

Throws:

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

getParentActivityIndex

public int getParentActivityIndex(IlvActivity activity)

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

Parameters:

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

Returns:

The index of the activity or -1.

Throws:

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

getChildActivityCount

public int getChildActivityCount(IlvActivity parent)

Returns the number of children of the specified parent activity.

Parameters:

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

Returns:

The number of child activities.

Throws:

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

getChildActivity

public IlvActivity getChildActivity(IlvActivity parent,
                                    int index)

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

Parameters:

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

index - The child index.

Returns:

The child activity 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 >= getChildActivityCount(parent)).

getChildActivityIndex

public int getChildActivityIndex(IlvActivity parent,
                                 IlvActivity child)

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

Parameters:

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

child - The child activity to find the index of.

Returns:

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

Throws:

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

Since:

JViews 5.5

addActivity

public void addActivity(IlvActivity newActivity,
                        IlvActivity parent,
                        int index)

Adds newActivity as a child of parent activity at the specified location in its list of child activities. The current child activity at index index and any subsequent activities are shifted to the right by having their indices incremented. After the activity has been added, the data model will fire an ActivitiesInsertedEvent.

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.

index - The location within the parent activity's list of children to insert the new activity. If index >= getChildActivityCount(parent) then newActivity is appended as the last child of parent.

Throws:

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

IndexOutOfBoundsException - if index is out of range (index < 0).

See Also:

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

removeActivity

public void removeActivity(IlvActivity parent,
                           int index)

Removes the child activity from parent that is at the specified location in its list of child activities. Any subsequent child activities are shifted to the left by having their indices decremented. All constraints and reservations associated with the child activity and its children are also removed from the data model. After the activity has been removed, the data model will first fire ConstraintRemovedEvents and ReservationRemovedEvents for each removed constraint and reservation. The removingActivity property of these events will be true. Then, the data model will fire an ActivitiesRemovedEvent.

Parameters:

parent - The parent activity from which to remove the child activity. The implementation of this method uses IlvGanttModelUtil.checkValidMemberActivity(ilog.views.gantt.IlvActivity, ilog.views.gantt.IlvGanttModel) to validate parent.

index - The location within parent's list of children to remove the child activity.

Throws:

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

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

See Also:

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

removeActivity

public void removeActivity(IlvActivity activity)

Removes the specified child activity from its parent. All constraints and reservations associated with the activity and its children are also removed from the data model. After the activity has been removed, the data model will first fire ConstraintRemovedEvents and ReservationRemovedEvents for each removed constraint and reservation. The removingActivity property of these events will be true. Then, the data model will fire an ActivitiesRemovedEvent. This method cannot be used to remove the data model's root activity. Use setRootActivity(null) for that purpose.

Parameters:

activity - The activity to remove. It must be a member of this data model, but cannot be the root activity. The implementation of this method uses IlvGanttModelUtil.checkValidNonRootMemberActivity(ilog.views.gantt.IlvActivity, ilog.views.gantt.IlvGanttModel) to validate activity before removing it.

Throws:

IllegalArgumentException - if activity is null, is not a member of this data model, or is the root activity.

See Also:

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

moveActivity

public void moveActivity(IlvActivity activity,
                         IlvActivity newParent,
                         int newIndex)

Moves the specified activity from its current location in the tree to a new location. After the activity has been moved, the data model will fire an ActivityMovedEvent.

Parameters:

activity - The activity to move. It must be a member of this data model, but cannot be the root activity. The implementation of this method uses IlvGanttModelUtil.checkValidNonRootMemberActivity(ilog.views.gantt.IlvActivity, ilog.views.gantt.IlvGanttModel) to validate activity.

newParent - The parent activity to which activity will be made a child. It must be a member of this data model. The implementation of this method uses IlvGanttModelUtil.checkValidMemberActivity(ilog.views.gantt.IlvActivity, ilog.views.gantt.IlvGanttModel) to validate newParent.

newIndex - The location within newParent's list of children that activity will be inserted. If newIndex >= getChildActivityCount(newParent) then activity will be appended as the last child of newParent.

Throws:

IllegalArgumentException - if activity is null, is not a member of this data model, or is the root activity. Also, if newParent is not a member of this data model.

IndexOutOfBoundsException - if newIndex is out of range (newIndex < 0).

See Also:

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

getRootResource

public IlvResource getRootResource()

Returns the root resource of the data model or null if the data model contains no resources.

Returns:

The root resource or null.

setRootResource

public void setRootResource(IlvResource root)

Sets the root resource of the data model. This also causes all reservations to be removed from the data model. The data model will first fire ReservationRemovedEvents for each removed reservation. The removingResource property of these events will be true. Then, if there was a previous root resource, the data model will fire a ResourcesRemovedEvent for the old root. Finally, if the new root resource is not null, the data model will fire a ResourcesInsertedEvent for the new root.

Parameters:

root - The new root resource or null if the data model is to contain no resources.

See Also:

ResourceHierarchyListener.resourcesInserted(ilog.views.gantt.event.ResourcesInsertedEvent), ResourceHierarchyListener.resourcesRemoved(ilog.views.gantt.event.ResourcesRemovedEvent)

childResourceIterator

public Iterator<IlvResource> childResourceIterator(IlvResource parent)

Returns an iterator over the parent resource's children.

Specified by:

childResourceIterator in interface IlvGanttModel

Overrides:

childResourceIterator in class IlvAbstractGanttModel

Parameters:

parent - The parent resource.

Returns:

An iterator over the children of parent.

getParentResource

public IlvResource getParentResource(IlvResource resource)

Returns the parent resource of the specified resource or null if the resource is the root resource of the data model.

Parameters:

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

Returns:

The parent resource or null.

Throws:

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

getParentResourceIndex

public int getParentResourceIndex(IlvResource resource)

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

Parameters:

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

Returns:

The index of the resource or -1.

Throws:

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

getChildResourceCount

public int getChildResourceCount(IlvResource parent)

Returns the number of children of the specified parent resource.

Parameters:

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

Returns:

The number of child activities.

Throws:

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

getChildResource

public IlvResource getChildResource(IlvResource parent,
                                    int index)

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

Parameters:

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

index - The child index.

Returns:

The child resource 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 >= getChildResourceCount(parent)).

getChildResourceIndex

public int getChildResourceIndex(IlvResource parent,
                                 IlvResource child)

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

Parameters:

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

child - The child resource to find the index of.

Returns:

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

Throws:

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

Since:

JViews 5.5

addResource

public void addResource(IlvResource newResource,
                        IlvResource parent,
                        int index)

Adds newResource as a child of parent resource at the specified location in its list of child resources. The current child resource at index index and any subsequent resources are shifted to the right by having their indices incremented. After the resource has been added, the data model will fire a ResourcesInsertedEvent.

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.

index - The location within the parent resource's list of children to insert the new resource. If index >= parent.getChildCount() then newResource is appended as the last child of parent.

Throws:

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

IndexOutOfBoundsException - if index is out of range (index < 0).

See Also:

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

removeResource

public void removeResource(IlvResource parent,
                           int index)

Removes the child resource from parent that is at the specified location in its list of child resources. Any subsequent child resources are shifted to the left by having their indices decremented. All reservations associated with the child resource and its children are also removed from the data model. After the resource has been removed, the data model will first fire ReservationRemovedEvents for each removed reservation. The removingResource property of these events will be true. Then, the data model will fire a ResourcesRemovedEvent.

Parameters:

parent - The parent resource from which to remove the child resource. The implementation of this method uses IlvGanttModelUtil.checkValidMemberResource(ilog.views.gantt.IlvResource, ilog.views.gantt.IlvGanttModel) to validate parent.

index - The location within parent's list of children to remove the child resource.

Throws:

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

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

See Also:

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

removeResource

public void removeResource(IlvResource resource)

Removes the specified child resource from its parent. All reservations associated with the resource and its children are also removed from the data model. After the resource has been removed, the data model will first fire ReservationRemovedEvents for each removed reservation. The removingResource property of these events will be true. Then, the data model will fire a ResourcesRemovedEvent. This method cannot be used to remove the data model's root resource. Use setRootResource(null) for that purpose.

Parameters:

resource - The resource to remove. It must be a member of this data model, but cannot be the root resource. The implementation of this method uses IlvGanttModelUtil.checkValidNonRootMemberResource(ilog.views.gantt.IlvResource, ilog.views.gantt.IlvGanttModel) to validate resource before removing it.

Throws:

IllegalArgumentException - if resource is null, is not a member of this data model, or is the root resource.

See Also:

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

moveResource

public void moveResource(IlvResource resource,
                         IlvResource newParent,
                         int newIndex)

Moves the specified resource from its current location in the tree to a new location. After the resource has been moved, the data model will fire a ResourceMovedEvent.

Parameters:

resource - The resource to move. It must be a member of this data model, but cannot be the root resource. The implementation of this method uses IlvGanttModelUtil.checkValidNonRootMemberResource(ilog.views.gantt.IlvResource, ilog.views.gantt.IlvGanttModel) to validate resource.

newParent - The parent resource to which resource will be made a child. It must be a member of this data model. The implementation of this method uses IlvGanttModelUtil.checkValidMemberResource(ilog.views.gantt.IlvResource, ilog.views.gantt.IlvGanttModel) to validate newParent.

newIndex - The location within newParent's list of children that resource will be inserted. If newIndex >= getChildResourceCount(newParent) then resource will be appended as the last child of newParent.

Throws:

IllegalArgumentException - if resource is null, is not a member of this data model, or is the root resource. Also, if newParent is not a member of this data model.

IndexOutOfBoundsException - if newIndex is out of range (newIndex < 0).

See Also:

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

contains

public boolean contains(IlvConstraint constraint)

Returns whether the specified constraint is a member of the data model.

Parameters:

constraint - The constraint.

Returns:

Whether the specified constraint is a member of the data model.

constraintIterator

public Iterator<IlvConstraint> constraintIterator()

Returns an iterator over all the constraints in the data model. The iterator will actually be over a copy of the constraints, making it safe to add or remove constraints during the course of the iteration.

Returns:

An iterator over all constraints in the data model, in no particular order.

constraintIteratorFromActivity

public Iterator<IlvConstraint> constraintIteratorFromActivity(IlvActivity fromActivity)

Returns an iterator over the constraints in the data model that have the specified activity as their source or from activity. The iterator will actually be over a copy of the constraints, making it safe to add or remove constraints during the course of the iteration.

Parameters:

fromActivity - The from activity.

Returns:

An iterator over all the constraints in the data model that have the specified activity as their from activity, in no particular order.

constraintIteratorToActivity

public Iterator<IlvConstraint> constraintIteratorToActivity(IlvActivity toActivity)

Returns an iterator over the constraints in the data model that have the specified activity as their target or to activity. The iterator will actually be over a copy of the constraints, making it safe to add or remove constraints during the course of the iteration.

Parameters:

toActivity - The to activity.

Returns:

An iterator over all the constraints in the data model that have the specified activity as their to activity, in no particular order.

addConstraint

public void addConstraint(IlvConstraint newConstraint)

Adds newConstraint to the data model. The constraint's from and to activities must already be members of this data model. After the constraint has been added, the data model will fire a ConstraintInsertedEvent.

Parameters:

newConstraint - The constraint to add. The implementation of this method uses IlvGanttModelUtil.checkValidNewConstraint(ilog.views.gantt.IlvConstraint, ilog.views.gantt.IlvGanttModel) to validate newConstraint.

Throws:

IllegalArgumentException - if newConstraint is null, is a member of a data model already, or its constrained activities are not members of this data model.

See Also:

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

removeConstraint

public void removeConstraint(IlvConstraint constraint)

Removes the specified constraint from the data model. After the constraint has been removed, the data model will fire a ConstraintRemovedEvent.

Parameters:

constraint - The constraint to remove. The implementation of this method uses IlvGanttModelUtil.checkValidMemberConstraint(ilog.views.gantt.IlvConstraint, ilog.views.gantt.IlvGanttModel) to validate constraint before removing it.

Throws:

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

See Also:

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

contains

public boolean contains(IlvReservation reservation)

Returns whether the specified reservation is a member of the data model.

Parameters:

reservation - The reservation.

Returns:

Whether the specified reservation is a member of the data model.

reservationIterator

public Iterator<IlvReservation> reservationIterator()

Returns an iterator over all the reservations in the data model. The iterator will actually be over a copy of the reservations, making it safe to add or remove reservations during the course of the iteration.

Returns:

An iterator over all reservations in the data model, in no particular order.

reservationIterator

public Iterator<IlvReservation> reservationIterator(IlvActivity activity)

Returns an iterator over all the reservations in the data model that are associated with the specified activity. The iterator will actually be over a copy of the reservations, making it safe to add or remove reservations during the course of the iteration.

Parameters:

activity - The activity.

Returns:

An iterator over all the reservations in the data model that are associated with the specified activity, in no particular order.

reservationIterator

public Iterator<IlvReservation> reservationIterator(IlvResource resource)

Returns an iterator over all the reservations in the data model that are associated with the specified resource. The iterator will actually be over a copy of the reservations, making it safe to add or remove reservations during the course of the iteration.

Parameters:

resource - The resource.

Returns:

An iterator over all the reservations in the data model that are associated with the specified resource, in no particular order.

reservationIterator

public Iterator<IlvReservation> reservationIterator(IlvResource resource,
                                                    IlvTimeInterval interval)

Returns an iterator over all the reservations in the data model that are associated with the specified resource and where the assigned activity intersects the specified time interval. The iterator will actually be over a copy of the reservations, making it safe to add or remove reservations during the course of the iteration. This method defines whether an activity intersects interval by evaluating anActivity.getTimeInterval().overlaps(interval).

Parameters:

resource - The resource.

interval - The activity time interval of interest.

Returns:

An iterator over all the reservations in the data model that are associated with the specified resource and where the assigned activity intersects the specified time interval, in no particular order.

See Also:

IlvActivity.getTimeInterval()

addReservation

public void addReservation(IlvReservation newReservation)

Adds newReservation to the data model. The reservation's resource and activity must already be members of this data model. After the reservation has been added, the data model will fire a ReservationInsertedEvent.

Parameters:

newReservation - The reservation to add. The implementation of this method uses IlvGanttModelUtil.checkValidNewReservation(ilog.views.gantt.IlvReservation, ilog.views.gantt.IlvGanttModel) to validate newReservation.

Throws:

IllegalArgumentException - if newReservation is null, is a member of a data model already, its resource is is not a member of this data model, or its activity is not a member of this data model.

See Also:

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

removeReservation

public void removeReservation(IlvReservation reservation)

Removes the specified reservation from the data model. After the reservation has been removed, the data model will fire a ReservationRemovedEvent.

Parameters:

reservation - The reservation to remove. The implementation of this method uses IlvGanttModelUtil.checkValidMemberReservation(ilog.views.gantt.IlvReservation, ilog.views.gantt.IlvGanttModel) to validate reservation before removing it.

Throws:

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

See Also:

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

fireReservationEvent

public void fireReservationEvent(ReservationEvent event)

Fires a reservation event to all subscribed listeners. This method overrides IlvAbstractGanttModel so that when a ReservedResourceEvent is fired, the data model will update its internal hashtables with the new activity-to-resource mapping.

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

Specified by:

fireReservationEvent in interface IlvGanttModel

Overrides:

fireReservationEvent in class IlvAbstractGanttModel

Parameters:

event - The reservation event.

See Also:

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