energygroup.evaluation

Class AbstractGroupTreeAction

java.lang.Object

energygroup.evaluation.AbstractGroupTreeAction

Direct Known Subclasses:

AddResultTreeAction, AdjustInitialStateTreeAction, ExecuteSubEvaluationStrategiesTreeAction, FinalStateTreeAction, GroupTreeViewSwitch, InitialStateTreeAction, IOSelectTreeAction, SubResultOpenTreeAction, SumUpFlowTreeAction, TechnicalSystemGroup_ScheduleListConverter, TechnicalSystemGroup_ScheduleListConverter, UpdateTechnicalInterfaceTreeAction

public abstract class AbstractGroupTreeAction
extends java.lang.Object

The abstract class AbstractGroupTreeAction can be extended in order to do Actions like summarising and other on the whole GroupTreeModel. After initialising, just call doGroupTreeAction() in order to start from the root node or call doGroupTreeAction(DefaultMutableTreeNode) to start from a specific node.
Both methods will run recursively through the GroupTreeModel, while for every node the doNodeAction(DefaultMutableTreeNode, GroupTreeNodeObject) will be invoked.
In order to control the traversal movement through the tree, use one of the elements of the enumeration AbstractGroupTreeAction.GroupTreeTraversal.

See Also:

GroupController.getGroupTreeModel(), GroupTreeModel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractGroupTreeAction.GroupTreeTraversal With the enumeration GroupTreeTraveral the traversal movement through the GroupTreeModel can be specified.

Constructor Summary

Constructors

Constructor and Description
AbstractGroupTreeAction(GroupController groupController) Instantiates a new group tree action with a AbstractGroupTreeAction.GroupTreeTraversal.SumUpSearch search.
AbstractGroupTreeAction(GroupController groupController, AbstractGroupTreeAction.GroupTreeTraversal groupTreeTraversal) Instantiates a new group tree action with the specified traversal movement.
AbstractGroupTreeAction(GroupController groupController, AbstractGroupTreeAction.GroupTreeTraversal groupTreeTraversal, AbstractGroupEvaluationStrategy groupEvaluationStrategy) Instantiates a new group tree action with the specified traversal movement.

Method Summary

Modifier and Type	Method and Description
void	doGroupTreeAction() Does the GroupTreeAction, starting from the root node.
void	doGroupTreeAction(javax.swing.tree.DefaultMutableTreeNode parentNode) Does the GroupTreeAction, starting from the specified parent node.
void	doNodeAction(javax.swing.tree.DefaultMutableTreeNode currentNode, GroupTreeNodeObject gtno) Should do the required action on the specified node and GroupTreeNodeObject.
abstract void	doNodeActionForGroupMemberScheduleList(javax.swing.tree.DefaultMutableTreeNode currentNode, GroupTreeNodeObject gtno) Should do the required action on the specified node and GroupTreeNodeObject of a group member that is a ScheduleList.
abstract void	doNodeActionForGroupMemberTechnicalSystem(javax.swing.tree.DefaultMutableTreeNode currentNode, GroupTreeNodeObject gtno) Should do the required action on the specified node and GroupTreeNodeObject of a group member that is a TechnicalSystem.
abstract void	doNodeActionForGroupMemberTechnicalSystemGroup(javax.swing.tree.DefaultMutableTreeNode currentNode, GroupTreeNodeObject gtno) Should do the required action on the specified node and GroupTreeNodeObject of a group member that is a TechnicalSystemGroup.
abstract void	doNodeActionForTechnicalSystemGroup(javax.swing.tree.DefaultMutableTreeNode rootNode, GroupTreeNodeObject gtno) Should do the required action for the node of the current TechnicalSystemGroup.
GroupController	getGroupController() Returns the current GroupController.
AbstractGroupEvaluationStrategy	getGroupEvaluationStrategy() Returns the current group evaluation strategy.
AbstractGroupTreeAction.GroupTreeTraversal	getGroupTreeTraversal() Returns the group tree traversal.
java.util.Vector<javax.swing.tree.DefaultMutableTreeNode>	getNodes2Visit() Returns the vector of nodes that are to visit with the current group tree action.
java.util.Vector<javax.swing.tree.DefaultMutableTreeNode>	getNodesNotVisited() Returns the vector of nodes that were NOT visited through the current group tree action.
java.util.Vector<javax.swing.tree.DefaultMutableTreeNode>	getNodesVisited() Returns the vector of nodes that were visited through the current group tree action.
AbstractSequentialNetworkCalculation<?>	getSequentialNetworkCalculation() Returns the current sequential network calculation.
boolean	isSequentialNetworkCalculation() Returns true, if as sequential network calculation is defined.
void	setGroupEvaluationStrategy(AbstractGroupEvaluationStrategy groupEvaluationStrategy) Sets the current group evaluation strategy and the value for the sequential network calculation.
void	setGroupTreeTraversal(AbstractGroupTreeAction.GroupTreeTraversal groupTreeTraversal) Sets the group tree traversal.
void	setSequentialNetworkCalculation(AbstractSequentialNetworkCalculation<?> networkCalculation) Sets the current sequential network calculation.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractGroupTreeAction

public AbstractGroupTreeAction(GroupController groupController)

Instantiates a new group tree action with a AbstractGroupTreeAction.GroupTreeTraversal.SumUpSearch search.

Parameters:

groupController - the GroupController

AbstractGroupTreeAction

public AbstractGroupTreeAction(GroupController groupController,
                               AbstractGroupTreeAction.GroupTreeTraversal groupTreeTraversal)

Instantiates a new group tree action with the specified traversal movement.

Parameters:

groupController - the group controller

groupTreeTraversal - the group tree traversal

AbstractGroupTreeAction

public AbstractGroupTreeAction(GroupController groupController,
                               AbstractGroupTreeAction.GroupTreeTraversal groupTreeTraversal,
                               AbstractGroupEvaluationStrategy groupEvaluationStrategy)

Instantiates a new group tree action with the specified traversal movement.

Parameters:

groupController - the group controller

groupTreeTraversal - the group tree traversal

groupEvaluationStrategy - the group evaluation strategy

Method Detail

getGroupController

public GroupController getGroupController()

Returns the current GroupController.

Returns:

the group controller

setGroupTreeTraversal

public void setGroupTreeTraversal(AbstractGroupTreeAction.GroupTreeTraversal groupTreeTraversal)

Sets the group tree traversal.

Parameters:

groupTreeTraversal - the new AbstractGroupTreeAction.GroupTreeTraversal for this tree action

getGroupTreeTraversal

public AbstractGroupTreeAction.GroupTreeTraversal getGroupTreeTraversal()

Returns the group tree traversal.

Returns:

the AbstractGroupTreeAction.GroupTreeTraversal

getNodes2Visit

public java.util.Vector<javax.swing.tree.DefaultMutableTreeNode> getNodes2Visit()

Returns the vector of nodes that are to visit with the current group tree action.

Returns:

the nodes to visit within the current aggregation

getNodesVisited

public java.util.Vector<javax.swing.tree.DefaultMutableTreeNode> getNodesVisited()

Returns the vector of nodes that were visited through the current group tree action.

Returns:

the vector of nodes visited

getNodesNotVisited

public java.util.Vector<javax.swing.tree.DefaultMutableTreeNode> getNodesNotVisited()

Returns the vector of nodes that were NOT visited through the current group tree action.

Returns:

the vector of nodes visited

doGroupTreeAction

public void doGroupTreeAction()

Does the GroupTreeAction, starting from the root node.

doGroupTreeAction

public void doGroupTreeAction(javax.swing.tree.DefaultMutableTreeNode parentNode)

Does the GroupTreeAction, starting from the specified parent node.

Parameters:

parentNode - the parent node

setGroupEvaluationStrategy

public void setGroupEvaluationStrategy(AbstractGroupEvaluationStrategy groupEvaluationStrategy)

Sets the current group evaluation strategy and the value for the sequential network calculation. If a sequential network calculation is defined, the GroupTreeTraversal will be set to that sequential calculation

Parameters:

groupEvaluationStrategy - the new group evaluation strategy

getGroupEvaluationStrategy

public AbstractGroupEvaluationStrategy getGroupEvaluationStrategy()

Returns the current group evaluation strategy.

Returns:

the group evaluation strategy

setSequentialNetworkCalculation

public void setSequentialNetworkCalculation(AbstractSequentialNetworkCalculation<?> networkCalculation)

Sets the current sequential network calculation.

Parameters:

networkCalculation - the new network calculation

getSequentialNetworkCalculation

public AbstractSequentialNetworkCalculation<?> getSequentialNetworkCalculation()

Returns the current sequential network calculation.

Returns:

the network calculation

isSequentialNetworkCalculation

public boolean isSequentialNetworkCalculation()

Returns true, if as sequential network calculation is defined.

Returns:

true, if as sequential network calculation is defined

doNodeAction

public void doNodeAction(javax.swing.tree.DefaultMutableTreeNode currentNode,
                         GroupTreeNodeObject gtno)

Should do the required action on the specified node and GroupTreeNodeObject.

Parameters:

currentNode - the current node to work on

gtno - the GroupTreeNodeObject

doNodeActionForTechnicalSystemGroup

public abstract void doNodeActionForTechnicalSystemGroup(javax.swing.tree.DefaultMutableTreeNode rootNode,
                                                         GroupTreeNodeObject gtno)

Should do the required action for the node of the current TechnicalSystemGroup.

Parameters:

rootNode - the root node of the GroupTreeModel

gtno - the GroupTreeNodeObject

doNodeActionForGroupMemberTechnicalSystem

public abstract void doNodeActionForGroupMemberTechnicalSystem(javax.swing.tree.DefaultMutableTreeNode currentNode,
                                                               GroupTreeNodeObject gtno)

Should do the required action on the specified node and GroupTreeNodeObject of a group member that is a TechnicalSystem.

Parameters:

currentNode - the current node of the GroupTreeModel to work on

gtno - the GroupTreeNodeObject

doNodeActionForGroupMemberScheduleList

public abstract void doNodeActionForGroupMemberScheduleList(javax.swing.tree.DefaultMutableTreeNode currentNode,
                                                            GroupTreeNodeObject gtno)

Should do the required action on the specified node and GroupTreeNodeObject of a group member that is a ScheduleList.

Parameters:

currentNode - the current node of the GroupTreeModel to work on

gtno - the GroupTreeNodeObject

doNodeActionForGroupMemberTechnicalSystemGroup

public abstract void doNodeActionForGroupMemberTechnicalSystemGroup(javax.swing.tree.DefaultMutableTreeNode currentNode,
                                                                    GroupTreeNodeObject gtno)

Should do the required action on the specified node and GroupTreeNodeObject of a group member that is a TechnicalSystemGroup.

Parameters:

currentNode - the current node of the GroupTreeModel to work on

gtno - the GroupTreeNodeObject