energy.persistence

Class ScheduleList_StorageHandler

java.lang.Object

energy.persistence.ScheduleList_StorageHandler

All Implemented Interfaces:

PersistenceService, PersistenceServiceScheduleList

public class ScheduleList_StorageHandler
extends java.lang.Object
implements PersistenceServiceScheduleList

The Class ScheduleList_StorageHandler provides methods that allow to save or open descriptions and energy option models from a XML file. It also provides methods that allow to handle this information as string.

Constructor Summary

Constructors

Constructor and Description
ScheduleList_StorageHandler()

Method Summary

Modifier and Type	Method and Description
static void	convertToListSchedule(Schedule treeSchedule) Converts the specified Schedule, that should be a tree schedule, to a list schedule .
static void	convertToListScheduleList(ScheduleList treeScheduleList) Converts the specified ScheduleList to a list schedule list.
static void	convertToTreeSchedule(Schedule listSchedule) Converts the specified Schedule, that should be a list schedule, to a tree schedule .
static void	convertToTreeScheduleList(ScheduleList listScheduleList) Converts the specified ScheduleList to a tree schedule list.
int	getIndexPositionOfMenuItem() Has to return a desired index position for the JMenuItem to be returned through the current implementation.
javax.swing.JMenuItem	getJMenueItem(PersistenceHandler.PersistenceAction action) Has to return a JMenuItem for the specified persistence action.
java.lang.String	getScheduleListAsBase64String(ScheduleList treeScheduleList) Returns a ScheduleList instance as base64 string.
java.lang.String	getScheduleListAsXMLString(ScheduleList scheduleList) Returns the model of a technical system group as XML-string.
ScheduleList	getScheduleListFromBase64String(java.lang.String base64EncodedModel) Returns a ScheduleList from a base64 encoded string.
ScheduleList	getScheduleListFromCSVFile(java.io.File scheduleFile, ScheduleController scheduleController) Loads a ScheduleList from a CSV file.
ScheduleList	getScheduleListFromSOMFile(java.io.File scheduleFile) Returns the ScheduleList from the specified file.
ScheduleList	getScheduleListFromXMLFile(java.io.File scheduleListFile) Load model from a XML file.
ScheduleList	getScheduleListFromXMLString(java.lang.String xmlString) Gets the ScheduleList from a XML string.
ScheduleList	loadScheduleList(ScheduleController sc, java.awt.Component invoker) Load a ScheduleList.
ScheduleList	loadScheduleList(ScheduleController sc, java.io.File fileToLoad, java.awt.Component invoker) Loads a ScheduleList.
ScheduleList	loadScheduleListFromFile(java.io.File technicalSystemFile, ScheduleController scheduleController) Load ScheduleList from file.
boolean	saveScheduleList(ScheduleController sc, ScheduleList slSave, java.awt.Component invoker) Save the specified ScheduleList.
boolean	saveScheduleListAs(ScheduleController sc, ScheduleList slSaveAs, java.awt.Component invoker) Save as the specified ScheduleList.
boolean	saveScheduleListAsCsvFile(java.io.File csvFile, ScheduleList scheduleList, ScheduleController scheduleController, Schedule selectedSchedule) Saves a ScheduleList as a CSV file.
boolean	saveScheduleListAsFile(java.io.File scheduleListFile, ScheduleList scheduleList, ScheduleController scheduleController, Schedule selectedSchedule) Save ScheduleList as file.
boolean	saveScheduleListAsSOMFile(java.io.File technicalSystemFile, ScheduleList scheduleList) Saves an Instance of a ScheduleList as TXT file.
boolean	saveScheduleListAsXMLFile(java.io.File scheduleFile, ScheduleList scheduleList) Saves an Instance of a ScheduleList as XML file.
java.io.File	selectFile(java.awt.Component parentComponent, java.lang.String caption, boolean allowNewFolder) Select file to load or save TechnicalSystemGroup information.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScheduleList_StorageHandler

public ScheduleList_StorageHandler()

Method Detail

getJMenueItem

public javax.swing.JMenuItem getJMenueItem(PersistenceHandler.PersistenceAction action)

Description copied from interface: PersistenceService

Has to return a JMenuItem for the specified persistence action.

It is NOT required to add an ActionListener to the menu item, since the PersistenceHandler will manage to invoke the required actions.

Specified by:

getJMenueItem in interface PersistenceService

Parameters:

action - the persistence action that has to be executed with the returning menu item

Returns:

the appropriate JMenuItem for the given use case and action

getIndexPositionOfMenuItem

public int getIndexPositionOfMenuItem()

Description copied from interface: PersistenceService

Has to return a desired index position for the JMenuItem to be returned through the current implementation.

Specified by:

getIndexPositionOfMenuItem in interface PersistenceService

Returns:

the index position of the menu item

See Also:

#getJMenueItem(PersistenceAction)

loadScheduleList

public ScheduleList loadScheduleList(ScheduleController sc,
                                     java.awt.Component invoker)

Description copied from interface: PersistenceServiceScheduleList

Load a ScheduleList.

Specified by:

loadScheduleList in interface PersistenceServiceScheduleList

Parameters:

sc - the current ScheduleController

invoker - the invoker component

Returns:

the schedule list

loadScheduleList

public ScheduleList loadScheduleList(ScheduleController sc,
                                     java.io.File fileToLoad,
                                     java.awt.Component invoker)

Loads a ScheduleList.

Parameters:

sc - the current ScheduleController

fileToLoad - the file to load (may be null. If file selection will be shown)

invoker - the invoker component

Returns:

the ScheduleList

saveScheduleList

public boolean saveScheduleList(ScheduleController sc,
                                ScheduleList slSave,
                                java.awt.Component invoker)

Description copied from interface: PersistenceServiceScheduleList

Save the specified ScheduleList.

Specified by:

saveScheduleList in interface PersistenceServiceScheduleList

Parameters:

sc - the current ScheduleController

slSave - the ScheduleList to save

invoker - the invoker component

Returns:

true, if successful

saveScheduleListAs

public boolean saveScheduleListAs(ScheduleController sc,
                                  ScheduleList slSaveAs,
                                  java.awt.Component invoker)

Description copied from interface: PersistenceServiceScheduleList

Save as the specified ScheduleList.

Specified by:

saveScheduleListAs in interface PersistenceServiceScheduleList

Parameters:

sc - the current ScheduleController

slSaveAs - the ScheduleList to save-as

invoker - the invoker component

Returns:

true, if successful

selectFile

public java.io.File selectFile(java.awt.Component parentComponent,
                               java.lang.String caption,
                               boolean allowNewFolder)

Select file to load or save TechnicalSystemGroup information.

Parameters:

parentComponent - the parent component

caption - the caption

allowNewFolder - the allow new folder

Returns:

the selected file instance

loadScheduleListFromFile

public ScheduleList loadScheduleListFromFile(java.io.File technicalSystemFile,
                                             ScheduleController scheduleController)

Load ScheduleList from file.

Parameters:

technicalSystemFile - the technical system file

Returns:

the TechnicalSystemGroup

saveScheduleListAsFile

public boolean saveScheduleListAsFile(java.io.File scheduleListFile,
                                      ScheduleList scheduleList,
                                      ScheduleController scheduleController,
                                      Schedule selectedSchedule)

Save ScheduleList as file.

Parameters:

scheduleListFile - the technical system file

scheduleList - the ScheduleList

selectedSchedule - the currently selected schedule

Returns:

true, if successful

getScheduleListFromXMLFile

public ScheduleList getScheduleListFromXMLFile(java.io.File scheduleListFile)

Load model from a XML file.

Parameters:

scheduleListFile - the file of the schedule

Returns:

the technical system instance

saveScheduleListAsXMLFile

public boolean saveScheduleListAsXMLFile(java.io.File scheduleFile,
                                         ScheduleList scheduleList)

Saves an Instance of a ScheduleList as XML file.

Parameters:

scheduleFile - the file to that the model has be saved

scheduleList - the schedule list

Returns:

true, if successful

getScheduleListFromXMLString

public ScheduleList getScheduleListFromXMLString(java.lang.String xmlString)

Gets the ScheduleList from a XML string.

Parameters:

xmlString - the XML string

Returns:

the ScheduleList from the XML string

getScheduleListAsXMLString

public java.lang.String getScheduleListAsXMLString(ScheduleList scheduleList)

Returns the model of a technical system group as XML-string.

Parameters:

scheduleList - the instance of the technical system group

Returns:

the model as string

getScheduleListFromSOMFile

public ScheduleList getScheduleListFromSOMFile(java.io.File scheduleFile)

Returns the ScheduleList from the specified file.

Parameters:

scheduleFile - the file of ScheduleList

Returns:

the ScheduleList from the *.som file

saveScheduleListAsSOMFile

public boolean saveScheduleListAsSOMFile(java.io.File technicalSystemFile,
                                         ScheduleList scheduleList)

Saves an Instance of a ScheduleList as TXT file.

Parameters:

technicalSystemFile - the file to that the model has be saved

scheduleList - the Schedule List

Returns:

true, if successful

getScheduleListAsBase64String

public java.lang.String getScheduleListAsBase64String(ScheduleList treeScheduleList)

Returns a ScheduleList instance as base64 string.

Parameters:

treeScheduleList - the technical system

Returns:

the model as base64 string

getScheduleListFromBase64String

public ScheduleList getScheduleListFromBase64String(java.lang.String base64EncodedModel)

Returns a ScheduleList from a base64 encoded string.

Parameters:

base64EncodedModel - the base64 encoded model

Returns:

the ScheduleList from the specified base64 string

getScheduleListFromCSVFile

public ScheduleList getScheduleListFromCSVFile(java.io.File scheduleFile,
                                               ScheduleController scheduleController)

Loads a ScheduleList from a CSV file.

Parameters:

scheduleFile - The CSV file

Returns:

The imported ScheduleList

saveScheduleListAsCsvFile

public boolean saveScheduleListAsCsvFile(java.io.File csvFile,
                                         ScheduleList scheduleList,
                                         ScheduleController scheduleController,
                                         Schedule selectedSchedule)

Saves a ScheduleList as a CSV file.

Parameters:

csvFile - The target file

scheduleList - The ScheduleList instance to be saved

scheduleController - The scheduleController

selectedSchedule - The currently selected schedule

Returns:

true, if successful

convertToTreeScheduleList

public static void convertToTreeScheduleList(ScheduleList listScheduleList)

Converts the specified ScheduleList to a tree schedule list.

Parameters:

listScheduleList - the schedule list to convert

convertToTreeSchedule

public static void convertToTreeSchedule(Schedule listSchedule)

Converts the specified Schedule, that should be a list schedule, to a tree schedule .

Parameters:

listSchedule - the list schedule

convertToListScheduleList

public static void convertToListScheduleList(ScheduleList treeScheduleList)

Converts the specified ScheduleList to a list schedule list.

Parameters:

treeScheduleList - the schedule list to convert

convertToListSchedule

public static void convertToListSchedule(Schedule treeSchedule)

Converts the specified Schedule, that should be a tree schedule, to a list schedule .

Parameters:

treeSchedule - the tree schedule