jmri.managers.configurexml
Class AbstractReporterManagerConfigXML

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

All Implemented Interfaces:

XmlAdapter

Direct Known Subclasses:

AbstractReporterManagerConfigXML, Dcc4PcReporterManagerXml, EcosReporterManagerXml, InternalReporterManagerXml, LnReporterManagerXml, RfidReporterManagerXml, RpsReporterManagerXml

public abstract class AbstractReporterManagerConfigXML
extends AbstractNamedBeanManagerConfigXML

Provides the abstract base and store functionality for configuring ReporterManagers, working with AbstractReporterManagers.

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

Field Summary

(package private) static org.slf4j.Logger

log

Constructor Summary

AbstractReporterManagerConfigXML()

Method Summary

abstract boolean	load(org.jdom.Element reporters) Create a ReporterManager object of the correct class, then register and fill it.
int	loadOrder() Used for determining which order to load items from XML files in.
boolean	loadReporters(org.jdom.Element reporters) Utility method to load the individual Reporter objects.
abstract void	setStoreElementClass(org.jdom.Element reporters) Subclass provides implementation to create the correct top element, including the type information.
org.jdom.Element	store(Object o) Default implementation for storing the contents of a ReporterManager

Methods inherited from class jmri.managers.configurexml.AbstractNamedBeanManagerConfigXML

getAttributeBool, getAttributeString, getSystemName, getUserName, getUserName, loadComment, loadComment, loadCommon, loadProperties, storeComment, storeCommon, storeProperties, storeUserName

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

Methods inherited from interface jmri.configurexml.XmlAdapter

load

Field Detail

log

static org.slf4j.Logger log

Constructor Detail

AbstractReporterManagerConfigXML

public AbstractReporterManagerConfigXML()

Method Detail

store

public org.jdom.Element store(Object o)

Default implementation for storing the contents of a ReporterManager

Parameters:

o - Object to store, of type ReporterManager

Returns:

Element containing the complete info

setStoreElementClass

public abstract void setStoreElementClass(org.jdom.Element reporters)

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

Parameters:

reporters - The top-level element being created

load

public abstract boolean load(org.jdom.Element reporters)

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

Parameters:

reporters - Top level Element to unpack.

Returns:

true if successful

loadReporters

public boolean loadReporters(org.jdom.Element reporters)

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

Parameters:

reporters - Element containing the Reporter elements to load.

Returns:

true if successful

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