jmri.managers.configurexml
Class DefaultRouteManagerXml

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

All Implemented Interfaces:

XmlAdapter

Direct Known Subclasses:

DefaultRouteManagerXml

public class DefaultRouteManagerXml
extends AbstractNamedBeanManagerConfigXML

Provides the functionality for configuring RouteManagers

Author:

Dave Duchamp Copyright (c) 2004, Daniel Boudreau Copyright (c) 2007, Simon Reader Copyright (C) 2008

Constructor Summary

DefaultRouteManagerXml()

Method Summary

boolean	load(Element routes) Create a RouteManager 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.
void	loadRoutes(Element routes) Utility method to load the individual Route objects.
protected void	replaceRouteManager() Replace the current RouteManager, if there is one, with one newly created during a load operation.
void	setStoreElementClass(Element routes) 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 RouteManager

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

DefaultRouteManagerXml

public DefaultRouteManagerXml()

Method Detail

store

public Element store(Object o)

Default implementation for storing the contents of a RouteManager

Parameters:

o - Object to store, of type RouteManager

Returns:

Element containing the complete info

setStoreElementClass

public void setStoreElementClass(Element routes)

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

Parameters:

routes - 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 boolean load(Element routes)

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

Parameters:

routes - Top level Element to unpack.

Returns:

true if successful

loadRoutes

public void loadRoutes(Element routes)

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

Parameters:

routes - Element containing the Route elements to load.

replaceRouteManager

protected void replaceRouteManager()

Replace the current RouteManager, if there is one, with one newly created during a load operation. This is skipped if the present one is already of the right type

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