IlvGanttModelUtil (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.gantt.IlvGanttModelUtil

```
public class IlvGanttModelUtil
extends Object
```
IlvGanttModelUtil is a utility class that consists exclusively of static methods that are of general use when dealing with Gantt data models.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Iterator<IlvActivity>`	`activityBreadthFirstIterator(IlvGanttModel model)` Returns an iterator that will traverse all of the activities of a data model in breadth first order.
`static Iterator<IlvActivity>`	`activityBreadthFirstIterator(IlvGanttModel model, IlvActivity parent)` Returns an iterator that will traverse the parent activity and all of its descendants in breadth first order.
`static Iterator<IlvActivity>`	`activityPostorderIterator(IlvGanttModel model)` Returns an iterator that will traverse all of the activities of a data model in postorder.
`static Iterator<IlvActivity>`	`activityPostorderIterator(IlvGanttModel model, IlvActivity parent)` Returns an iterator that will traverse the parent activity and all of its descendants in postorder.
`static Iterator<IlvActivity>`	`activityPreorderIterator(IlvGanttModel model)` Returns an iterator that will traverse all of the activities of a data model in preorder.
`static Iterator`	`breadthFirstIterator(IlvGanttModel model, IlvHierarchyNode parent)` Returns an iterator that will traverse the parent activity or resource and all of its descendants in breadth first order.
`static void`	`checkValidMemberActivity(IlvActivity activity, IlvGanttModel ganttModel)` Checks that the specified activity is not `null` and is a member of the specified data model.
`static void`	`checkValidMemberConstraint(IlvConstraint constraint, IlvGanttModel ganttModel)` Checks that the specified constraint is not `null` and is a member of the specified data model.
`static void`	`checkValidMemberReservation(IlvReservation reservation, IlvGanttModel ganttModel)` Checks that the specified reservation is not `null` and is a member of the specified data model.
`static void`	`checkValidMemberResource(IlvResource resource, IlvGanttModel ganttModel)` Checks that the specified resource is not `null` and is a member of the specified data model.
`static void`	`checkValidNewConstraint(IlvConstraint constraint, IlvGanttModel ganttModel)` Checks that the specified constraint is a valid argument for `ganttModel.addConstraint()`.
`static void`	`checkValidNewReservation(IlvReservation reservation, IlvGanttModel ganttModel)` Checks that the specified reservation is a valid argument for `ganttModel.addReservation()`.
`static void`	`checkValidNonNullActivity(IlvActivity activity)` Checks that the specified activity is not `null`.
`static void`	`checkValidNonNullConstraint(IlvConstraint constraint)` Checks that the specified constraint is not `null`.
`static void`	`checkValidNonNullReservation(IlvReservation reservation)` Checks that the specified reservation is not `null`.
`static void`	`checkValidNonNullResource(IlvResource resource)` Checks that the specified resource is not `null`.
`static void`	`checkValidNonRootMemberActivity(IlvActivity activity, IlvGanttModel ganttModel)` Checks that the specified activity is not `null`, is a member of the specified model, but is not the root activity.
`static void`	`checkValidNonRootMemberResource(IlvResource resource, IlvGanttModel ganttModel)` Checks that the specified resource is not `null`, is a member of the specified data model, but is not the root resource.
`static Iterator`	`childIterator(IlvGanttModel model, IlvHierarchyNode parent)` Returns an iterator over the children of the specified parent activity or resource.
`static void`	`demote(IlvGanttModel model, IlvHierarchyNode activityOrResource)` Demotes the specified activity or resource so that it becomes the child of its immediately previous sibling.
`static int`	`getDepth(IlvGanttModel model, IlvHierarchyNode activityOrResource)` Returns the depth of the specified activity or resource in the hierarchical data tree.
`static IlvHierarchyNode`	`getFirstChild(IlvGanttModel model, IlvHierarchyNode activityOrResource)` Returns the first child of the specified activity or resource.
`static IlvHierarchyNode`	`getLastChild(IlvGanttModel model, IlvHierarchyNode activityOrResource)` Returns the last child of the specified activity or resource.
`static boolean`	`hasChildren(IlvGanttModel model, IlvHierarchyNode activityOrResource)` Returns whether the specified activity or resource has any children.
`static boolean`	`isDescendant(IlvGanttModel model, IlvHierarchyNode parent, IlvHierarchyNode child)` Returns `true` if the specified child activity or resource is a descendant of the specified parent activity or resource in the hierarchical data tree.
`static Iterator`	`postorderIterator(IlvGanttModel model, IlvHierarchyNode parent)` Returns an iterator that will traverse the parent activity or resource and all of its descendants in postorder.
`static Iterator`	`preorderIterator(IlvGanttModel model, IlvHierarchyNode parent)` Returns an iterator that will traverse the parent activity or resource and all of its descendants in preorder.
`static void`	`promote(IlvGanttModel model, IlvHierarchyNode activityOrResource)` Promotes the specified activity or resource so that it becomes a child of its grandparent (that is, a sibling to its current parent).
`static Iterator<IlvResource>`	`resourceBreadthFirstIterator(IlvGanttModel model)` Returns an iterator that will traverse all of the resources of a data model in breadth first order.
`static Iterator<IlvResource>`	`resourceBreadthFirstIterator(IlvGanttModel model, IlvResource parent)` Returns an iterator that will traverse the parent resource and all of its descendants in breadth first order.
`static Iterator<IlvResource>`	`resourcePostorderIterator(IlvGanttModel model)` Returns an iterator that will traverse all of the resources of a data model in postorder.
`static Iterator<IlvResource>`	`resourcePostorderIterator(IlvGanttModel model, IlvResource parent)` Returns an iterator that will traverse the parent resource and all of its descendants in postorder.
`static Iterator<IlvResource>`	`resourcePreorderIterator(IlvGanttModel model)` Returns an iterator that will traverse all of the resources of a data model in preorder.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - hasChildren
```
public static boolean hasChildren(IlvGanttModel model,
                                  IlvHierarchyNode activityOrResource)
```
    Returns whether the specified activity or resource has any children. This is equivalent to the expression model.getChildCount(activityOrResource) > 0.
    
    Parameters:
    
    model - The Gantt data model that contains the activity or resource.
    
    activityOrResource - The activity or resource.
    
    Returns:
    
    Whether the activity or resource has any children.
    
    Since:
    
    JViews 5.5
  - getFirstChild
```
public static IlvHierarchyNode getFirstChild(IlvGanttModel model,
                                             IlvHierarchyNode activityOrResource)
```
    Returns the first child of the specified activity or resource. This is equivalent to calling model.getChild(activityOrResource, 0).
    
    Parameters:
    
    model - The Gantt data model that contains the activity or resource.
    
    activityOrResource - The activity or resource.
    
    Returns:
    
    The first child.
    
    Throws:
    
    IndexOutOfBoundsException - if activityOrResource does not have any children.
    
    Since:
    
    JViews 5.5
  - getLastChild
```
public static IlvHierarchyNode getLastChild(IlvGanttModel model,
                                            IlvHierarchyNode activityOrResource)
```
    Returns the last child of the specified activity or resource. This is equivalent to calling model.getChild(activityOrResource, model.getChildCount(activityOrResource)-1).
    
    Parameters:
    
    model - The Gantt data model that contains the activity or resource.
    
    activityOrResource - The activity or resource.
    
    Returns:
    
    The last child.
    
    Throws:
    
    IndexOutOfBoundsException - if activityOrResource does not have any children.
    
    Since:
    
    JViews 5.5
  - childIterator
```
public static Iterator childIterator(IlvGanttModel model,
                                     IlvHierarchyNode parent)
```
    Returns an iterator over the children of the specified parent activity or resource.
    
    Parameters:
    
    model - The Gantt data model that contains the activity or resource.
    
    parent - The parent activity or resource.
    
    Returns:
    
    An iterator over the children of parent.
    
    Since:
    
    JViews 5.5
  - activityPreorderIterator
```
public static Iterator<IlvActivity> activityPreorderIterator(IlvGanttModel model)
```
    Returns an iterator that will traverse all of the activities of a data model in preorder. The first activity returned by the iterator's next() method will be the model's root activity.
    
    Parameters:
    
    model - The Gantt data model.
    
    Returns:
    
    An iterator for traversing the hierarchy of activities in preorder.
    
    Since:
    
    JViews 6.0
    
    See Also:
    
    IlvGanttModel.activityPreorderIterator(ilog.views.gantt.IlvActivity)
  - resourcePreorderIterator
```
public static Iterator<IlvResource> resourcePreorderIterator(IlvGanttModel model)
```
    Returns an iterator that will traverse all of the resources of a data model in preorder. The first resource returned by the iterator's next() method will be the model's root resource.
    
    Parameters:
    
    model - The Gantt data model.
    
    Returns:
    
    An iterator for traversing the hierarchy of resources in preorder.
    
    Since:
    
    JViews 6.0
    
    See Also:
    
    IlvGanttModel.resourcePreorderIterator(ilog.views.gantt.IlvResource)
  - preorderIterator
```
public static Iterator preorderIterator(IlvGanttModel model,
                                        IlvHierarchyNode parent)
```
    Returns an iterator that will traverse the parent activity or resource and all of its descendants in preorder. The first node returned by the iterator's next() method will be parent.
    
    Parameters:
    
    model - The Gantt data model that contains the activity or resource.
    
    parent - The parent of the subtree.
    
    Returns:
    
    An iterator for traversing the subtree of activities or resources in preorder.
    
    Since:
    
    JViews 5.5
  - activityPostorderIterator
```
public static Iterator<IlvActivity> activityPostorderIterator(IlvGanttModel model,
                                                              IlvActivity parent)
```
    Returns an iterator that will traverse the parent activity and all of its descendants in postorder. Leaves will be traversed before parents and the final activity returned by the iterator's next() method will be parent.
    
    Parameters:
    
    model - The Gantt data model that contains the activity.
    
    parent - The parent of the activity subtree.
    
    Returns:
    
    An iterator for traversing the subtree of activities in postorder.
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    activityPostorderIterator(IlvGanttModel)
  - activityPostorderIterator
```
public static Iterator<IlvActivity> activityPostorderIterator(IlvGanttModel model)
```
    Returns an iterator that will traverse all of the activities of a data model in postorder. Leaves will be traversed before parents and the final activity returned by the iterator's next() method will be the model's root activity.
    
    Parameters:
    
    model - The Gantt data model.
    
    Returns:
    
    An iterator for traversing the hierarchy of activities in postorder.
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    activityPostorderIterator(IlvGanttModel,IlvActivity)
  - resourcePostorderIterator
```
public static Iterator<IlvResource> resourcePostorderIterator(IlvGanttModel model,
                                                              IlvResource parent)
```
    Returns an iterator that will traverse the parent resource and all of its descendants in postorder. Leaves will be traversed before parents and the final resource returned by the iterator's next() method will be parent.
    
    Parameters:
    
    model - The Gantt data model that contains the resource.
    
    parent - The parent of the resource subtree.
    
    Returns:
    
    An iterator for traversing the subtree of resources in postorder.
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    resourcePostorderIterator(IlvGanttModel)
  - resourcePostorderIterator
```
public static Iterator<IlvResource> resourcePostorderIterator(IlvGanttModel model)
```
    Returns an iterator that will traverse all of the resources of a data model in postorder. Leaves will be traversed before parents and the final resource returned by the iterator's next() method will be the model's root resource.
    
    Parameters:
    
    model - The Gantt data model.
    
    Returns:
    
    An iterator for traversing the hierarchy of resources in postorder.
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    resourcePostorderIterator(IlvGanttModel,IlvResource)
  - postorderIterator
```
public static Iterator postorderIterator(IlvGanttModel model,
                                         IlvHierarchyNode parent)
```
    Returns an iterator that will traverse the parent activity or resource and all of its descendants in postorder. Leaves will be traversed before parents and the final node returned by the iterator's next() method will be parent.
    
    Parameters:
    
    model - The Gantt data model that contains the activity or resource.
    
    parent - The parent of the subtree.
    
    Returns:
    
    An iterator for traversing the subtree of activities or resources in postorder.
    
    Since:
    
    JViews 7.5
  - activityBreadthFirstIterator
```
public static Iterator<IlvActivity> activityBreadthFirstIterator(IlvGanttModel model,
                                                                 IlvActivity parent)
```
    Returns an iterator that will traverse the parent activity and all of its descendants in breadth first order. The first activity returned by the next() method of the iterator will be parent.
    
    Parameters:
    
    model - The Gantt data model that contains the activity.
    
    parent - The parent of the activity subtree.
    
    Returns:
    
    An iterator for traversing the subtree of activities in breadth first order.
    
    Since:
    
    JViews 8.5
    
    See Also:
    
    activityBreadthFirstIterator(IlvGanttModel)
  - activityBreadthFirstIterator
```
public static Iterator<IlvActivity> activityBreadthFirstIterator(IlvGanttModel model)
```
    Returns an iterator that will traverse all of the activities of a data model in breadth first order. The first activity returned by the next() method of the iterator will be the root activity of the model.
    
    Parameters:
    
    model - The Gantt data model.
    
    Returns:
    
    An iterator for traversing the hierarchy of activities in breadth first order.
    
    Since:
    
    JViews 8.5
    
    See Also:
    
    activityBreadthFirstIterator(IlvGanttModel, IlvActivity)
  - resourceBreadthFirstIterator
```
public static Iterator<IlvResource> resourceBreadthFirstIterator(IlvGanttModel model,
                                                                 IlvResource parent)
```
    Returns an iterator that will traverse the parent resource and all of its descendants in breadth first order. The first resource returned by the next() method of the iterator will be parent.
    
    Parameters:
    
    model - The Gantt data model that contains the resource.
    
    parent - The parent of the resource subtree.
    
    Returns:
    
    An iterator for traversing the subtree of resources in breadth first order.
    
    Since:
    
    JViews 8.5
    
    See Also:
    
    resourceBreadthFirstIterator(IlvGanttModel)
  - resourceBreadthFirstIterator
```
public static Iterator<IlvResource> resourceBreadthFirstIterator(IlvGanttModel model)
```
    Returns an iterator that will traverse all of the resources of a data model in breadth first order. The first resource returned by the next() method of the iterator will be the root resource of the model.
    
    Parameters:
    
    model - The Gantt data model.
    
    Returns:
    
    An iterator for traversing the hierarchy of resources in breadth first order.
    
    Since:
    
    JViews 8.5
    
    See Also:
    
    resourceBreadthFirstIterator(IlvGanttModel, IlvResource)
  - breadthFirstIterator
```
public static Iterator breadthFirstIterator(IlvGanttModel model,
                                            IlvHierarchyNode parent)
```
    Returns an iterator that will traverse the parent activity or resource and all of its descendants in breadth first order. The first node returned by the next() method of the iterator will be parent.
    
    Parameters:
    
    model - The Gantt data model that contains the activity or resource.
    
    parent - The parent of the subtree.
    
    Returns:
    
    An iterator for traversing the subtree of activities or resources in breadth first order.
    
    Since:
    
    JViews 8.5
  - promote
```
public static void promote(IlvGanttModel model,
                           IlvHierarchyNode activityOrResource)
```
    Promotes the specified activity or resource so that it becomes a child of its grandparent (that is, a sibling to its current parent). Visually, this gives the impression of outdenting the node.
    
    Parameters:
    
    model - The Gantt data model that contains the activity or resource.
    
    activityOrResource - The activity or resource to promote.
    
    Since:
    
    JViews 5.5
  - demote
```
public static void demote(IlvGanttModel model,
                          IlvHierarchyNode activityOrResource)
```
    Demotes the specified activity or resource so that it becomes the child of its immediately previous sibling. Visually, this gives the impression of indenting the node.
    
    Parameters:
    
    model - The Gantt data model that contains the activity or resource.
    
    activityOrResource - The activity or resource to demote.
    
    Since:
    
    JViews 5.5
  - getDepth
```
public static int getDepth(IlvGanttModel model,
                           IlvHierarchyNode activityOrResource)
```
    Returns the depth of the specified activity or resource in the hierarchical data tree. The root of the tree has a depth of 0.
    
    Parameters:
    
    model - The Gantt data model that contains the activity or resource.
    
    activityOrResource - The activity or resource.
    
    Returns:
    
    The hierarchical depth of the activity or resource.
    
    Since:
    
    JViews 5.5
  - isDescendant
```
public static boolean isDescendant(IlvGanttModel model,
                                   IlvHierarchyNode parent,
                                   IlvHierarchyNode child)
```
    Returns true if the specified child activity or resource is a descendant of the specified parent activity or resource in the hierarchical data tree.
    
    Parameters:
    
    model - The Gantt data model that contains both parent and child.
    
    parent - The parent activity or resource to test.
    
    child - The child activity or resource to test.
    
    Returns:
    
    true if child is a descendant of parent, and false otherwise.
    
    Since:
    
    JViews 5.5
  - checkValidNonNullActivity
```
public static void checkValidNonNullActivity(IlvActivity activity)
```
    Checks that the specified activity is not null. If it is, an IllegalArgumentException is thrown.
    
    Parameters:
    
    activity - The activity to check.
    
    Throws:
    
    IllegalArgumentException - if activity is null.
  - checkValidMemberActivity
```
public static void checkValidMemberActivity(IlvActivity activity,
                                            IlvGanttModel ganttModel)
```
    Checks that the specified activity is not null and is a member of the specified data model. If it is not, an IllegalArgumentException is thrown.
    This method can be used to validate the parent argument for the IlvGanttModel.removeActivity(IlvActivity, int) and IlvGanttModel.addActivity(IlvActivity, IlvActivity, int) methods and the newParent argument for the IlvGanttModel.moveActivity(IlvActivity, IlvActivity, int) method.
    
    Parameters:
    
    activity - The activity to check.
    
    ganttModel - The Gantt data model.
    
    Throws:
    
    IllegalArgumentException - if activity is null or is not a member of ganttModel.
  - checkValidNonRootMemberActivity
```
public static void checkValidNonRootMemberActivity(IlvActivity activity,
                                                   IlvGanttModel ganttModel)
```
    Checks that the specified activity is not null, is a member of the specified model, but is not the root activity. If it is not, an IllegalArgumentException is thrown.
    This method can be used to validate the activity argument for the IlvGanttModel.removeActivity(IlvActivity) and IlvGanttModel.moveActivity(IlvActivity, IlvActivity, int) methods.
    
    Parameters:
    
    activity - The activity to check.
    
    ganttModel - The Gantt data model.
    
    Throws:
    
    IllegalArgumentException - if activity is null, is not a member of ganttModel, or is the ganttModel's root activity.
  - checkValidNonNullResource
```
public static void checkValidNonNullResource(IlvResource resource)
```
    Checks that the specified resource is not null. If it is, an IllegalArgumentException is thrown.
    
    Parameters:
    
    resource - The resource to check.
    
    Throws:
    
    IllegalArgumentException - if resource is null.
  - checkValidMemberResource
```
public static void checkValidMemberResource(IlvResource resource,
                                            IlvGanttModel ganttModel)
```
    Checks that the specified resource is not null and is a member of the specified data model. If it is not, an IllegalArgumentException is thrown.
    This method can be used to validate the parent argument for the IlvGanttModel.removeResource(IlvResource, int) and IlvGanttModel.addResource(IlvResource, IlvResource, int) methods and the newParent argument for the IlvGanttModel.moveResource(IlvResource, IlvResource, int) method.
    
    Parameters:
    
    resource - The resource to check.
    
    ganttModel - The Gantt data model.
    
    Throws:
    
    IllegalArgumentException - if resource is null or is not a member of ganttModel.
  - checkValidNonRootMemberResource
```
public static void checkValidNonRootMemberResource(IlvResource resource,
                                                   IlvGanttModel ganttModel)
```
    Checks that the specified resource is not null, is a member of the specified data model, but is not the root resource. If it is not, an IllegalArgumentException is thrown.
    This method can be used to validate the resource argument for the IlvGanttModel.removeResource(IlvResource) and IlvGanttModel.moveResource(IlvResource, IlvResource, int) methods.
    
    Parameters:
    
    resource - The resource to check.
    
    ganttModel - The Gantt data model.
    
    Throws:
    
    IllegalArgumentException - if resource is null, is not a member of ganttModel, or is the ganttModel's root resource.
  - checkValidNonNullConstraint
```
public static void checkValidNonNullConstraint(IlvConstraint constraint)
```
    Checks that the specified constraint is not null. If it is, an IllegalArgumentException is thrown.
    
    Parameters:
    
    constraint - The constraint to check.
    
    Throws:
    
    IllegalArgumentException - if constraint is null.
  - checkValidMemberConstraint
```
public static void checkValidMemberConstraint(IlvConstraint constraint,
                                              IlvGanttModel ganttModel)
```
    Checks that the specified constraint is not null and is a member of the specified data model. If it is not, an IllegalArgumentException is thrown.
    
    Parameters:
    
    constraint - The constraint to check.
    
    ganttModel - The Gantt data model.
    
    Throws:
    
    IllegalArgumentException - if constraint is null or is not a member of ganttModel.
  - checkValidNewConstraint
```
public static void checkValidNewConstraint(IlvConstraint constraint,
                                           IlvGanttModel ganttModel)
```
    Checks that the specified constraint is a valid argument for ganttModel.addConstraint(). If it is not, an IllegalArgumentException is thrown.
    
    Parameters:
    
    constraint - The constraint to check.
    
    ganttModel - The Gantt data model.
    
    Throws:
    
    IllegalArgumentException - if constraint is null, is a member of a data model, or either of its constrained activities are not members of ganttModel.
  - checkValidNonNullReservation
```
public static void checkValidNonNullReservation(IlvReservation reservation)
```
    Checks that the specified reservation is not null. If it is, an IllegalArgumentException is thrown.
    
    Parameters:
    
    reservation - The reservation to check.
    
    Throws:
    
    IllegalArgumentException - if reservation is null.
  - checkValidMemberReservation
```
public static void checkValidMemberReservation(IlvReservation reservation,
                                               IlvGanttModel ganttModel)
```
    Checks that the specified reservation is not null and is a member of the specified data model. If it is not, an IllegalArgumentException is thrown.
    
    Parameters:
    
    reservation - The reservation to check.
    
    ganttModel - The Gantt data model.
    
    Throws:
    
    IllegalArgumentException - if reservation is null or is not a member of ganttModel.
  - checkValidNewReservation
```
public static void checkValidNewReservation(IlvReservation reservation,
                                            IlvGanttModel ganttModel)
```
    Checks that the specified reservation is a valid argument for ganttModel.addReservation(). If it is not, an IllegalArgumentException is thrown.
    
    Parameters:
    
    reservation - The reservation to check.
    
    ganttModel - The Gantt data model.
    
    Throws:
    
    IllegalArgumentException - if reservation is null, is a member of a data model, its associated resource is not a member of ganttModel, or its associated activity is not a member of ganttModel.

Class IlvGanttModelUtil

Method Summary

Methods inherited from class java.lang.Object

Method Detail

hasChildren

getFirstChild

getLastChild

childIterator

activityPreorderIterator

resourcePreorderIterator

preorderIterator

activityPostorderIterator

activityPostorderIterator

resourcePostorderIterator

resourcePostorderIterator

postorderIterator

activityBreadthFirstIterator

activityBreadthFirstIterator

resourceBreadthFirstIterator

resourceBreadthFirstIterator

breadthFirstIterator

promote

demote

getDepth

isDescendant

checkValidNonNullActivity

checkValidMemberActivity

checkValidNonRootMemberActivity

checkValidNonNullResource

checkValidMemberResource

checkValidNonRootMemberResource

checkValidNonNullConstraint

checkValidMemberConstraint

checkValidNewConstraint

checkValidNonNullReservation

checkValidMemberReservation

checkValidNewReservation