energygroup.sequentialNetworks

Class AbstractSequentialNetworkCalculation<T>

java.lang.Object

energygroup.sequentialNetworks.AbstractSequentialNetworkCalculation<T>

public abstract class AbstractSequentialNetworkCalculation<T>
extends java.lang.Object

The Class AbstractSequentialNetworkCalculation.

Constructor Summary

Constructors

Constructor and Description
AbstractSequentialNetworkCalculation(GroupController groupController) Instantiates a new abstract sequential network calculation.

Method Summary

Modifier and Type	Method and Description
java.util.HashMap<javax.swing.tree.DefaultMutableTreeNode,T>	createNodeStateHashMap() Creates a new node state hash map.
void	doSequentialNetworkCalculation() Does the actual network calculation with the specified in-node states of the initial CalculationStepNode.
CalculationGraph<T>	getCalculationGraphForGroupNodeVector(java.util.Vector<javax.swing.tree.DefaultMutableTreeNode> groupNodeVector) Allows to add a vector of nodes from the GroupTreeModel that represents a simple sequential arrangement of systems instances (e.g. for a mesh of systems).
GroupController	getGroupController() Returns the current GroupController.
AbstractGroupEvaluationStrategy	getGroupEvaluationStrategy() Gets the group evaluation strategy.
AbstractGroupTreeAction	getGroupTreeAction() Returns the current group tree action.
abstract T	getNewInstanceOfIntermediateDataModel() Has to return a new instance of intermediate data model to use.
java.util.HashMap<javax.swing.tree.DefaultMutableTreeNode,T>	getNewNodeStateHashMap(javax.swing.tree.DefaultMutableTreeNode[] omcArray) Return a new node state hash map for the specified identifier.
java.util.HashMap<javax.swing.tree.DefaultMutableTreeNode,T>	getNewNodeStateHashMap(java.util.Vector<javax.swing.tree.DefaultMutableTreeNode> groupNodeVector) Return a new node state hash map for the specified identifier.
java.util.Vector<CalculationStepNode<T>>	getNextCalculationStepNodes(CalculationGraph<T> calcGraph, CalculationStepNode<T> currCalcNode) Returns the next calculation step nodes or null, if no subsequent nodes are available.
abstract java.util.Vector<CalculationGraph<T>>	getVectorOfCalculationGraphs() Has to return the calculation graph that describes the order of the sequential network calculation steps.
abstract boolean	isConsiderGroupTreeNodesOutsideSequentialNetworkCalculation() Has to return if group tree nodes that are not used in the local vector of CalculationGraph and thus are not visited during the sequential network calculation have to consider too.
boolean	isDebugMode() Checks if is debugMode.
protected void	onFinishedCalculationGraphSequence(CalculationGraph<T> calcGraph, java.util.Vector<CalculationStepNode<T>> finalCalculationStepNodes) This method will be invoked after the execution of the calculations that are defined with a single CalculationGraph.
protected void	onFinishedSequentialNetworkCalculation() This method will be invoked after the execution of a sequential network calculation.
protected boolean	requiresFurtherCalculationGraphSequence(CalculationGraph<T> calcGraph) Should return true, if the specified CalculationGraph requires another calculation sequence.
void	setDebugMode(boolean isDebug) Sets that execution of the sequence should be debuged.
void	setGroupEvaluationStrategy(AbstractGroupEvaluationStrategy groupEvaluationStrategy) Sets the group evaluation strategy.
void	setGroupTreeAction(AbstractGroupTreeAction groupTreeAction) Sets the current group tree action.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSequentialNetworkCalculation

public AbstractSequentialNetworkCalculation(GroupController groupController)

Instantiates a new abstract sequential network calculation.

Parameters:

groupController - the group controller

Method Detail

setDebugMode

public void setDebugMode(boolean isDebug)

Sets that execution of the sequence should be debuged.

Parameters:

isDebug - the new debug mode

isDebugMode

public boolean isDebugMode()

Checks if is debugMode.

Returns:

true, if is debugMode

getGroupController

public GroupController getGroupController()

Returns the current GroupController.

Returns:

the group controller

setGroupTreeAction

public void setGroupTreeAction(AbstractGroupTreeAction groupTreeAction)

Sets the current group tree action.

Parameters:

groupTreeAction - the new group tree action

getGroupTreeAction

public AbstractGroupTreeAction getGroupTreeAction()

Returns the current group tree action.

Returns:

the group tree action

setGroupEvaluationStrategy

public void setGroupEvaluationStrategy(AbstractGroupEvaluationStrategy groupEvaluationStrategy)

Sets the group evaluation strategy.

Parameters:

groupEvaluationStrategy - the new group evaluation strategy

getGroupEvaluationStrategy

public AbstractGroupEvaluationStrategy getGroupEvaluationStrategy()

Gets the group evaluation strategy.

Returns:

the group evaluation strategy

doSequentialNetworkCalculation

public void doSequentialNetworkCalculation()

Does the actual network calculation with the specified in-node states of the initial CalculationStepNode.
To define the in-node states, use the set in-node states method in each CalculationGraph defined in this extended AbstractSequentialNetworkCalculation.

See Also:

CalculationGraph, CalculationGraph.setInitialCalculationStepNode(CalculationStepNode), CalculationStepNode, CalculationStepNode.setInNodeState(HashMap)

onFinishedCalculationGraphSequence

protected void onFinishedCalculationGraphSequence(CalculationGraph<T> calcGraph,
                                                  java.util.Vector<CalculationStepNode<T>> finalCalculationStepNodes)

This method will be invoked after the execution of the calculations that are defined with a single CalculationGraph. Override this method in case that you need the information of the final CalculationStepNodes

Parameters:

calcGraph - the actual CalculationGraph and its corresponding CalculationStepNode's that were executed

finalCalculationStepNodes - the final calculation step nodes of the calculation sequence

requiresFurtherCalculationGraphSequence

protected boolean requiresFurtherCalculationGraphSequence(CalculationGraph<T> calcGraph)

Should return true, if the specified CalculationGraph requires another calculation sequence. Override this method in case that you need to control single calculation sequences.

Parameters:

calcGraph - the actual CalculationGraph and its corresponding CalculationStepNode's that were executed

Returns:

true, if a further calculation sequence is required

onFinishedSequentialNetworkCalculation

protected void onFinishedSequentialNetworkCalculation()

This method will be invoked after the execution of a sequential network calculation. That means that each calculation graph defined was calculated once.
In order to re-execute the network calculation, call doSequentialNetworkCalculation().

getNextCalculationStepNodes

public java.util.Vector<CalculationStepNode<T>> getNextCalculationStepNodes(CalculationGraph<T> calcGraph,
                                                                            CalculationStepNode<T> currCalcNode)

Returns the next calculation step nodes or null, if no subsequent nodes are available.

Parameters:

calcGraph - the CalculationGraph

currCalcNode - the CalculationStepNode from which search has to be executed

Returns:

the next calculation step nodes

getNewInstanceOfIntermediateDataModel

public abstract T getNewInstanceOfIntermediateDataModel()

Has to return a new instance of intermediate data model to use.

Returns:

the new instance of intermediate data model

getCalculationGraphForGroupNodeVector

public CalculationGraph<T> getCalculationGraphForGroupNodeVector(java.util.Vector<javax.swing.tree.DefaultMutableTreeNode> groupNodeVector)

Allows to add a vector of nodes from the GroupTreeModel that represents a simple sequential arrangement of systems instances (e.g. for a mesh of systems).

Parameters:

groupNodeVector - the group node vector

Returns:

the calculation graph for the arrangement of systems

createNodeStateHashMap

public java.util.HashMap<javax.swing.tree.DefaultMutableTreeNode,T> createNodeStateHashMap()

Creates a new node state hash map.

Returns:

the new hash map

getNewNodeStateHashMap

public java.util.HashMap<javax.swing.tree.DefaultMutableTreeNode,T> getNewNodeStateHashMap(java.util.Vector<javax.swing.tree.DefaultMutableTreeNode> groupNodeVector)

Return a new node state hash map for the specified identifier.

Parameters:

groupNodeVector - the vector of group tree nodes from the GroupTreeModel

Returns:

the new node state hash map

getNewNodeStateHashMap

public java.util.HashMap<javax.swing.tree.DefaultMutableTreeNode,T> getNewNodeStateHashMap(javax.swing.tree.DefaultMutableTreeNode[] omcArray)

Return a new node state hash map for the specified identifier.

Parameters:

omcArray - the array of group tree nodes from the GroupTreeModel

Returns:

the new node state hash map

getVectorOfCalculationGraphs

public abstract java.util.Vector<CalculationGraph<T>> getVectorOfCalculationGraphs()

Has to return the calculation graph that describes the order of the sequential network calculation steps.

Returns:

the calculation graph

isConsiderGroupTreeNodesOutsideSequentialNetworkCalculation

public abstract boolean isConsiderGroupTreeNodesOutsideSequentialNetworkCalculation()

Has to return if group tree nodes that are not used in the local vector of CalculationGraph and thus are not visited during the sequential network calculation have to consider too.

Returns:

true, if nodes outside of the sequential network calculation have to be visited / considered too