Package jmri.managers.configurexml

Class DefaultRouteManagerXml

java.lang.Object

jmri.configurexml.AbstractXmlAdapter

jmri.managers.configurexml.AbstractNamedBeanManagerConfigXML

jmri.managers.configurexml.DefaultRouteManagerXml

All Implemented Interfaces:

XmlAdapter

public class DefaultRouteManagerXml
extends AbstractNamedBeanManagerConfigXML

Provides the functionality for configuring RouteManagers.

Nested Class Summary

Nested classes/interfaces inherited from class jmri.configurexml.AbstractXmlAdapter

AbstractXmlAdapter.EnumIO<T extends java.lang.Enum<T>>, AbstractXmlAdapter.EnumIoMapped<T extends java.lang.Enum<T>>, AbstractXmlAdapter.EnumIoNames<T extends java.lang.Enum<T>>, AbstractXmlAdapter.EnumIoNamesNumbers<T extends java.lang.Enum<T>>, AbstractXmlAdapter.EnumIoOrdinals<T extends java.lang.Enum<T>>

Field Summary

Fields inherited from class jmri.managers.configurexml.AbstractNamedBeanManagerConfigXML

STR_CLASS, STR_COMMENT, STR_KEY, STR_PROPERTIES, STR_PROPERTY, STR_SYSTEM_NAME, STR_USER_NAME, STR_VALUE

Fields inherited from class jmri.configurexml.AbstractXmlAdapter

STR_FALSE, STR_NO, STR_TRUE, STR_YES

Constructor Summary

Constructors

Constructor	Description
DefaultRouteManagerXml()

Method Summary

Modifier and Type	Method	Description
boolean	load(org.jdom2.Element sharedRoutes, org.jdom2.Element perNodeRoutes)	Create a RouteManager object of the correct class, then register and fill it.
int	loadOrder()
void	loadRoutes(org.jdom2.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(org.jdom2.Element routes)	Subclass provides implementation to create the correct top element, including the type information.
org.jdom2.Element	store(java.lang.Object o)	Default implementation for storing the contents of a RouteManager.

Methods inherited from class jmri.managers.configurexml.AbstractNamedBeanManagerConfigXML

checkedNamedBeanHandle, checkedNamedBeanName, checkedNamedBeanReference, checkNameNormalization, getAttributeBool, getAttributeString, getSystemName, getUserName, getUserName, loadComment, loadComment, loadCommon, loadInAdapter, loadProperties, storeComment, storeCommon, storeProperties, storeUserName

Methods inherited from class jmri.configurexml.AbstractXmlAdapter

getAttributeBooleanValue, getAttributeDoubleValue, getAttributeFloatValue, getAttributeIntegerValue, getExceptionHandler, handleException, load, load, load, loadDeferred, setExceptionHandler, store

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 org.jdom2.Element store(java.lang.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(org.jdom2.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 boolean load(org.jdom2.Element sharedRoutes,
                    org.jdom2.Element perNodeRoutes)

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

Specified by:

load in interface XmlAdapter

Overrides:

load in class AbstractXmlAdapter

Parameters:

sharedRoutes - Top level Element to unpack.

perNodeRoutes - unused.

Returns:

true if successful

loadRoutes

public void loadRoutes(org.jdom2.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

Specified by:

loadOrder in interface XmlAdapter

Overrides:

loadOrder in class AbstractXmlAdapter