Package jmri.managers.configurexml

Class DefaultSectionManagerXml

java.lang.Object

jmri.configurexml.AbstractXmlAdapter

jmri.managers.configurexml.AbstractNamedBeanManagerConfigXML

jmri.managers.configurexml.DefaultSectionManagerXml

All Implemented Interfaces:

XmlAdapter

public class DefaultSectionManagerXml
extends AbstractNamedBeanManagerConfigXML

Provides the functionality for persistence of a SectionManager.

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
DefaultSectionManagerXml()

Method Summary

Modifier and Type	Method	Description
void	load(org.jdom2.Element element, java.lang.Object o)	Create a set of configured objects from their XML description, using an auxiliary object.
boolean	load(org.jdom2.Element sharedSections, org.jdom2.Element perNodeSections)	Create a SectionManager object of the correct class, then register and fill it.
int	loadOrder()
void	loadSections(org.jdom2.Element sharedSections, org.jdom2.Element perNodeSections)	Utility method to load the individual Section objects.
void	setStoreElementClass(org.jdom2.Element sections)	Subclass provides implementation to create the correct top element, including the type information.
org.jdom2.Element	store(java.lang.Object o)	Implementation for storing the contents of a SectionManager.

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, loadDeferred, setExceptionHandler, store

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultSectionManagerXml

public DefaultSectionManagerXml()

Method Detail

store

public org.jdom2.Element store(java.lang.Object o)

Implementation for storing the contents of a SectionManager.

Parameters:

o - Object to store, of type SectionManager

Returns:

Element containing the complete info

setStoreElementClass

public void setStoreElementClass(org.jdom2.Element sections)

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

Parameters:

sections - The top-level element being created

load

public void load(org.jdom2.Element element,
                 java.lang.Object o)

Description copied from class: AbstractXmlAdapter

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.

Specified by:

load in interface XmlAdapter

Overrides:

load in class AbstractXmlAdapter

Parameters:

element - Top-level XML element containing the description

o - Implementation-specific Object needed for the conversion

load

public boolean load(org.jdom2.Element sharedSections,
                    org.jdom2.Element perNodeSections)

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

Specified by:

load in interface XmlAdapter

Overrides:

load in class AbstractXmlAdapter

Parameters:

sharedSections - Top level Element to unpack.

perNodeSections - Per-node Element to unpack.

Returns:

true if successful

loadSections

public void loadSections(org.jdom2.Element sharedSections,
                         org.jdom2.Element perNodeSections)

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

Parameters:

sharedSections - Element containing the Section elements to load.

perNodeSections - Per-node Element containing the Section elements to load.

loadOrder

public int loadOrder()

Description copied from class: AbstractXmlAdapter

Specified by:

loadOrder in interface XmlAdapter

Overrides:

loadOrder in class AbstractXmlAdapter