jmri.configurexml
Class AbstractLightManagerConfigXML

java.lang.Object
  jmri.configurexml.AbstractLightManagerConfigXML

All Implemented Interfaces:

XmlAdapter

Direct Known Subclasses:

AcelaLightManagerXml, LnLightManagerXml, SerialLightManagerXml, SerialLightManagerXml, SerialLightManagerXml, SerialLightManagerXml, SerialLightManagerXml, SerialLightManagerXml, XNetLightManagerXml

public abstract class AbstractLightManagerConfigXML
extends Object
implements XmlAdapter

Provides the abstract base and store functionality for configuring LightManagers, working with AbstractLightManagers.

Typically, a subclass will just implement the load(Element sensors) class, relying on implementation here to load the individual lights. Note that these are stored explicitly, so the resolution mechanism doesn't need to see *Xml classes for each specific Light or AbstractLight subclass at store time.

Based on AbstractSensorManagerConfigXML.java

Author:

Dave Duchamp Copyright (c) 2004

Constructor Summary

AbstractLightManagerConfigXML()

Method Summary

abstract void	load(org.jdom.Element lights) Create a LightManager object of the correct class, then register and fill it.
void	loadLights(org.jdom.Element lights) Utility method to load the individual Light objects.
abstract void	setStoreElementClass(org.jdom.Element lights) 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 LightManager

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

AbstractLightManagerConfigXML

public AbstractLightManagerConfigXML()

Method Detail

store

public org.jdom.Element store(Object o)

Default implementation for storing the contents of a LightManager

Specified by:

store in interface XmlAdapter

Parameters:

o - Object to store, of type LightManager

Returns:

Element containing the complete info

setStoreElementClass

public abstract void setStoreElementClass(org.jdom.Element lights)

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

Parameters:

lights - The top-level element being created

load

public abstract void load(org.jdom.Element lights)

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

Specified by:

load in interface XmlAdapter

Parameters:

lights - Top level Element to unpack.

loadLights

public void loadLights(org.jdom.Element lights)

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

Parameters:

lights - Element containing the Light elements to load.