Package jmri.configurexml

Class AbstractXmlAdapter

java.lang.Object

jmri.configurexml.AbstractXmlAdapter

All Implemented Interfaces:

XmlAdapter

Direct Known Subclasses:

AbstractConnectionConfigXml, AbstractNamedBeanManagerConfigXML, BeanSwitchXml, BlockBossLogicProviderXml, ControlPanelEditorXml, CreateButtonModelXml, DccLocoAddressXml, DefaultJavaBeanConfigXML, DefaultUserMessagePreferencesXml, EcosPreferencesXml, EntryExitPairsXml, FileHistoryXml, FileLocationPaneXml, JmrixConfigPaneXml, LayoutEditorXml, LayoutShapeXml, LayoutTrackDrawingOptionsXml, LayoutTrackViewXml, LocoAddressXml, ManagerDefaultsConfigPaneXml, ManagerDefaultSelectorXml, MeterFrameManagerXml, OBlockManagerXml, PanelEditorXml, PerformActionModelXml, PerformFileModelXml, PerformScriptModelXml, PositionableLabelXml, PositionableShapeXml, ProgrammerConfigPaneXml, ProxyTurnoutManagerXml, RevHistoryXml, RosterConfigPaneXml, SampleFunctionalClassXml, ScriptButtonModelXml, SimpleTimebaseXml, StartupActionsPreferencesPanelXml, StartupPauseModelXml, SwitchboardEditorXml, SystemConsoleConfigPanelXml, TriggerRouteModelXml, TurnoutOperationManagerXml, TurnoutOperationXml, WarrantManagerXml

public abstract class AbstractXmlAdapter
extends Object
implements XmlAdapter

Abstract class to provide basic error handling for XmlAdapter

See Also:

• XmlAdapter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractXmlAdapter.EnumIO<T extends Enum<T>>	Base for support of Enum load/store to XML files.
static class	AbstractXmlAdapter.EnumIoMapped<T extends Enum<T>>	Support for Enum I/O to XML using explicit mapping.
static class	AbstractXmlAdapter.EnumIoNames<T extends Enum<T>>	Support for Enum I/O to XML using the enum's element names.
static class	AbstractXmlAdapter.EnumIoNamesNumbers<T extends Enum<T>>	Support for Enum I/O to XML using the enum's element names; for backward compatibility, it will also accept ordinal numbers when reading.
static class	AbstractXmlAdapter.EnumIoOrdinals<T extends Enum<T>>	Support for Enum I/O to XML using the enum's ordinal numbers in String form.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	STR_FALSE
static final String	STR_NO
static final String	STR_TRUE
static final String	STR_YES

Constructor Summary

Constructors

Constructor	Description
AbstractXmlAdapter()

Method Summary

Modifier and Type	Method	Description
final boolean	getAttributeBooleanValue(org.jdom2.Element element, String name, boolean def)	Service method to handle attribute input of boolean (true/yes vs false/no) values.
final double	getAttributeDoubleValue(org.jdom2.Element element, String name, double def)	Service method to handle attribute input of double values.
final float	getAttributeFloatValue(org.jdom2.Element element, String name, float def)	Service method to handle attribute input of float values.
final int	getAttributeIntegerValue(org.jdom2.Element element, String name, int def)	Service method to handle attribute input of integer values.
ErrorHandler	getExceptionHandler()	Get the current error handler.
void	handleException(String description, String operation, String systemName, String userName, Exception exception)	Provide a simple handler for errors.
boolean	load(org.jdom2.Element e)	Create a set of configured objects from their XML description
void	load(org.jdom2.Element e, Object o)	Create a set of configured objects from their XML description, using an auxiliary object.
boolean	load(org.jdom2.Element shared, org.jdom2.Element perNode)	Create a set of configured objects from their XML description.
void	load(org.jdom2.Element shared, org.jdom2.Element perNode, Object o)	Create a set of configured objects from their XML description, using an auxiliary object.
boolean	loadDeferred()	Determine if this set of configured objects should be loaded after basic GUI construction is completed.
int	loadOrder()
void	setExceptionHandler(ErrorHandler errorHandler)	Set the error handler that will handle any errors encountered while parsing the XML.
org.jdom2.Element	store(Object o, boolean shared)	Store the object in XML

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

store

Field Details

STR_TRUE

public static final String STR_TRUE

See Also:

• Constant Field Values

STR_FALSE

public static final String STR_FALSE

See Also:

• Constant Field Values

STR_YES

public static final String STR_YES

See Also:

• Constant Field Values

STR_NO

public static final String STR_NO

See Also:

• Constant Field Values

Constructor Details

AbstractXmlAdapter

public AbstractXmlAdapter()

Method Details

handleException

public void handleException(String description,
 String operation,
 String systemName,
 String userName,
 Exception exception)

Provide a simple handler for errors. Calls the configured ErrorHandler with an ErrorMemo created using the provided parameters.

Specified by:

handleException in interface XmlAdapter

Parameters:

description - description of error encountered

operation - the operation being performed, may be null

systemName - system name of bean being handled, may be null

userName - user name of the bean being handled, may be null

exception - Any exception being handled in the processing, may be null

load

public boolean load(org.jdom2.Element e)
             throws JmriConfigureXmlException

Create a set of configured objects from their XML description

Specified by:

load in interface XmlAdapter

Parameters:

e - Top-level XML element containing the description

Returns:

true if successful

Throws:

JmriConfigureXmlException - when a error prevents creating the objects as as required by the input XML.

load

public void load(org.jdom2.Element e,
 Object o)
          throws JmriConfigureXmlException

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

Parameters:

e - Top-level XML element containing the description

o - Implementation-specific Object needed for the conversion

Throws:

JmriConfigureXmlException - when a error prevents creating the objects as as required by the input XML

load

public boolean load(@Nonnull
 org.jdom2.Element shared,
 org.jdom2.Element perNode)
             throws JmriConfigureXmlException

Create a set of configured objects from their XML description.

Specified by:

load in interface XmlAdapter

Parameters:

shared - Top-level XML element containing the common, multi-node elements of the description

perNode - Top-level XML element containing the private, single-node elements of the description

Returns:

true if successful

Throws:

JmriConfigureXmlException - when a error prevents creating the objects as as required by the input XML

load

public void load(@Nonnull
 org.jdom2.Element shared,
 org.jdom2.Element perNode,
 Object o)
          throws JmriConfigureXmlException

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

Parameters:

shared - Top-level XML element containing the common description

perNode - Top-level XML element containing the per-node description

o - Implementation-specific Object needed for the conversion

Throws:

JmriConfigureXmlException - when a error prevents creating the objects as as required by the input XML

loadDeferred

public boolean loadDeferred()

Determine if this set of configured objects should be loaded after basic GUI construction is completed.

Default behavior is to load when requested. Classes that should wait until basic GUI is constructed should override this method and return true

Specified by:

loadDeferred in interface XmlAdapter

Returns:

true to defer loading

Since:

2.11.2

See Also:

• XmlAdapter.loadDeferred()

loadOrder

public int loadOrder()

Specified by:

loadOrder in interface XmlAdapter

store

public org.jdom2.Element store(@Nonnull
 Object o,
 boolean shared)

Store the object in XML

Specified by:

store in interface XmlAdapter

Parameters:

o - The object to be recorded. Specific XmlAdapter implementations will require this to be of a specific type; that binding is done in ConfigXmlManager.

shared - true if the returned element should be the common XML and false if the returned element should be per-node.

Returns:

The XML representation Element

setExceptionHandler

public void setExceptionHandler(ErrorHandler errorHandler)

Set the error handler that will handle any errors encountered while parsing the XML. If not specified, the default error handler will be used.

Specified by:

setExceptionHandler in interface XmlAdapter

Parameters:

errorHandler - the error handler or null to ignore parser errors

getExceptionHandler

public ErrorHandler getExceptionHandler()

Get the current error handler.

Specified by:

getExceptionHandler in interface XmlAdapter

Returns:

the error handler or null if no error handler is assigned

getAttributeBooleanValue

public final boolean getAttributeBooleanValue(@Nonnull
 org.jdom2.Element element,
 @Nonnull
 String name,
 boolean def)

Service method to handle attribute input of boolean (true/yes vs false/no) values. Not being present is not an error. Not parsing (which shouldn't happen due to the XML Schema checks) invokes the default error handler.

Parameters:

element - the element to parse.

name - element attribute name.

def - default value if name not present in element.

Returns:

boolean value of attribute, else default if not present or error.

getAttributeIntegerValue

public final int getAttributeIntegerValue(@Nonnull
 org.jdom2.Element element,
 @Nonnull
 String name,
 int def)

Service method to handle attribute input of integer values. Not being present is not an error. Not parsing (which shouldn't happen due to the XML Schema checks) invokes the default error handler.

Parameters:

element - the element to parse.

name - element attribute name.

def - default value if name not present in element.

Returns:

integer value of attribute, else default if not present or error.

getAttributeDoubleValue

public final double getAttributeDoubleValue(@Nonnull
 org.jdom2.Element element,
 @Nonnull
 String name,
 double def)

Service method to handle attribute input of double values. Not being present is not an error. Not parsing (which shouldn't happen due to the XML Schema checks) invokes the default error handler.

Parameters:

element - the element to parse.

name - element attribute name.

def - default value if name not present in element.

Returns:

double value of attribute, else default if not present or error.

getAttributeFloatValue

public final float getAttributeFloatValue(@Nonnull
 org.jdom2.Element element,
 @Nonnull
 String name,
 float def)

Service method to handle attribute input of float values. Not being present is not an error. Not parsing (which shouldn't happen due to the XML Schema checks) invokes the default error handler.

Parameters:

element - the element to parse.

name - element attribute name.

def - default value if name not present in element.

Returns:

float value of attribute, else default if not present or error.