Class XMLArchiver

java.lang.Object

common.xml.XMLArchiver

All Implemented Interfaces:

GuiXMLConstants

public class XMLArchiver
extends Object
implements GuiXMLConstants

Title: XML Archiver

Description: Used to save and load model information to be used for the simulation and for the save/load capability.

Author:

Bertoli Marco Date: 22-lug-2005 Time: 13.47.51

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XML_ARCHIVE_A_JMT_VERSION	Archive root attribute holding the JMT version that saved the file.

Fields inherited from interface GuiXMLConstants

XML_A_CLASS_COLOR, XML_A_CLASS_NAME, XML_A_CONNECTION_SOURCE, XML_A_CONNECTION_TARGET, XML_A_FIELD_NAME, XML_A_FIELD_VALUE, XML_A_PARAMETRIC_CLASSPATH, XML_A_PARAMETRIC_ENABLED, XML_A_POINT_X, XML_A_POINT_Y, XML_A_POSITION_ANGLE, XML_A_POSITION_ROTATE, XML_A_POSITION_X, XML_A_POSITION_Y, XML_A_SOURCE_X, XML_A_SOURCE_Y, XML_A_STATION_NAME, XML_A_TARGET_X, XML_A_TARGET_Y, XML_ARCHIVE_A_NAME, XML_ARCHIVE_A_TIMESTAMP, XML_ARCHIVE_DOCUMENT_ROOT, XML_ARCHIVE_DOCUMENT_XSD, XML_DOCUMENT_ROOT, XML_DOCUMENT_XSD, XML_E_ARC, XML_E_CLASS, XML_E_CONNECTION_SHAPE, XML_E_FIELD, XML_E_PARAMETRIC, XML_E_POINT, XML_E_POSITION, XML_E_SOURCE, XML_E_STATION, XML_E_TARGET

Constructor Summary

Constructors

Constructor	Description
XMLArchiver()

Method Summary

Modifier and Type	Method	Description
static Document	getDocument(CommonModel model, String documentName)	Returns a new Archive XML Document used to store simulation and GUI data
static Element	getGuiFromArchiveDocument(Document archive)	Returns a Gui information data Element, given an input archive in Document format.
static Element	getResultsFromArchiveDocument(Document archive)	Returns Results information data Element, given an input archive in Document format.
static Element	getSimFromArchiveDocument(Document archive)	Returns a simulation data Element, given an input archive in Document format.
static void	loadModel(File archiveName, CommonModel model)	Loads an archive into specified CommonModel.
static void	saveModel(File archiveName, CommonModel model)	Saves JMT Archive storing informations for simulator and for the gui

Methods inherited from class Object

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

Field Details

XML_ARCHIVE_A_JMT_VERSION

public static final String XML_ARCHIVE_A_JMT_VERSION

Archive root attribute holding the JMT version that saved the file. Mirrored in legacyxml.LegacyXmlExporter.

See Also:

• Constant Field Values

Constructor Details

XMLArchiver

public XMLArchiver()

Method Details

saveModel

public static void saveModel(File archiveName,
 CommonModel model)

Saves JMT Archive storing informations for simulator and for the gui

Parameters:

archiveName - Handler to the archive to be created

model - data structure

loadModel

public static void loadModel(File archiveName,
 CommonModel model)

Loads an archive into specified CommonModel. If CommonModel is a JMODELModel, loads gui informations too.

Parameters:

archiveName - name of the archive to be opened

model - CommonModel where all loaded informations should be stored Modified by Francesco D'Aquino

getDocument

public static Document getDocument(CommonModel model,
 String documentName)

Returns a new Archive XML Document used to store simulation and GUI data

Parameters:

model - data structure

documentName - name of created document (to be set into root element)

Returns:

created Document

getSimFromArchiveDocument

public static Element getSimFromArchiveDocument(Document archive)

Returns a simulation data Element, given an input archive in Document format.

Parameters:

archive - Document of an archive

Returns:

Element of corresponding simulation data

getGuiFromArchiveDocument

public static Element getGuiFromArchiveDocument(Document archive)

Returns a Gui information data Element, given an input archive in Document format.

Parameters:

archive - Document of an archive

Returns:

Element of corresponding gui informations

getResultsFromArchiveDocument

public static Element getResultsFromArchiveDocument(Document archive)

Returns Results information data Element, given an input archive in Document format.

Parameters:

archive - Document of an archive

Returns:

Element of corresponding results informations