Package jmri.jmrix.openlcb.configurexml

Class OlcbEventNameStoreXml

java.lang.Object

jmri.jmrit.XmlFile

jmri.jmrix.openlcb.configurexml.OlcbEventNameStoreXml

public final class OlcbEventNameStoreXml
extends XmlFile

JMRI's implementation of part of the OpenLcb EventNameStore interface persistance

Nested Class Summary

Nested classes/interfaces inherited from class jmri.jmrit.XmlFile

XmlFile.Validate

Field Summary

Fields

Modifier and Type	Field	Description
(package private) String	baseFileName
(package private) OlcbEventNameStore	nameStore

Fields inherited from class jmri.jmrit.XmlFile

dtdLocation, xsltLocation

Constructor Summary

Constructors

Constructor	Description
OlcbEventNameStoreXml(OlcbEventNameStore nameStore, String baseFileName)

Method Summary

Modifier and Type	Method	Description
void	load()
void	migrateFromIdTagStore()	The original implementation of this store was via the IdTagManager class.
void	store()

Methods inherited from class jmri.jmrit.XmlFile

addDefaultInfo, backupFileName, checkFile, createFileNameWithDate, dumpElement, findFile, getBuilder, getDefaultDtdLocation, getDefaultValidate, getDtdLocation, getProcessingInstructionHRef, getProcessingInstructionType, getRoot, getValidate, makeBackupFile, makeBackupFile, newDocument, newDocument, revertBackupFile, rootFromFile, rootFromInputStream, rootFromName, rootFromURL, setDefaultDtdLocation, setDefaultValidate, setDtdLocation, setValidate, userFileChooser, userFileChooser, writeXML, xmlDir

Methods inherited from class java.lang.Object

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

Field Details

nameStore

OlcbEventNameStore nameStore

baseFileName

String baseFileName

Constructor Details

OlcbEventNameStoreXml

public OlcbEventNameStoreXml(OlcbEventNameStore nameStore,
 String baseFileName)

Method Details

migrateFromIdTagStore

public void migrateFromIdTagStore()

The original implementation of this store was via the IdTagManager class. This is now viewed as a mistake. This method takes names stored in the IdTagManager and migrates them to the dedicated local store.

Note when this actually migrates, it opens and loads the IdTag Manager which can result in name confusion when Reporters are later created by a panel file. If this has already happened, the internal reporters generated by that have to be removed before this migration takes place. This means that there's no real good place to run this as part of JMRI startup. Instead, it's left as a public method so it can (when needed) be invoked by e.g. a script after the name clean up has been done.

store

public void store()
           throws IOException

Throws:

IOException

load

public void load()