energygroup

Class GroupController

java.lang.Object

java.util.Observable

energygroup.GroupController

All Implemented Interfaces:

EomController, java.util.Observer

public class GroupController
extends java.util.Observable
implements EomController, java.util.Observer

The Class GroupController serves as a controller for TechnicalSystemGroups and organizes the aggregated structure of subsystems that are either TechnicalSystems ScheduleLists or TechnicalSystemGroups again.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GroupController.GroupMemberType

Constructor Summary

Constructors

Constructor and Description
GroupController() Instantiates a new group controller.

Method Summary

Modifier and Type	Method and Description
GroupMember	addScheduleList() Adds a new ScheduleList to the current TechnicalSystemGroup.
GroupMember	addScheduleList(ScheduleList sl, javax.swing.tree.DefaultMutableTreeNode parentGroupNode) Adds the specified ScheduleList to the TechnicalSystemGroup.
GroupMember	addTechnicalSystem() Adds a TechnicalSystem to the current TechnicalSystemGroup.
GroupMember	addTechnicalSystem(TechnicalSystem ts, javax.swing.tree.DefaultMutableTreeNode parentGroupNode) Adds the specified TechnicalSystem to the current TechnicalSystemGroup.
GroupMember	addTechnicalSystemGroup() Adds a TechnicalSystemGroup to the current TechnicalSystemGroup.
GroupMember	addTechnicalSystemGroup(TechnicalSystemGroup tsg, javax.swing.tree.DefaultMutableTreeNode parentGroupNode) Adds a TechnicalSystemGroup to the current TechnicalSystemGroup.
void	copyGroupMember(java.awt.Frame owner, GroupMember groupMember2Copy) Copies the specified GroupMember.
void	copyGroupMember(GroupMember gm2Copy, int noOfCopies) Copies the specified GroupMember n times.
java.io.File	getCurrentFile() Has to return the file object that is currently open in the controller.
EomController	getEOMControllerByNetworkID(java.lang.String networkID) Gets the actual EomController of the specified system (that can be an OptionModelController, a ScheduleController or a GroupController) identified by the network ID.
GlobalInfo	getGlobalInfo() Gets the global info.
GroupController.GroupMemberType	getGroupMemberType(GroupMember groupMember) Returns the GroupController.GroupMemberType from the specified GroupMember.
OptionModelController	getGroupOptionModelController() Returns OptionModelController for the current group.
GroupTreeModel	getGroupTreeModel() Returns the group tree model.
ObjectFactory	getObjectFactory() Returns the object factory for the option model.
GroupSelectionModel	getSelectionModel() Returns the current selection model.
TechnicalSystemGroup	getTechnicalSystemGroup() Returns or creates the TechnicalSystemGroup.
TechnicalSystemGroup	getTechnicalSystemGroupCopy() Returns a copied instance of the current TechnicalSystem.
java.awt.Container	getVisualisation(GroupMember groupMember) Returns the visualisation for the specified GroupMember.
boolean	hasTechnicalSystemGroupChanged() Checks if the TechnicalSystemGroup has changed.
boolean	isClosable(java.awt.Component parentComponent) Checks and return if the current controller and its open file is closable.
void	loadOptionModelGroup(java.io.File fileToLoad, java.awt.Container parentContainer) Loads a file to the current group.
boolean	removeGroupMember(GroupMember groupMember) Removes the specified GroupMember from the current TechnicalSystemGroup.
void	resetGroupModel() Resets the group model.
boolean	saveOptionModelGroup(java.awt.Component parentComponent) Saves the current TechnicalSystemGroup to the file specified in getCurrentFile()..
boolean	saveOptionModelGroupAs(java.awt.Component parentComponent) Save the current TechnicalSystemGroup as new file (with user interaction for choosing the file location).
void	setChangedAndNotifyObservers(java.lang.Object notification) Sets the current state to changed and notifies all observers in one step.
void	setCurrentFile(java.io.File currentFile) Sets the current file.
void	setInitialSelection() Sets the initial selection.
void	setTechnicalSystemGroup(TechnicalSystemGroup newTechnicalSystemGroup) Sets the current TechnicalSystemGroup.
void	setTechnicalSystemGroupReminder() Sets the technical system reminder in order to recognize changes in the model later on.
java.lang.String	toString()
void	update(java.util.Observable observable, java.lang.Object updateObject) This update method observes changes within the single TechnicalSystem's.
void	updateTechnicalInterfacesAndStorageInformation() Update all EnergyInterface's and the storage information (capacity & load).
boolean	updateTechnicalInterfacesAndStorageInformation(AbstractGroupEvaluationStrategy ages) Updates all EnergyInterface's and the storage information (capacity & load).

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupController

public GroupController()

Instantiates a new group controller.

Method Detail

setChangedAndNotifyObservers

public void setChangedAndNotifyObservers(java.lang.Object notification)

Description copied from interface: EomController

Sets the current state to changed and notifies all observers in one step.

Specified by:

setChangedAndNotifyObservers in interface EomController

Parameters:

notification - the new changed and notify observers

getGlobalInfo

public GlobalInfo getGlobalInfo()

Gets the global info.

Returns:

the global info

getObjectFactory

public ObjectFactory getObjectFactory()

Returns the object factory for the option model.

Returns:

the object factory

getSelectionModel

public GroupSelectionModel getSelectionModel()

Returns the current selection model.

Returns:

the selection model

setInitialSelection

public void setInitialSelection()

Sets the initial selection.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

loadOptionModelGroup

public void loadOptionModelGroup(java.io.File fileToLoad,
                                 java.awt.Container parentContainer)

Loads a file to the current group.

Parameters:

fileToLoad - the file to load

parentContainer - the parent container

saveOptionModelGroup

public boolean saveOptionModelGroup(java.awt.Component parentComponent)

Saves the current TechnicalSystemGroup to the file specified in getCurrentFile()..

Parameters:

parentComponent - the parent component (may be null)

Returns:

true, if successful

See Also:

getCurrentFile(), setCurrentFile(File)

saveOptionModelGroupAs

public boolean saveOptionModelGroupAs(java.awt.Component parentComponent)

Save the current TechnicalSystemGroup as new file (with user interaction for choosing the file location).

Parameters:

parentComponent - the parent component (may be null)

Returns:

true, if successful

isClosable

public boolean isClosable(java.awt.Component parentComponent)

Description copied from interface: EomController

Checks and return if the current controller and its open file is closable.

Specified by:

isClosable in interface EomController

Parameters:

parentComponent - the parent component that has the current focus (for user requests)

Returns:

true, if the current controller is closable

hasTechnicalSystemGroupChanged

public boolean hasTechnicalSystemGroupChanged()

Checks if the TechnicalSystemGroup has changed.

Returns:

true, if the TechnicalSystemGroup has changed

setTechnicalSystemGroupReminder

public void setTechnicalSystemGroupReminder()

Sets the technical system reminder in order to recognize changes in the model later on.

resetGroupModel

public void resetGroupModel()

Resets the group model.

setTechnicalSystemGroup

public void setTechnicalSystemGroup(TechnicalSystemGroup newTechnicalSystemGroup)

Sets the current TechnicalSystemGroup.

Parameters:

newTechnicalSystemGroup - the new technical system group

getTechnicalSystemGroup

public TechnicalSystemGroup getTechnicalSystemGroup()

Returns or creates the TechnicalSystemGroup.

Returns:

the technical system group

getTechnicalSystemGroupCopy

public TechnicalSystemGroup getTechnicalSystemGroupCopy()

Returns a copied instance of the current TechnicalSystem.

Returns:

the TechnicalSystem copy

setCurrentFile

public void setCurrentFile(java.io.File currentFile)

Sets the current file.

Parameters:

currentFile - the new current file

getCurrentFile

public java.io.File getCurrentFile()

Description copied from interface: EomController

Has to return the file object that is currently open in the controller.

Specified by:

getCurrentFile in interface EomController

Returns:

the file object

getGroupOptionModelController

public OptionModelController getGroupOptionModelController()

Returns OptionModelController for the current group.

Returns:

the group option model controller

getGroupMemberType

public GroupController.GroupMemberType getGroupMemberType(GroupMember groupMember)

Returns the GroupController.GroupMemberType from the specified GroupMember.

Parameters:

groupMember - the group member

Returns:

the group member type

getGroupTreeModel

public GroupTreeModel getGroupTreeModel()

Returns the group tree model.

Returns:

the group tree model

getVisualisation

public java.awt.Container getVisualisation(GroupMember groupMember)

Returns the visualisation for the specified GroupMember.

Parameters:

groupMember - the GroupMember

Returns:

the container instance of the visualisation

getEOMControllerByNetworkID

public EomController getEOMControllerByNetworkID(java.lang.String networkID)

Gets the actual EomController of the specified system (that can be an OptionModelController, a ScheduleController or a GroupController) identified by the network ID.

Parameters:

networkID - the network ID

Returns:

the EOM controller by network ID

addScheduleList

public GroupMember addScheduleList()

Adds a new ScheduleList to the current TechnicalSystemGroup.

Returns:

the Vector of schedules that are in fact TechnicalSystemStateEvaluation that were added

addScheduleList

public GroupMember addScheduleList(ScheduleList sl,
                                   javax.swing.tree.DefaultMutableTreeNode parentGroupNode)

Adds the specified ScheduleList to the TechnicalSystemGroup.

Parameters:

sl - the ScheduleList to add

parentGroupNode - the parent group node to add to. Make sure that this is a node of TechnicalSystemGroup. Let this to null in order to use the current selection.

Returns:

the GroupMember created

addTechnicalSystem

public GroupMember addTechnicalSystem()

Adds a TechnicalSystem to the current TechnicalSystemGroup.

Returns:

the GroupMember that was added

addTechnicalSystem

public GroupMember addTechnicalSystem(TechnicalSystem ts,
                                      javax.swing.tree.DefaultMutableTreeNode parentGroupNode)

Adds the specified TechnicalSystem to the current TechnicalSystemGroup.

Parameters:

ts - the TechnicalSystem to add

parentGroupNode - the parent group node to add to. Make sure that this is a node of TechnicalSystemGroup. Let this to null in order to use the current selection.

Returns:

the GroupMember that was added

addTechnicalSystemGroup

public GroupMember addTechnicalSystemGroup()

Adds a TechnicalSystemGroup to the current TechnicalSystemGroup.

Returns:

the GroupMember that was added

addTechnicalSystemGroup

public GroupMember addTechnicalSystemGroup(TechnicalSystemGroup tsg,
                                           javax.swing.tree.DefaultMutableTreeNode parentGroupNode)

Adds a TechnicalSystemGroup to the current TechnicalSystemGroup.

Parameters:

tsg - the TechnicalSystemGroup to add

parentGroupNode - the parent group node to add to. Make sure that this is a node of TechnicalSystemGroup. Let this to null in order to use the current selection.

Returns:

the GroupMember that was added

copyGroupMember

public void copyGroupMember(java.awt.Frame owner,
                            GroupMember groupMember2Copy)

Copies the specified GroupMember. If the Frame owner is specified, the user will be asked how many copies should be made. If not only one copy will be made.

Parameters:

owner - the owner

groupMember2Copy - the group member2 copy

See Also:

copyGroupMember(GroupMember, int)

copyGroupMember

public void copyGroupMember(GroupMember gm2Copy,
                            int noOfCopies)

Copies the specified GroupMember n times.

Parameters:

gm2Copy - the group member to copy

noOfCopies - the no of copies

removeGroupMember

public boolean removeGroupMember(GroupMember groupMember)

Removes the specified GroupMember from the current TechnicalSystemGroup.

Parameters:

groupMember - the group member

Returns:

true, if successful

updateTechnicalInterfacesAndStorageInformation

public void updateTechnicalInterfacesAndStorageInformation()

Update all EnergyInterface's and the storage information (capacity & load).

updateTechnicalInterfacesAndStorageInformation

public boolean updateTechnicalInterfacesAndStorageInformation(AbstractGroupEvaluationStrategy ages)

Updates all EnergyInterface's and the storage information (capacity & load). In case of evaluation execution this can cause concurrent exceptions because of a multiple request of an update within a short time range.

Parameters:

ages - the AbstractGroupEvaluationStrategy that is asking for the update.

Returns:

true, if changes has been made at the TechnicalInterfaces

update

public void update(java.util.Observable observable,
                   java.lang.Object updateObject)

This update method observes changes within the single TechnicalSystem's. Therefore, this GroupController added itself to each corresponding OptionModelController.

Specified by:

update in interface java.util.Observer

Parameters:

observable - the observable

updateObject - the update object