jmri.jmrit.revhistory.configurexml
Class FileHistoryXml

Show UML class diagram

java.lang.Object
  jmri.configurexml.AbstractXmlAdapter
      jmri.jmrit.revhistory.configurexml.FileHistoryXml

All Implemented Interfaces:

XmlAdapter

public class FileHistoryXml
extends AbstractXmlAdapter

Load/Store FileHistory objects.

This interacts somewhat differently with the ConfigureXML system. FileHistory objects are _not_ registed with the manager, but rather handled explicitly by them. The "load()" method is therefore a null-op here.

Field Summary

(package private) static int

defaultDepth

Constructor Summary

FileHistoryXml()

Method Summary

(package private) static org.jdom.Element	historyElement(FileHistory r, int depth)
boolean	load(org.jdom.Element e) Usual configurexml method, this one doesn't do anything because the content is explicitly loaded from the file
void	load(org.jdom.Element e, Object o) Create a set of configured objects from their XML description, using an auxiliary object.
boolean	loadDirectly(org.jdom.Element e) Load RevHistory from an element.
static FileHistory	loadFileHistory(org.jdom.Element e)
static void	loadOperation(FileHistory r, org.jdom.Element e)
(package private) static org.jdom.Element	operationElement(FileHistory.OperationMemo r, int depth)
org.jdom.Element	store(Object o) Store the
static org.jdom.Element	storeDirectly(Object o)

Methods inherited from class jmri.configurexml.AbstractXmlAdapter

creationErrorEncountered, getConfigXmlManager, loadDeferred, loadOrder, setConfigXmlManager

Methods inherited from class java.lang.Object

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

Field Detail

defaultDepth

static int defaultDepth

Constructor Detail

FileHistoryXml

public FileHistoryXml()

Method Detail

load

public boolean load(org.jdom.Element e)
             throws Exception

Usual configurexml method, this one doesn't do anything because the content is explicitly loaded from the file

Parameters:

e - Top-level XML element containing the description

Returns:

true if successful

Throws:

Exception - when a error prevents creating the objects as as required by the input XML.

loadDirectly

public boolean loadDirectly(org.jdom.Element e)
                     throws Exception

Load RevHistory from an element.

If no RevHistory already present in InstanceManager, creates one and adds this.

Then adds, instead of replacing, the history information

Throws:

Exception

loadFileHistory

public static FileHistory loadFileHistory(org.jdom.Element e)

loadOperation

public static void loadOperation(FileHistory r,
                                 org.jdom.Element e)

load

public void load(org.jdom.Element e,
                 Object o)
          throws Exception

Create a set of configured objects from their XML description, using an auxiliary object.

For example, the auxilary object o might be a manager or GUI of some type that needs to be informed as each object is created.

Parameters:

e - Top-level XML element containing the description

o - Implementation-specific Object needed for the conversion

Throws:

Exception - when a error prevents creating the objects as as required by the input XML.

store

public org.jdom.Element store(Object o)

Store the

Parameters:

o - The object to be recorded. Specific XmlAdapter implementations will require this to be of a specific type; that binding is done in ConfigXmlManager.

Returns:

The XML representation Element

storeDirectly

public static org.jdom.Element storeDirectly(Object o)

historyElement

static org.jdom.Element historyElement(FileHistory r,
                                       int depth)

operationElement

static org.jdom.Element operationElement(FileHistory.OperationMemo r,
                                         int depth)