jmri.configurexml
Interface XmlAdapter

Show UML class diagram

All Known Implementing Classes:

AbstractAudioManagerConfigXML, AbstractConnectionConfigXml, AbstractLightManagerConfigXML, AbstractLightManagerConfigXML, AbstractMemoryManagerConfigXML, AbstractMemoryManagerConfigXML, AbstractNamedBeanManagerConfigXML, AbstractNetworkConnectionConfigXml, AbstractReporterManagerConfigXML, AbstractReporterManagerConfigXML, AbstractSensorManagerConfigXML, AbstractSensorManagerConfigXML, AbstractSerialConnectionConfigXml, AbstractSignalHeadManagerXml, AbstractSignalHeadManagerXml, AbstractTurnoutManagerConfigXML, AbstractTurnoutManagerConfigXML, AbstractXmlAdapter, AcelaLightManagerXml, AcelaSensorManagerXml, AcelaSignalHeadXml, AcelaTurnoutManagerXml, AnalogClock2DisplayXml, BlockBossLogicXml, BlockManagerXml, CbusSensorManagerXml, CbusTurnoutManagerXml, CommonTurnoutOperationXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ConnectionConfigXml, ControlPanelEditorXml, CreateButtonModelXml, CreateButtonPanelXml, Dcc4PcReporterManagerXml, Dcc4PcSensorManagerXml, DccLocoAddressXml, DccSignalHeadXml, DccSignalHeadXml, DccSignalMastXml, DefaultAudioManagerXml, DefaultConditionalManagerXml, DefaultConditionalManagerXml, DefaultJavaBeanConfigXML, DefaultLogixManagerXml, DefaultLogixManagerXml, DefaultMemoryManagerXml, DefaultMemoryManagerXml, DefaultRouteManagerXml, DefaultRouteManagerXml, DefaultSignalGroupManagerXml, DefaultSignalMastLogicManagerXml, DefaultSignalMastManagerXml, DefaultUserMessagePreferencesXml, DoubleTurnoutSignalHeadXml, DoubleTurnoutSignalHeadXml, EasyDccTurnoutManagerXml, EcosLocoAddressManagerXml, EcosPreferencesXml, EcosReporterManagerXml, EcosSensorManagerXml, EcosTurnoutManagerXml, EliteXNetTurnoutManagerXml, EntryExitPairsXml, FileHistoryXml, FileLocationPaneXml, GuiLafConfigPaneXml, GuiLafConfigPaneXml, IndicatorTrackIconXml, IndicatorTurnoutIconXml, InternalLightManagerXml, InternalReporterManagerXml, InternalSensorManagerXml, InternalSensorManagerXml, InternalTurnoutManagerXml, InternalTurnoutManagerXml, JMRIClientLightManagerXml, JMRIClientSensorManagerXml, JMRIClientTurnoutManagerXml, JmrixConfigPaneXml, LayoutBlockManagerXml, LayoutBlockManagerXml, LayoutEditorXml, LayoutEditorXml, LayoutMemoryIconXml, LayoutMemoryIconXml, LayoutPositionableLabelXml, LayoutPositionableLabelXml, LayoutReporterIconXml, LayoutReporterIconXml, LayoutSensorIconXml, LayoutSensorIconXml, LayoutSignalHeadIconXml, LayoutSignalHeadIconXml, LayoutSlipXml, LayoutTurnoutXml, LayoutTurnoutXml, LayoutTurntableXml, LayoutTurntableXml, LevelXingXml, LevelXingXml, LightIconXml, LinkingLabelXml, LNCPSignalMastXml, LnLightManagerXml, LnReporterManagerXml, LnSecurityElementManagerXml, LnSensorManagerXml, LnSensorManagerXml, LnTurnoutManagerXml, LocoAddressXml, LocoIconXml, LsDecSignalHeadXml, LsDecSignalHeadXml, ManagerDefaultsConfigPaneXml, ManagerDefaultSelectorXml, MarklinSensorManagerXml, MarklinTurnoutManagerXml, MemoryComboIconXml, MemoryIconXml, MemoryIconXml, MemoryInputIconXml, MemorySpinnerIconXml, MergConnectionConfigXml, MergSD2SignalHeadXml, MultiSensorIconXml, NceLightManagerXml, NceSensorManagerXml, NceTurnoutManagerXml, NoFeedbackTurnoutOperationXml, OBlockManagerXml, OlcbSensorManagerXml, OlcbTurnoutManagerXml, PanelEditorXml, PanelEditorXml, PerformActionModelXml, PerformActionPanelXml, PerformFileModelXml, PerformFilePanelXml, PerformScriptModelXml, PerformScriptPanelXml, PortalIconXml, PositionableCircleXml, PositionableEllipseXml, PositionableLabelXml, PositionablePointXml, PositionablePointXml, PositionablePolygonXml, PositionableRectangleXml, PositionableRoundRectXml, PositionableShapeXml, ProgrammerConfigPaneXml, ProxyTurnoutManagerXml, QuadOutputSignalHeadXml, RawTurnoutOperationXml, ReporterIconXml, RevHistoryXml, RfidReporterManagerXml, RfidSensorManagerXml, RosterConfigPaneXml, RpsPositionIconXml, RpsReporterManagerXml, RpsSensorManagerXml, SE8cSignalHeadXml, SE8cSignalHeadXml, SectionManagerXml, SecurityElementIconXml, SensorIconXml, SensorTurnoutOperationXml, SerialLightManagerXml, SerialLightManagerXml, SerialLightManagerXml, SerialLightManagerXml, SerialLightManagerXml, SerialLightManagerXml, SerialSensorManagerXml, SerialSensorManagerXml, SerialSensorManagerXml, SerialSensorManagerXml, SerialSensorManagerXml, SerialSensorManagerXml, SerialSignalHeadXml, SerialTurnoutManagerXml, SerialTurnoutManagerXml, SerialTurnoutManagerXml, SerialTurnoutManagerXml, SerialTurnoutManagerXml, SerialTurnoutManagerXml, SerialTurnoutManagerXml, SignalHeadIconXml, SignalHeadSignalMastXml, SignalMastIconXml, SimpleTimebaseXml, SingleTurnoutSignalHeadXml, SlipTurnoutIconXml, SpecificLightManagerXml, SpecificLightManagerXml, SpecificLightManagerXml, SpecificLightManagerXml, SpecificSensorManagerXml, SpecificSensorManagerXml, SpecificSensorManagerXml, SpecificSensorManagerXml, SprogTurnoutManagerXml, SRCPTurnoutManagerXml, SystemConsoleConfigPanelXml, TamsSensorManagerXml, TamsTurnoutManagerXml, TrackSegmentXml, TrackSegmentXml, TrainIconXml, TransitManagerXml, TripleTurnoutSignalHeadXml, TripleTurnoutSignalHeadXml, TurnoutIconXml, TurnoutOperationManagerXml, TurnoutOperationXml, TurnoutSignalMastXml, VirtualSignalHeadXml, VirtualSignalHeadXml, VirtualSignalMastXml, WarrantManagerXml, XNetLightManagerXml, XNetSensorManagerXml, XNetTurnoutManagerXml, XpaTurnoutManagerXml

public interface XmlAdapter

Interface assumed during configuration operations.

See Also:

ConfigXmlManager

Method Summary

void	creationErrorEncountered(String description, String systemName, String userName, Throwable exception) Invoke common handling of errors that happen during the "load" process.
boolean	load(org.jdom.Element e) Create a set of configured objects from their XML description
void	load(org.jdom.Element e, 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	setConfigXmlManager(ConfigXmlManager c)
org.jdom.Element	store(Object o) Store the

Method Detail

load

boolean load(org.jdom.Element e)
             throws Exception

Create a set of configured objects from their XML description

Parameters:

e - Top-level XML element containing the description

Returns:

true if successful

Throws:

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

loadDeferred

boolean loadDeferred()

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

Returns:

true to defer loading

Since:

2.11.2

load

void load(org.jdom.Element e,
          Object o)
          throws Exception

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:

e - Top-level XML element containing the description

o - Implementation-specific Object needed for the conversion

Throws:

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

store

org.jdom.Element store(Object o)

Store the

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.

Returns:

The XML representation Element

loadOrder

int loadOrder()

creationErrorEncountered

void creationErrorEncountered(String description,
                              String systemName,
                              String userName,
                              Throwable exception)
                              throws JmriConfigureXmlException

Invoke common handling of errors that happen during the "load" process. This is part of the interface to ensure that all the necessary classes provide it; eventually it will be coupled to a reporting mechanism of some sort.

Parameters:

description - description of error encountered

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

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

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

Throws:

JmriConfigureXmlException - in place for later expansion; should be propagated upward to higher-level error handling

setConfigXmlManager

void setConfigXmlManager(ConfigXmlManager c)