com.ibm.tivoli.maximo.skd.applet.util

Class Activities

java.lang.Object

com.ibm.tivoli.maximo.skd.applet.util.Activities

public class Activities
extends java.lang.Object

Utility methods for dealing with Activities (ie, WorkOrders, Assignments, etc)

Author:

sls

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Activities.CountingVisitor Simple counting visitor
static class	Activities.FilterActivityVisitor Activities.IlvActivityVisitor that builds a list of Filtered activities based on the Activities.IFilter instance
static class	Activities.FilterNodeVisitor Activities.IlvActivityVisitor that builds a list of Filtered activities based on the Activities.IFilter instance
static class	Activities.FindByIDActivityVisitor Visitor that will find an Activity by ID
static interface	Activities.HasCancelled A "state" object can implement this if they want to "cancel" out of visitor operation
static interface	Activities.IFilter<T> Generic Filter class for any type
static interface	Activities.IlvActivityVisitor<T> Simple visitor pattern for activities.
static interface	Activities.IlvHierarchyNodeVisitor<NodeType extends ilog.views.gantt.IlvHierarchyNode,ChartType extends ilog.views.gantt.IlvHierarchyChart,StateType> Generic IlvHierarchyNode visitor for visiting any subclass of IlvHierarchyNode
static interface	Activities.IlvNodeVisitor<T> Generic Node Visitor that can visit nodes in an IlvHierarchyChart
static interface	Activities.IlvResourceVisitor<T> Specific implementation of an Activities.IlvHierarchyNodeVisitor for IlvResource type objects.
static class	Activities.SameTypeVisitor Special visitor where isValid() will return true if each object that is visited has the same type as any objectname in the list
static class	Activities.ShowMoveToMenuVisitor Special Visitor where isValid() will return true IF ALL that nodes being visited can support the MoveTo menu.

Field Summary

Fields

Modifier and Type	Field and Description
static Activities.IlvNodeVisitor<java.lang.Void>	COLLAPSE_ALL_ROWS_VISITOR Collapse all rows visitor
static java.lang.String	PROPERTY_READ_ONLY_MODEL Property on the ROOT activity to indicate that the model is readonly
static Activities.IlvActivityVisitor<java.lang.Void>	SELECT_ALL_ROWS_ACTIVITY_VISITOR Simple Activities.IlvActivityVisitor that selects every row that is passed
static java.lang.String	WO_INTERNAL_STATUS_APPR Internal Status for Approved WorkOrder "APPR"
static java.util.List<java.lang.String>	WORKORDER_OBJECTNAMES Global List of WORKORDER type object names

Constructor Summary

Constructors

Constructor and Description
Activities()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addCrafts(java.util.HashSet crafts, ilog.views.gantt.IlvActivity item, ilog.views.gantt.IlvGanttChart ganttChart) For a given Activity on the chart, add its crafts to the set of passed in crafts.
static void	adjustChartForPadding(ilog.views.gantt.IlvHierarchyChart gchart, java.util.Date start, ilog.views.gantt.IlvDuration duration) Utility method for adding padding to a visible duration
static void	applyVisibleTime(ilog.views.gantt.IlvTimeScrollController timeScroller, ilog.views.gantt.IlvHierarchyChart chart) Applies the TimeScroller visible area to the Chart, and forces a sync
static void	copyProperties(ilog.views.gantt.IlvActivity src, ilog.views.gantt.IlvActivity dest) Copies all Non-Null properties from the source to the destination, but it will NOT overwrite existing Non-Null properties in the destination.
static long	count(java.util.Iterator<?> items) Count the items
static long	countActivities(ilog.views.gantt.IlvHierarchyChart chart)
static long	countReservations(ilog.views.gantt.IlvScheduleChart chart)
static long	countResources(ilog.views.gantt.IlvHierarchyChart chart)
static ilog.views.gantt.IlvTimeInterval	createUnionTimeInterval(ilog.views.gantt.IlvHierarchyNode... nodes) Returns a TimeInterval that fits all the nodes that are passed in.
static void	dumpDebegInfoForContaints(java.lang.String msg, java.util.Iterator<ilog.views.gantt.IlvConstraint> iter)
static void	dumpDebugCompareInfoForItems(java.lang.String msg, ilog.views.gantt.property.IlvUserPropertyHolder item1, ilog.views.gantt.property.IlvUserPropertyHolder item2) Dumps 2 Activities and compares their properties
static void	dumpDebugInfoForContstraint(ilog.views.gantt.IlvConstraint c)
static void	dumpDebugInfoForItem(ilog.views.gantt.IlvGanttChart gchart, ilog.views.gantt.IlvActivity item) debug method that dumps the information about an activity and its properties.
static void	dumpDebugInfoForResource(ilog.views.gantt.IlvResource selectedresource, ilog.views.gantt.IlvGanttModel model)
static ilog.views.gantt.IlvActivity	getActivityById(ilog.views.gantt.IlvGanttModel model, ilog.views.gantt.IlvActivity parent, java.lang.String id) Convenience method for finding an Activiy by ID
static javax.swing.JPopupMenu	getActivityContextMenu(ilog.views.gantt.IlvActivity item, ilog.views.gantt.IlvGanttChart gchart) Returns a context menu for an Activity (Workorder) for expanding and selecting the children of a selected work order.
static ilog.views.gantt.IlvHierarchyNode[]	getChildren(ilog.views.gantt.IlvHierarchyNode item, ilog.views.gantt.IlvHierarchyChart chart) Convenience Method that returns all direct children for a given node
static java.util.Date	getEarliestStartTime(ilog.views.gantt.IlvActivity[] selected) Given an array of items, then return the earliest start time for all the activities
static java.lang.String	getID(ilog.views.gantt.IlvHierarchyNode node) Returns the ID for a Resource or Activity
static java.util.Date	getLatestEndTime(ilog.views.gantt.IlvActivity[] selected) Given the array of items, return the latest end time for all the activites
static ilog.views.gantt.IlvActivity	getParent(ilog.views.gantt.IlvActivity act, ilog.views.gantt.IlvGanttModel model) Returns the parent activity for the given activity in the model
static java.lang.Object	getProperty(java.lang.Object node, java.lang.String prop) Gets a property from a node
static <T> T	getProperty(java.lang.Object node, java.lang.String prop, T defaultValue) Gets a property from a Node and returns the default if not set.
static boolean	hasAnyChildren(ilog.views.gantt.IlvHierarchyNode[] items, ilog.views.gantt.IlvHierarchyChart chart) Returns true if ANY item has children
static boolean	hasChildren(ilog.views.gantt.IlvHierarchyNode item, ilog.views.gantt.IlvHierarchyChart chart) Returns true if the given MXActivity, IlvActivity or IlvHierarchyNode has children.
static boolean	hideDurationInTooltip(ilog.views.gantt.IlvActivity act)
static boolean	isAssignment(ilog.views.gantt.IlvActivity act) Returns true if the Activity is an Assignment
static boolean	isPM(ilog.views.gantt.IlvActivity act) Returns true if the activity is a PM activity
static boolean	isWorkorder(ilog.views.gantt.IlvActivity act) Returns true if the given IlvActivity is a work order
static boolean	isWorkorderApproved(MXActivity source) Returns true if the source is a workorder and it is approved
static void	moveToDay(java.util.Calendar day, ilog.views.gantt.IlvActivity[] selected, ilog.views.gantt.IlvGanttChart gchart) Given the Date and the selected items, it performs a Move To Day operation.
static Activities.IlvActivityVisitor<java.util.Set<java.lang.String>>	newAdjustTimeVisitor(ilog.views.gantt.IlvDuration adjustment) Creates a visitor that will adjust the start and end times on an activity by the given IlvDuration.
static boolean	setProperty(java.lang.Object node, java.lang.String prop, java.lang.Object val) Sets a property, if possible, in the IlvHierarchyNode.
static void	showWorkForSelectedActivities(ilog.views.gantt.IlvActivity[] selected, ilog.views.gantt.IlvHierarchyChart gchart) Resizes the Gantt View so that the selected activities will fit within the view
static void	showWorkForSelectedResource(ilog.views.gantt.IlvResource selected, ilog.views.gantt.IlvHierarchyChart chart) Given a resource, look at the reservations and build a time duration that can fit all those reservations
static void	showWorkForTimeInterval(long startMillis, long durMillis, ilog.views.gantt.IlvHierarchyChart gchart) Resizes the Gantt View so that the time window will fit within the view
static <T> void	visitActivities(ilog.views.gantt.IlvActivity[] items, ilog.views.gantt.IlvGanttChart ganttChart, Activities.IlvActivityVisitor<T> visitor, T state) Applies an IlvActivityVisitor to each activity and it's children.
static <T> void	visitActivity(ilog.views.gantt.IlvActivity item, ilog.views.gantt.IlvGanttChart ganttChart, Activities.IlvActivityVisitor<T> visitor, T state) Applies an IlvActivityVisitor to each activity and it's children.
static <T> void	visitNode(ilog.views.gantt.IlvHierarchyNode item, ilog.views.gantt.IlvHierarchyChart chart, Activities.IlvNodeVisitor<T> visitor, T state) Generic Visitor for visiting IlvHeirarchyNodes
static <T> void	visitNodes(ilog.views.gantt.IlvHierarchyNode[] items, ilog.views.gantt.IlvHierarchyChart ganttChart, Activities.IlvNodeVisitor<T> visitor, T state) Generic Visitor for IlvHierarchNodes
static <T> void	visitResource(ilog.views.gantt.IlvResource item, ilog.views.gantt.IlvHierarchyChart chart, Activities.IlvResourceVisitor<T> visitor, T state) Allow an IlvResource object to be visited by the visitor.
static <T> void	visitResources(ilog.views.gantt.IlvResource[] items, ilog.views.gantt.IlvHierarchyChart chart, Activities.IlvResourceVisitor<T> visitor, T state) Visits an array of Resources

Methods inherited from class java.lang.Object

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

Field Detail

WO_INTERNAL_STATUS_APPR

public static final java.lang.String WO_INTERNAL_STATUS_APPR

Internal Status for Approved WorkOrder "APPR"

See Also:

Constant Field Values

PROPERTY_READ_ONLY_MODEL

public static final java.lang.String PROPERTY_READ_ONLY_MODEL

Property on the ROOT activity to indicate that the model is readonly

See Also:

Constant Field Values

WORKORDER_OBJECTNAMES

public static final java.util.List<java.lang.String> WORKORDER_OBJECTNAMES

Global List of WORKORDER type object names

SELECT_ALL_ROWS_ACTIVITY_VISITOR

public static final Activities.IlvActivityVisitor<java.lang.Void> SELECT_ALL_ROWS_ACTIVITY_VISITOR

Simple Activities.IlvActivityVisitor that selects every row that is passed

COLLAPSE_ALL_ROWS_VISITOR

public static final Activities.IlvNodeVisitor<java.lang.Void> COLLAPSE_ALL_ROWS_VISITOR

Collapse all rows visitor

Constructor Detail

Activities

public Activities()

Method Detail

isWorkorder

public static boolean isWorkorder(ilog.views.gantt.IlvActivity act)

Returns true if the given IlvActivity is a work order

Parameters:

act - IlvActivity instance

Returns:

true if it's a work order activity

isAssignment

public static boolean isAssignment(ilog.views.gantt.IlvActivity act)

Returns true if the Activity is an Assignment

Parameters:

act -

Returns:

isPM

public static boolean isPM(ilog.views.gantt.IlvActivity act)

Returns true if the activity is a PM activity

Parameters:

act -

Returns:

hasChildren

public static boolean hasChildren(ilog.views.gantt.IlvHierarchyNode item,
                  ilog.views.gantt.IlvHierarchyChart chart)

Returns true if the given MXActivity, IlvActivity or IlvHierarchyNode has children.

Parameters:

item - IlvActivity instance (can be MXActivity or IlvHierarchyNode)

chart - gantt chart to while the item belongs

Returns:

true if the item has children

hasAnyChildren

public static boolean hasAnyChildren(ilog.views.gantt.IlvHierarchyNode[] items,
                     ilog.views.gantt.IlvHierarchyChart chart)

Returns true if ANY item has children

Parameters:

items -

ganttChart -

Returns:

addCrafts

public static void addCrafts(java.util.HashSet crafts,
             ilog.views.gantt.IlvActivity item,
             ilog.views.gantt.IlvGanttChart ganttChart)

For a given Activity on the chart, add its crafts to the set of passed in crafts. NOTE: THis will also return Cost and Crews as well.

Parameters:

crafts - HashSet to which the crafts should be placed

item - IlvActivity item on the chart

ganttChart - IlvGanttChart gantt chart

visitResource

public static <T> void visitResource(ilog.views.gantt.IlvResource item,
                     ilog.views.gantt.IlvHierarchyChart chart,
                     Activities.IlvResourceVisitor<T> visitor,
                     T state)

Allow an IlvResource object to be visited by the visitor.

Type Parameters:

T - State object

Parameters:

item - Item being visited

chart - Chart to which the item belongs

visitor - Visitor that will accept the item

state - State that will be passed to the visitor

visitResources

public static <T> void visitResources(ilog.views.gantt.IlvResource[] items,
                      ilog.views.gantt.IlvHierarchyChart chart,
                      Activities.IlvResourceVisitor<T> visitor,
                      T state)

Visits an array of Resources

Type Parameters:

T - State Object generic Type

Parameters:

items - array of IlvResource items

chart - chart to which the items belong

visitor - visitor that will accept each of the items

state - state that will be passed to the visitor

visitActivity

public static <T> void visitActivity(ilog.views.gantt.IlvActivity item,
                     ilog.views.gantt.IlvGanttChart ganttChart,
                     Activities.IlvActivityVisitor<T> visitor,
                     T state)

Applies an IlvActivityVisitor to each activity and it's children.

Parameters:

item - IlvActivity parent activity

ganttChart - IlvGanttChart to which the IlvActivity belongs

visitor - Activities.IlvActivityVisitor that will visit each item

visitNodes

public static <T> void visitNodes(ilog.views.gantt.IlvHierarchyNode[] items,
                  ilog.views.gantt.IlvHierarchyChart ganttChart,
                  Activities.IlvNodeVisitor<T> visitor,
                  T state)

Generic Visitor for IlvHierarchNodes

Type Parameters:

T -

Parameters:

items -

ganttChart -

visitor -

state -

visitNode

public static <T> void visitNode(ilog.views.gantt.IlvHierarchyNode item,
                 ilog.views.gantt.IlvHierarchyChart chart,
                 Activities.IlvNodeVisitor<T> visitor,
                 T state)

Generic Visitor for visiting IlvHeirarchyNodes

visitActivities

public static <T> void visitActivities(ilog.views.gantt.IlvActivity[] items,
                       ilog.views.gantt.IlvGanttChart ganttChart,
                       Activities.IlvActivityVisitor<T> visitor,
                       T state)

Applies an IlvActivityVisitor to each activity and it's children.

Parameters:

item - IlvActivity parent activity

ganttChart - IlvGanttChart to which the IlvActivity belongs

visitor - Activities.IlvActivityVisitor that will visit each item

newAdjustTimeVisitor

public static final Activities.IlvActivityVisitor<java.util.Set<java.lang.String>> newAdjustTimeVisitor(ilog.views.gantt.IlvDuration adjustment)

Creates a visitor that will adjust the start and end times on an activity by the given IlvDuration. IlvDuration defines constants for ONE_DAY, ONE_WEEK, etc, or you can pass your own duration. This visitor will tract each item that is visited in in the state Set, to prevent the same item from being visited more than once. The only use case for this is when you are processing multiple selected rows of a selected parent.

Parameters:

adjustment - IlvDuration to which to apply to the start and end time

Returns:

Activities.IlvActivityVisitor implementation that will adjust by the given adjustment

getActivityContextMenu

public static javax.swing.JPopupMenu getActivityContextMenu(ilog.views.gantt.IlvActivity item,
                                            ilog.views.gantt.IlvGanttChart gchart)

Returns a context menu for an Activity (Workorder) for expanding and selecting the children of a selected work order.

Parameters:

item - IlvActivity on which to attach the content menu

gchart - IlvGanttChart to which the item belongs

Returns:

a JPopupMenu or null if no valid menu can be created

moveToDay

public static void moveToDay(java.util.Calendar day,
             ilog.views.gantt.IlvActivity[] selected,
             ilog.views.gantt.IlvGanttChart gchart)

Given the Date and the selected items, it performs a Move To Day operation. The Time on the activities are retained, but their "day" is reparented to the given day

Parameters:

day -

selected -

gchart -

dumpDebugInfoForItem

public static void dumpDebugInfoForItem(ilog.views.gantt.IlvGanttChart gchart,
                        ilog.views.gantt.IlvActivity item)

debug method that dumps the information about an activity and its properties. Useful when you need to inspect the properties of an item.

Parameters:

gchart -

item -

dumpDebegInfoForContaints

public static void dumpDebegInfoForContaints(java.lang.String msg,
                             java.util.Iterator<ilog.views.gantt.IlvConstraint> iter)

dumpDebugInfoForContstraint

public static void dumpDebugInfoForContstraint(ilog.views.gantt.IlvConstraint c)

dumpDebugCompareInfoForItems

public static void dumpDebugCompareInfoForItems(java.lang.String msg,
                                ilog.views.gantt.property.IlvUserPropertyHolder item1,
                                ilog.views.gantt.property.IlvUserPropertyHolder item2)

Dumps 2 Activities and compares their properties

Parameters:

item1 -

item2 -

copyProperties

public static void copyProperties(ilog.views.gantt.IlvActivity src,
                  ilog.views.gantt.IlvActivity dest)

Copies all Non-Null properties from the source to the destination, but it will NOT overwrite existing Non-Null properties in the destination.

Parameters:

src -

dest -

showWorkForTimeInterval

public static void showWorkForTimeInterval(long startMillis,
                           long durMillis,
                           ilog.views.gantt.IlvHierarchyChart gchart)

Resizes the Gantt View so that the time window will fit within the view

Parameters:

selected -

gchart -

applyVisibleTime

public static void applyVisibleTime(ilog.views.gantt.IlvTimeScrollController timeScroller,
                    ilog.views.gantt.IlvHierarchyChart chart)

Applies the TimeScroller visible area to the Chart, and forces a sync

Parameters:

timeScroller -

chart -

showWorkForSelectedActivities

public static void showWorkForSelectedActivities(ilog.views.gantt.IlvActivity[] selected,
                                 ilog.views.gantt.IlvHierarchyChart gchart)

Resizes the Gantt View so that the selected activities will fit within the view

Parameters:

selected -

gchart -

adjustChartForPadding

public static void adjustChartForPadding(ilog.views.gantt.IlvHierarchyChart gchart,
                         java.util.Date start,
                         ilog.views.gantt.IlvDuration duration)

Utility method for adding padding to a visible duration

showWorkForSelectedResource

public static void showWorkForSelectedResource(ilog.views.gantt.IlvResource selected,
                               ilog.views.gantt.IlvHierarchyChart chart)

Given a resource, look at the reservations and build a time duration that can fit all those reservations

Parameters:

selected -

chart -

getEarliestStartTime

public static java.util.Date getEarliestStartTime(ilog.views.gantt.IlvActivity[] selected)

Given an array of items, then return the earliest start time for all the activities

Parameters:

selected -

Returns:

getLatestEndTime

public static java.util.Date getLatestEndTime(ilog.views.gantt.IlvActivity[] selected)

Given the array of items, return the latest end time for all the activites

Parameters:

selected -

Returns:

getParent

public static ilog.views.gantt.IlvActivity getParent(ilog.views.gantt.IlvActivity act,
                                     ilog.views.gantt.IlvGanttModel model)

Returns the parent activity for the given activity in the model

Parameters:

act -

model -

Returns:

getID

public static java.lang.String getID(ilog.views.gantt.IlvHierarchyNode node)

Returns the ID for a Resource or Activity

Parameters:

node -

Returns:

setProperty

public static boolean setProperty(java.lang.Object node,
                  java.lang.String prop,
                  java.lang.Object val)

Sets a property, if possible, in the IlvHierarchyNode. The node must implement IlvUserPropertyHolder for this to work.

Parameters:

node -

prop -

val -

Returns:

true if the property was set

getProperty

public static java.lang.Object getProperty(java.lang.Object node,
                           java.lang.String prop)

Gets a property from a node

Parameters:

node -

prop -

Returns:

getProperty

public static <T> T getProperty(java.lang.Object node,
                java.lang.String prop,
                T defaultValue)

Gets a property from a Node and returns the default if not set.

Type Parameters:

T -

Parameters:

node -

prop -

defaultValue -

Returns:

createUnionTimeInterval

public static ilog.views.gantt.IlvTimeInterval createUnionTimeInterval(ilog.views.gantt.IlvHierarchyNode... nodes)

Returns a TimeInterval that fits all the nodes that are passed in.

Parameters:

charts -

Returns:

isWorkorderApproved

public static boolean isWorkorderApproved(MXActivity source)

Returns true if the source is a workorder and it is approved

Parameters:

source -

Returns:

getActivityById

public static ilog.views.gantt.IlvActivity getActivityById(ilog.views.gantt.IlvGanttModel model,
                                           ilog.views.gantt.IlvActivity parent,
                                           java.lang.String id)

Convenience method for finding an Activiy by ID

Parameters:

model -

id -

Returns:

getChildren

public static ilog.views.gantt.IlvHierarchyNode[] getChildren(ilog.views.gantt.IlvHierarchyNode item,
                                              ilog.views.gantt.IlvHierarchyChart chart)

Convenience Method that returns all direct children for a given node

Parameters:

item -

chart -

Returns:

dumpDebugInfoForResource

public static void dumpDebugInfoForResource(ilog.views.gantt.IlvResource selectedresource,
                            ilog.views.gantt.IlvGanttModel model)

count

public static long count(java.util.Iterator<?> items)

Count the items

Parameters:

items -

Returns:

countActivities

public static long countActivities(ilog.views.gantt.IlvHierarchyChart chart)

countResources

public static long countResources(ilog.views.gantt.IlvHierarchyChart chart)

countReservations

public static long countReservations(ilog.views.gantt.IlvScheduleChart chart)

hideDurationInTooltip

public static boolean hideDurationInTooltip(ilog.views.gantt.IlvActivity act)