jmri.managers.configurexml
Class AbstractSensorManagerConfigXML

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

All Implemented Interfaces:

XmlAdapter

Direct Known Subclasses:

AbstractSensorManagerConfigXML, AcelaSensorManagerXml, CbusSensorManagerXml, Dcc4PcSensorManagerXml, EcosSensorManagerXml, InternalSensorManagerXml, JMRIClientSensorManagerXml, LnSensorManagerXml, MarklinSensorManagerXml, NceSensorManagerXml, OlcbSensorManagerXml, RfidSensorManagerXml, RpsSensorManagerXml, SerialSensorManagerXml, SerialSensorManagerXml, SerialSensorManagerXml, SerialSensorManagerXml, SerialSensorManagerXml, SerialSensorManagerXml, TamsSensorManagerXml, XNetSensorManagerXml

public abstract class AbstractSensorManagerConfigXML
extends AbstractNamedBeanManagerConfigXML

Provides the abstract base and store functionality for configuring SensorManagers, working with AbstractSensorManagers.

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

Field Summary

(package private) static org.slf4j.Logger

log

Constructor Summary

AbstractSensorManagerConfigXML()

Method Summary

abstract boolean	load(org.jdom.Element sensors) Create a SensorManager 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	loadSensors(org.jdom.Element sensors) Utility method to load the individual Sensor objects.
abstract void	setStoreElementClass(org.jdom.Element sensors) 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 SensorManager
org.jdom.Element	store(Object o, org.jdom.Element sensors)

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

AbstractSensorManagerConfigXML

public AbstractSensorManagerConfigXML()

Method Detail

store

public org.jdom.Element store(Object o)

Default implementation for storing the contents of a SensorManager

Parameters:

o - Object to store, of type SensorManager

Returns:

Element containing the complete info

store

public org.jdom.Element store(Object o,
                              org.jdom.Element sensors)

setStoreElementClass

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

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

Parameters:

sensors - The top-level element being created

load

public abstract boolean load(org.jdom.Element sensors)
                      throws JmriConfigureXmlException

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

Parameters:

sensors - Top level Element to unpack.

Returns:

true if successful

Throws:

JmriConfigureXmlException

loadSensors

public boolean loadSensors(org.jdom.Element sensors)
                    throws JmriConfigureXmlException

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

Parameters:

sensors - Element containing the Sensor elements to load.

Returns:

true if succeeded

Throws:

JmriConfigureXmlException

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