jmri.configurexml
Class AbstractReporterManagerConfigXML

java.lang.Object
  extended by jmri.configurexml.AbstractReporterManagerConfigXML
All Implemented Interfaces:
XmlAdapter
Direct Known Subclasses:
LnReporterManagerXml

public abstract class AbstractReporterManagerConfigXML
extends Object
implements XmlAdapter

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.

Author:
Bob Jacobsen Copyright: Copyright (c) 2002

Constructor Summary
AbstractReporterManagerConfigXML()
           
 
Method Summary
abstract  void load(org.jdom.Element reporters)
          Create a ReporterManager object of the correct class, then register and fill it.
 void 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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface jmri.configurexml.XmlAdapter
load
 

Constructor Detail

AbstractReporterManagerConfigXML

public AbstractReporterManagerConfigXML()
Method Detail

store

public org.jdom.Element store(Object o)
Default implementation for storing the contents of a ReporterManager

Specified by:
store in interface XmlAdapter
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 void load(org.jdom.Element reporters)
Create a ReporterManager object of the correct class, then register and fill it.

Specified by:
load in interface XmlAdapter
Parameters:
reporters - Top level Element to unpack.

loadReporters

public void 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.


Copyright © 1997 - 2008 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: SourceForge_Logo