energy.schedule

Class ScheduleController

java.lang.Object

java.util.Observable

energy.schedule.ScheduleController

All Implemented Interfaces:

EomController

public class ScheduleController
extends java.util.Observable
implements EomController

The Class ScheduleController manages the List of available Schedules.

Constructor Summary

Constructors

Constructor and Description
ScheduleController() Instantiates a new schedule controller.

Method Summary

Modifier and Type	Method and Description
java.io.File	getCurrentFile() Has to return the file object that is currently open in the controller.
java.lang.String	getDomainByInterfaceID(java.lang.String interfaceID) Gets the domain by interface ID.
GlobalInfo	getGlobalInfo() Returns the GlobalInfo.
TechnicalSystemStateEvaluation	getInitialTechnicalSystemStateEvaluation(Schedule schedule) Returns the initial TechnicalSystemStateEvaluation that is specified with the given Schedule.
TechnicalSystemStateEvaluation	getInitialTechnicalSystemStateEvaluation(TechnicalSystemStateEvaluation tsseLast) Returns the initial TechnicalSystemStateEvaluation that is specified with the parent of the given TechnicalSystemStateEvaluation.
static InterfaceSetting	getInterfaceSetting(java.util.List<InterfaceSetting> interfaceSettingList, java.lang.String interfaceID) Returns, if available, the interface setting that is specified by the interfaceID.
ObjectFactory	getObjectFactory() Returns the object factory for the option model.
OptionModelController	getOptionModelController() Returns the option model controller.
ScheduleList	getScheduleList() Returns the current ScheduleList.
ScheduleList	getScheduleListCopy() Returns a copied instance of the current ScheduleList and will reset the database IDs of the instances.
java.lang.String	getScheduleListDescription() Returns the ScheduleList description that consists of the network and the system ID.
ScheduleSelectionModel	getSelectionModel() Returns the current selection model.
static AbstractStorageCapacity	getStorageCapacity(java.util.List<AbstractStorageCapacity> storageCapacityList, java.lang.String domain) Returns the storage capacity for the specified domain, if available.
boolean	hasConfigurationErrors() Returns if the ScheduleList has configuration errors.
boolean	hasScheduleListChanged() Checks if the ScheduleList has changed.
boolean	isClosable(java.awt.Component parentComponent) Checks and return if the current controller and its open file is closable.
boolean	isEmptyScheduleList() Checks if the ScheduleList is an empty one.
void	loadScheduleList(java.io.File fileToLoad, java.awt.Component parentComponnt) Loads a ScheduleList into the current ScheduleController.
static void	printScheduleTimeStamps(Schedule scheduleToPrint) Prints all time stamps from the specified Schedule.
static void	printScheduleTimeStamps(Schedule scheduleToPrint, int maxStatesToPrint) Prints the number of 'maxStatesToPrint' time stamps from the specified Schedule.
void	resetScheduleList() Resets the model.
boolean	saveScheduleList(java.awt.Component parentComponent) Saves the current ScheduleList to the file specified in getCurrentFile().
boolean	saveScheduleListAs(java.awt.Component parentComponent) Save the current ScheduleList with an user interaction for choosing a file location.
void	setChangedAndNotifyObservers(java.lang.Object notification) Sets the current state to changed and notifies all observers in one step.
void	setConfigurationErrors(boolean configurationErrors) Sets that the current ScheduleList has configuration errors or not.
void	setCurrentFile(java.io.File currentFile) Sets the current file.
void	setInitialSelection() Sets the initial selection.
void	setNetworkID(java.lang.String newNetworkID) Sets the network ID of the current ScheduleList.
void	setOptionModelController(OptionModelController omc2Use) Sets the current OptionModelController.
void	setScheduleList(ScheduleList schedulelist) Sets the current ScheduleList.
void	setScheduleList(ScheduleList schedulelist, boolean setReminder) Sets the current ScheduleList.
void	setScheduleListReminder() Sets the technical system reminder in order to recognise changes in the model later on.
void	setSystemID(java.lang.String newSystemID) Sets the system ID of the current ScheduleList.
java.lang.String	toString()

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

ScheduleController

public ScheduleController()

Instantiates a new schedule 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

getOptionModelController

public OptionModelController getOptionModelController()

Returns the option model controller.

Returns:

the option model controller

setOptionModelController

public void setOptionModelController(OptionModelController omc2Use)

Sets the current OptionModelController.

Parameters:

omc2Use - the new option model controller

getGlobalInfo

public GlobalInfo getGlobalInfo()

Returns the GlobalInfo.

Returns:

the global info

getObjectFactory

public ObjectFactory getObjectFactory()

Returns the object factory for the option model.

Returns:

the object factory

getSelectionModel

public ScheduleSelectionModel 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

loadScheduleList

public void loadScheduleList(java.io.File fileToLoad,
                             java.awt.Component parentComponnt)

Loads a ScheduleList into the current ScheduleController.

Parameters:

fileToLoad - the file to load

parentComponnt - the parent component (may be null)

saveScheduleList

public boolean saveScheduleList(java.awt.Component parentComponent)

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

Parameters:

parentComponent - the parent component (may be null)

Returns:

true, if successful

See Also:

getCurrentFile(), setCurrentFile(File)

saveScheduleListAs

public boolean saveScheduleListAs(java.awt.Component parentComponent)

Save the current ScheduleList with an user interaction for choosing a file location.

Parameters:

parentContainer - the parent component

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

hasScheduleListChanged

public boolean hasScheduleListChanged()

Checks if the ScheduleList has changed.

Returns:

true, if the ScheduleList has changed

setScheduleListReminder

public void setScheduleListReminder()

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

resetScheduleList

public void resetScheduleList()

Resets the model.

getScheduleList

public ScheduleList getScheduleList()

Returns the current ScheduleList.

Returns:

the ScheduleList

setScheduleList

public void setScheduleList(ScheduleList schedulelist)

Sets the current ScheduleList.

Parameters:

schedulelist - the new ScheduleList

setScheduleList

public void setScheduleList(ScheduleList schedulelist,
                            boolean setReminder)

Sets the current ScheduleList.

Parameters:

schedulelist - the new ScheduleList

setReminder - the set reminder

getScheduleListCopy

public ScheduleList getScheduleListCopy()

Returns a copied instance of the current ScheduleList and will reset the database IDs of the instances.

Returns:

the ScheduleList copy

isEmptyScheduleList

public boolean isEmptyScheduleList()

Checks if the ScheduleList is an empty one.

Returns:

true, if the ScheduleList is empty

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

hasConfigurationErrors

public boolean hasConfigurationErrors()

Returns if the ScheduleList has configuration errors.

Returns:

true, if there are configuration errors

setConfigurationErrors

public void setConfigurationErrors(boolean configurationErrors)

Sets that the current ScheduleList has configuration errors or not.

Parameters:

configurationErrors - the new value configuration errors

setSystemID

public void setSystemID(java.lang.String newSystemID)

Sets the system ID of the current ScheduleList.

Parameters:

newSystemID - the new system ID

setNetworkID

public void setNetworkID(java.lang.String newNetworkID)

Sets the network ID of the current ScheduleList.

Parameters:

newNetworkID - the new network ID

getScheduleListDescription

public java.lang.String getScheduleListDescription()

Returns the ScheduleList description that consists of the network and the system ID.

Returns:

the schedule list description

getDomainByInterfaceID

public java.lang.String getDomainByInterfaceID(java.lang.String interfaceID)

Gets the domain by interface ID.

Parameters:

interfaceID - the interface ID

Returns:

the domain by interface ID

getInitialTechnicalSystemStateEvaluation

public TechnicalSystemStateEvaluation getInitialTechnicalSystemStateEvaluation(Schedule schedule)

Returns the initial TechnicalSystemStateEvaluation that is specified with the given Schedule.

Parameters:

schedule - the schedule

Returns:

the initial technical system state evaluation

getInitialTechnicalSystemStateEvaluation

public TechnicalSystemStateEvaluation getInitialTechnicalSystemStateEvaluation(TechnicalSystemStateEvaluation tsseLast)

Returns the initial TechnicalSystemStateEvaluation that is specified with the parent of the given TechnicalSystemStateEvaluation.

Parameters:

tsseLast - the last TechnicalSystemStateEvaluation of a Schedule

Returns:

the initial technical system state evaluation

getStorageCapacity

public static AbstractStorageCapacity getStorageCapacity(java.util.List<AbstractStorageCapacity> storageCapacityList,
                                                         java.lang.String domain)

Returns the storage capacity for the specified domain, if available.

Parameters:

storageCapacityList - the storage capacity list

domain - the domain

Returns:

the storage capacity

getInterfaceSetting

public static InterfaceSetting getInterfaceSetting(java.util.List<InterfaceSetting> interfaceSettingList,
                                                   java.lang.String interfaceID)

Returns, if available, the interface setting that is specified by the interfaceID.

Parameters:

interfaceSettingList - the interface setting list

interfaceID - the interface id

Returns:

the interface setting

printScheduleTimeStamps

public static void printScheduleTimeStamps(Schedule scheduleToPrint)

Prints all time stamps from the specified Schedule.

Parameters:

scheduleToPrint - the schedule to print

printScheduleTimeStamps

public static void printScheduleTimeStamps(Schedule scheduleToPrint,
                                           int maxStatesToPrint)

Prints the number of 'maxStatesToPrint' time stamps from the specified Schedule.

Parameters:

scheduleToPrint - the schedule to print

maxStatesToPrint - the max states to print. Set -1 if you want to print all