jmri.managers.configurexml
Class AbstractMemoryManagerConfigXML

java.lang.Object
  jmri.configurexml.AbstractXmlAdapter
      jmri.managers.configurexml.AbstractNamedBeanManagerConfigXML
          jmri.managers.configurexml.AbstractMemoryManagerConfigXML

All Implemented Interfaces:

XmlAdapter

Direct Known Subclasses:

AbstractMemoryManagerConfigXML, BlockManagerXml, DefaultMemoryManagerXml

public abstract class AbstractMemoryManagerConfigXML
extends AbstractNamedBeanManagerConfigXML

Provides the abstract base and store functionality for configuring MemoryManagers, working with AbstractMemoryManagers.

Typically, a subclass will just implement the load(Element memories) class, relying on implementation here to load the individual Memory objects. Note that these are stored explicitly, so the resolution mechanism doesn't need to see *Xml classes for each specific Memory or AbstractMemory subclass at store time.

Author:

Bob Jacobsen Copyright: Copyright (c) 2002, 2008

Constructor Summary

AbstractMemoryManagerConfigXML()

Method Summary

abstract boolean	load(Element memories) Create a MemoryManager 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.
void	loadMemories(Element memories) Utility method to load the individual Memory objects.
int	loadOrder() Used for determining which order to load items from XML files in.
abstract void	setStoreElementClass(Element memories) Subclass provides implementation to create the correct top element, including the type information.
Element	store(Object o) Default implementation for storing the contents of a MemoryManager

Methods inherited from class jmri.managers.configurexml.AbstractNamedBeanManagerConfigXML

getSystemName, getUserName, getUserName, loadCommon, storeCommon

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

AbstractMemoryManagerConfigXML

public AbstractMemoryManagerConfigXML()

Method Detail

store

public Element store(Object o)

Default implementation for storing the contents of a MemoryManager

Parameters:

o - Object to store, of type MemoryManager

Returns:

Element containing the complete info

setStoreElementClass

public abstract void setStoreElementClass(Element memories)

Subclass provides implementation to create the correct top element, including the type information. Default implementation is to use the local class here.

Parameters:

memories - The top-level element being created

load

public void load(Element element,
                 Object o)

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

load

public abstract boolean load(Element memories)
                      throws JmriConfigureXmlException

Create a MemoryManager object of the correct class, then register and fill it.

Parameters:

memories - Top level Element to unpack.

Returns:

true if successful

Throws:

JmriConfigureXmlException

loadMemories

public void loadMemories(Element memories)

Utility method to load the individual Memory objects. If there's no additional info needed for a specific Memory type, invoke this with the parent of the set of Memory elements.

Parameters:

memories - Element containing the Memory elements to load.

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