energygroup

Class GroupTreeModel

java.lang.Object

javax.swing.tree.DefaultTreeModel

energygroup.GroupTreeModel

All Implemented Interfaces:

java.io.Serializable, javax.swing.tree.TreeModel

public class GroupTreeModel
extends javax.swing.tree.DefaultTreeModel

The Class GroupTreeModel contains all TechnicalSystem's, all Sub-TechnicalSystemGroup's and all ScheduleList's that belong to the current TechnicalSystemGroup.

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.swing.tree.DefaultTreeModel

asksAllowsChildren, listenerList, root

Constructor Summary

Constructors

Constructor and Description
GroupTreeModel(GroupController groupController) Instantiates a new group tree model.

Method Summary

Modifier and Type	Method and Description
void	addGroupMember(javax.swing.tree.DefaultMutableTreeNode parent, GroupMember groupMember) Adds a new group member to the specified parent model node.
void	addGroupMember(GroupMember groupMember) Adds a new group member to the model.
GroupTreeModel	getFilteredCopy(boolean filterSchedule, boolean filterTechnicalSystem, boolean filterTechnicalSystemGroup, java.lang.String filterPhrase) Gets the filtered copy of the GroupTreeModel.
GroupMember	getGroupMember(java.lang.Object searchObject) Returns the GroupMember for the specified searchObject that can be a ScheduleController, a OptionModelController, a GroupController or a corresponding visualisation object.
java.util.HashMap<GroupMember,javax.swing.tree.DefaultMutableTreeNode>	getGroupMemberToNodeHash() Gets the GroupMember to node hash.
javax.swing.tree.DefaultMutableTreeNode	getGroupTreeNode(EomController eomController) Returns the group tree node of the specified EomController that is either an OptionModelController, a ScheduleController or a GroupController.
javax.swing.tree.DefaultMutableTreeNode	getGroupTreeNodeByNetworkID(java.lang.String networkIDToSearchFor) Returns the group tree node identified by the specified networkID or null.
GroupTreeNodeObject	getGroupTreeNodeObject(EomController eomController) Returns the group tree node object of the specified EomController that is either an OptionModelController, a ScheduleController or a GroupController.
GroupTreeNodeObject	getGroupTreeNodeObject(GroupMember groupMember) Gets the tree node object of the specified GroupMember.
GroupTreeNodeObject	getGroupTreeNodeObjectByNetworkID(java.lang.String networkIDToSearchFor) Returns the GroupTreeNodeObject identified by the specified networkID or null.
java.util.Vector<GroupTreeNodeObject>	getGroupTreeNodeObjectsBySystemID(java.lang.String systemIDToSearchFor) Returns all GroupTreeNodeObjects by its systemID as vector (consider that it is possible to have several systems of the same type).
java.util.Vector<javax.swing.tree.DefaultMutableTreeNode>	getGroupTreeNodesBySystemID(java.lang.String systemIDToSearchFor) Returns all group tree node by its systemID as vector (consider that it is possible to have several systems of the same type).
java.util.Vector<javax.swing.tree.DefaultMutableTreeNode>	getGroupTreeNodesSortedByLevelAndIndex() Returns the vector of group tree nodes sorted by tree level and index .
int	getNodeCount() Gets the node count.
javax.swing.tree.DefaultMutableTreeNode	getRootNode() Returns the root node.
javax.swing.tree.DefaultMutableTreeNode	getTreeNode(GroupMember groupMember) Gets the tree node of the specified GroupMember.
boolean	isNodeOfTechnicalSystemGroup(javax.swing.tree.DefaultMutableTreeNode groupTreeNode) Checks if the specified node is of a TechnicalSystemGroup.
boolean	removeGroupMember(GroupMember groupMember) Removes the specified GroupMember.
void	resetTreeModel() Resets the tree model by deleting all sub nodes from the root node.

Methods inherited from class javax.swing.tree.DefaultTreeModel

addTreeModelListener, asksAllowsChildren, fireTreeNodesChanged, fireTreeNodesInserted, fireTreeNodesRemoved, fireTreeStructureChanged, getChild, getChildCount, getIndexOfChild, getListeners, getPathToRoot, getPathToRoot, getRoot, getTreeModelListeners, insertNodeInto, isLeaf, nodeChanged, nodesChanged, nodeStructureChanged, nodesWereInserted, nodesWereRemoved, reload, reload, removeNodeFromParent, removeTreeModelListener, setAsksAllowsChildren, setRoot, valueForPathChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupTreeModel

public GroupTreeModel(GroupController groupController)

Instantiates a new group tree model.

Parameters:

groupController - the group controller

Method Detail

getRootNode

public javax.swing.tree.DefaultMutableTreeNode getRootNode()

Returns the root node.

Returns:

the root node

getNodeCount

public int getNodeCount()

Gets the node count.

Returns:

the node count

getGroupMemberToNodeHash

public java.util.HashMap<GroupMember,javax.swing.tree.DefaultMutableTreeNode> getGroupMemberToNodeHash()

Gets the GroupMember to node hash.

Returns:

the group to node hash

getGroupTreeNodesSortedByLevelAndIndex

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

Returns the vector of group tree nodes sorted by tree level and index .

Returns:

the sorted group nodes of the current aggregation

getTreeNode

public javax.swing.tree.DefaultMutableTreeNode getTreeNode(GroupMember groupMember)

Gets the tree node of the specified GroupMember.

Parameters:

groupMember - the group member

Returns:

the tree node

getGroupTreeNode

public javax.swing.tree.DefaultMutableTreeNode getGroupTreeNode(EomController eomController)

Returns the group tree node of the specified EomController that is either an OptionModelController, a ScheduleController or a GroupController.

Parameters:

eomController - the EomController

Returns:

the group tree node

getGroupTreeNodeByNetworkID

public javax.swing.tree.DefaultMutableTreeNode getGroupTreeNodeByNetworkID(java.lang.String networkIDToSearchFor)

Returns the group tree node identified by the specified networkID or null.

Parameters:

networkIDToSearchFor - the network ID to search for

Returns:

the GroupTreeNodeObject found

getGroupTreeNodesBySystemID

public java.util.Vector<javax.swing.tree.DefaultMutableTreeNode> getGroupTreeNodesBySystemID(java.lang.String systemIDToSearchFor)

Returns all group tree node by its systemID as vector (consider that it is possible to have several systems of the same type).

Parameters:

systemIDToSearchFor - the system ID to search for

Returns:

the vector of group nodes found

getGroupTreeNodeObject

public GroupTreeNodeObject getGroupTreeNodeObject(GroupMember groupMember)

Gets the tree node object of the specified GroupMember.

Parameters:

groupMember - the group member

Returns:

the tree node object

getGroupMember

public GroupMember getGroupMember(java.lang.Object searchObject)

Returns the GroupMember for the specified searchObject that can be a ScheduleController, a OptionModelController, a GroupController or a corresponding visualisation object.

Parameters:

searchObject - the search object

Returns:

the group member

getGroupTreeNodeObject

public GroupTreeNodeObject getGroupTreeNodeObject(EomController eomController)

Returns the group tree node object of the specified EomController that is either an OptionModelController, a ScheduleController or a GroupController.

Parameters:

eomController - the eom controller

Returns:

the group tree node object

getGroupTreeNodeObjectByNetworkID

public GroupTreeNodeObject getGroupTreeNodeObjectByNetworkID(java.lang.String networkIDToSearchFor)

Returns the GroupTreeNodeObject identified by the specified networkID or null.

Parameters:

networkIDToSearchFor - the network ID to search for

Returns:

the GroupTreeNodeObject found

getGroupTreeNodeObjectsBySystemID

public java.util.Vector<GroupTreeNodeObject> getGroupTreeNodeObjectsBySystemID(java.lang.String systemIDToSearchFor)

Returns all GroupTreeNodeObjects by its systemID as vector (consider that it is possible to have several systems of the same type).

Parameters:

systemIDToSearchFor - the system ID to search for

Returns:

the GroupTreeNodeObject's found

addGroupMember

public void addGroupMember(GroupMember groupMember)

Adds a new group member to the model.

Parameters:

groupMember - the group member

addGroupMember

public void addGroupMember(javax.swing.tree.DefaultMutableTreeNode parent,
                           GroupMember groupMember)

Adds a new group member to the specified parent model node.

Parameters:

parent - the parent node

groupMember - the group member

removeGroupMember

public boolean removeGroupMember(GroupMember groupMember)

Removes the specified GroupMember.

Parameters:

groupMember - the group member

Returns:

true, if successful

isNodeOfTechnicalSystemGroup

public boolean isNodeOfTechnicalSystemGroup(javax.swing.tree.DefaultMutableTreeNode groupTreeNode)

Checks if the specified node is of a TechnicalSystemGroup.

Parameters:

groupTreeNode - the group tree node

Returns:

true, if is node of technical system group

resetTreeModel

public void resetTreeModel()

Resets the tree model by deleting all sub nodes from the root node.

getFilteredCopy

public GroupTreeModel getFilteredCopy(boolean filterSchedule,
                                      boolean filterTechnicalSystem,
                                      boolean filterTechnicalSystemGroup,
                                      java.lang.String filterPhrase)

Gets the filtered copy of the GroupTreeModel.

Parameters:

filterSchedule - the filter schedule

filterTechnicalSystem - the filter technical system

filterTechnicalSystemGroup - the filter technical system group

filterPhrase - the filter phrase

Returns:

the filtered copy