jmri.jmrit.logix.configurexml
Class WarrantManagerXml

java.lang.Object
  extended by jmri.configurexml.AbstractXmlAdapter
      extended by jmri.jmrit.logix.configurexml.WarrantManagerXml
All Implemented Interfaces:
XmlAdapter

public class WarrantManagerXml
extends AbstractXmlAdapter

Provides the abstract base and store functionality for configuring the CatalogTreeManager.

Typically, a subclass will just implement the load(Element catalogTree) class, relying on implementation here to load the individual CatalogTree objects.

Author:
Pete Cressman Copyright: Copyright (c) 2009

Constructor Summary
WarrantManagerXml()
           
 
Method Summary
 boolean load(Element warrants)
          Create a Warrant object of the correct class, then register and fill it.
 void load(Element element, Object o)
          Create a set of configured objects from their XML description, using an auxiliary object.
 int loadOrder()
          Used for determining which order to load items from XML files in.
 Element store(Object o)
          Store the contents of a WarrantManager.
 
Methods inherited from class jmri.configurexml.AbstractXmlAdapter
creationErrorEncountered, getConfigXmlManager, loadDeferred, setConfigXmlManager
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WarrantManagerXml

public WarrantManagerXml()
Method Detail

store

public Element store(Object o)
Store the contents of a WarrantManager.

Parameters:
o - Object to store, of type warrantManager
Returns:
Element containing the complete info

load

public boolean load(Element warrants)
Create a Warrant object of the correct class, then register and fill it.

Parameters:
warrants - Top level Element to unpack.
Returns:
true if successful

load

public void load(Element element,
                 Object o)
          throws Exception
Description copied from interface: XmlAdapter
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:
element - 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.

loadOrder

public int loadOrder()
Description copied from class: AbstractXmlAdapter
Used for determining which order to load items from XML files in.

Specified by:
loadOrder in interface XmlAdapter
Overrides:
loadOrder in class AbstractXmlAdapter


Copyright © 1997 - 2011 JMRI Community.
JMRI, DecoderPro, PanelPro, SoundPro, DispatcherPro and associated logos are our trademarks.

Additional information on copyright, trademarks and licenses is linked here.
Site hosted by: Get JMRI Model Railroad Interface at SourceForge.net. Fast, secure and Free Open Source software downloads