energy.persistence

Class TechnicalSystem_StorageHandler

java.lang.Object

energy.persistence.TechnicalSystem_StorageHandler

All Implemented Interfaces:

PersistenceService, PersistenceServiceTechnicalSystem

public class TechnicalSystem_StorageHandler
extends java.lang.Object
implements PersistenceServiceTechnicalSystem

The Class TechnicalSystem_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.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TECHNICAL_SYSTEM_FILE_ENCODING
static java.lang.String	TECHNICAL_SYSTEM_FILE_SUFFIX_EOM
static java.lang.String	TECHNICAL_SYSTEM_FILE_SUFFIX_XML

Constructor Summary

Constructors

Constructor and Description
TechnicalSystem_StorageHandler()

Method Summary

Modifier and Type	Method and Description
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	getTechnicalSystemAsBase64String(TechnicalSystem technicalSystem) Returns a TechnicalSystem instance as base64 string.
java.lang.String	getTechnicalSystemAsXMLString(TechnicalSystem technicalSystem) Returns the model of a technical system as XML-string.
TechnicalSystem	getTechnicalSystemFromBase64String(java.lang.String base64EncodedModel) Returns a TechnicalSystem from a base64 string.
TechnicalSystem	getTechnicalSystemFromEOMFile(java.io.File technicalSystemFile) Gets the technical system from eom file.
TechnicalSystem	getTechnicalSystemFromXMLFile(java.io.File technicalSystemFile) Load model from a XML file.
TechnicalSystem	getTechnicalSystemFromXMLString(java.lang.String xmlString) Gets the technical system from a XML string.
TechnicalSystem	loadModelFromFile(java.io.File technicalSystemFile) Load model from file.
TechnicalSystem	loadTechnicalSystem(OptionModelController omc, java.awt.Component invoker) Load a TechnicalSystem.
TechnicalSystem	loadTechnicalSystem(OptionModelController omc, java.io.File fileToLoad, java.awt.Component invoker) Loads a technical system.
boolean	saveModelAsFile(java.io.File technicalSystemFile, TechnicalSystem technicalSystem) Save model as file.
boolean	saveTechnicalSystem(OptionModelController omc, TechnicalSystem tsSave, java.awt.Component invoker) Save a TechnicalSystem.
boolean	saveTechnicalSystemAs(OptionModelController omc, TechnicalSystem tsSaveAs, java.awt.Component invoker) Save as the specified TechnicalSystem.
boolean	saveTechnicalSystemAsEOMFile(java.io.File technicalSystemFile, TechnicalSystem technicalSystem) Saves an Instance of a TechnicalSystem as TXT file.
boolean	saveTechnicalSystemAsXMLFile(java.io.File technicalSystemFile, TechnicalSystem technicalSystem) Saves an Instance of a TechnicalSystem as XML file.
java.io.File	selectFile(java.awt.Component parentComponent, java.lang.String caption, boolean allowNewFolder) Select file to load or save TechnicalSystem information.

Methods inherited from class java.lang.Object

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

Field Detail

TECHNICAL_SYSTEM_FILE_ENCODING

public static final java.lang.String TECHNICAL_SYSTEM_FILE_ENCODING

See Also:

Constant Field Values

TECHNICAL_SYSTEM_FILE_SUFFIX_XML

public static final java.lang.String TECHNICAL_SYSTEM_FILE_SUFFIX_XML

See Also:

Constant Field Values

TECHNICAL_SYSTEM_FILE_SUFFIX_EOM

public static final java.lang.String TECHNICAL_SYSTEM_FILE_SUFFIX_EOM

See Also:

Constant Field Values

Constructor Detail

TechnicalSystem_StorageHandler

public TechnicalSystem_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)

loadTechnicalSystem

public TechnicalSystem loadTechnicalSystem(OptionModelController omc,
                                           java.awt.Component invoker)

Description copied from interface: PersistenceServiceTechnicalSystem

Load a TechnicalSystem.

Specified by:

loadTechnicalSystem in interface PersistenceServiceTechnicalSystem

Parameters:

omc - the current OptionModelController

invoker - the invoker component

Returns:

the technical system

loadTechnicalSystem

public TechnicalSystem loadTechnicalSystem(OptionModelController omc,
                                           java.io.File fileToLoad,
                                           java.awt.Component invoker)

Loads a technical system.

Parameters:

omc - the current OptionModelController

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

invoker - the invoker component

Returns:

the Technical system

saveTechnicalSystem

public boolean saveTechnicalSystem(OptionModelController omc,
                                   TechnicalSystem tsSave,
                                   java.awt.Component invoker)

Description copied from interface: PersistenceServiceTechnicalSystem

Save a TechnicalSystem.

Specified by:

saveTechnicalSystem in interface PersistenceServiceTechnicalSystem

Parameters:

omc - the current OptionModelController

tsSave - the TechnicalSystem to save

invoker - the invoker component

Returns:

true, if successful

saveTechnicalSystemAs

public boolean saveTechnicalSystemAs(OptionModelController omc,
                                     TechnicalSystem tsSaveAs,
                                     java.awt.Component invoker)

Description copied from interface: PersistenceServiceTechnicalSystem

Save as the specified TechnicalSystem.

Specified by:

saveTechnicalSystemAs in interface PersistenceServiceTechnicalSystem

Parameters:

omc - the current OptionModelController

tsSaveAs - the TechnicalSystem 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 TechnicalSystem information.

Parameters:

parentComponent - the parent component

caption - the caption

allowNewFolder - the allow new folder

Returns:

the selected file instance

loadModelFromFile

public TechnicalSystem loadModelFromFile(java.io.File technicalSystemFile)

Load model from file.

Parameters:

technicalSystemFile - the technical system file

Returns:

the TechnicalSystem

saveModelAsFile

public boolean saveModelAsFile(java.io.File technicalSystemFile,
                               TechnicalSystem technicalSystem)

Save model as file.

Parameters:

technicalSystemFile - the technical system file

technicalSystem - the technical system

Returns:

true, if successful

getTechnicalSystemFromXMLFile

public TechnicalSystem getTechnicalSystemFromXMLFile(java.io.File technicalSystemFile)

Load model from a XML file.

Parameters:

technicalSystemFile - the file of the technical system

Returns:

the technical system instance

saveTechnicalSystemAsXMLFile

public boolean saveTechnicalSystemAsXMLFile(java.io.File technicalSystemFile,
                                            TechnicalSystem technicalSystem)

Saves an Instance of a TechnicalSystem as XML file.

Parameters:

technicalSystemFile - the file to that the model has be saved

technicalSystem - the technical system

Returns:

true, if successful

getTechnicalSystemFromXMLString

public TechnicalSystem getTechnicalSystemFromXMLString(java.lang.String xmlString)

Gets the technical system from a XML string.

Parameters:

xmlString - the XML string

Returns:

the technical system from a XML string

getTechnicalSystemAsXMLString

public java.lang.String getTechnicalSystemAsXMLString(TechnicalSystem technicalSystem)

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

Parameters:

technicalSystem - the instance of the technical system

Returns:

the model as string

getTechnicalSystemFromEOMFile

public TechnicalSystem getTechnicalSystemFromEOMFile(java.io.File technicalSystemFile)

Gets the technical system from eom file.

Parameters:

technicalSystemFile - the technical system file

Returns:

the technical system from eom file

saveTechnicalSystemAsEOMFile

public boolean saveTechnicalSystemAsEOMFile(java.io.File technicalSystemFile,
                                            TechnicalSystem technicalSystem)

Saves an Instance of a TechnicalSystem as TXT file.

Parameters:

technicalSystemFile - the file to that the model has be saved

technicalSystem - the technical system

Returns:

true, if successful

getTechnicalSystemAsBase64String

public java.lang.String getTechnicalSystemAsBase64String(TechnicalSystem technicalSystem)

Returns a TechnicalSystem instance as base64 string.

Parameters:

technicalSystem - the technical system

Returns:

the model as base64 string

getTechnicalSystemFromBase64String

public TechnicalSystem getTechnicalSystemFromBase64String(java.lang.String base64EncodedModel)

Returns a TechnicalSystem from a base64 string.

Parameters:

base64EncodedModel - the base64 encoded model

Returns:

the model from base64 string