Package jmri.jmrit.consisttool

Class ConsistFile

java.lang.Object

jmri.jmrit.XmlFile

jmri.jmrit.consisttool.ConsistFile

All Implemented Interfaces:

PropertyChangeListener, EventListener

Direct Known Subclasses:

WiFiConsistFile

public class ConsistFile
extends XmlFile
implements PropertyChangeListener

Handle saving/restoring consist information to XML files. This class manipulates files conforming to the consist-roster-config DTD.

Nested Class Summary

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

XmlFile.Validate

Field Summary

Fields

Modifier and Type	Field	Description
protected ConsistManager	consistMan

Fields inherited from class jmri.jmrit.XmlFile

dtdLocation, xsltLocation

Constructor Summary

Constructors

Constructor	Description
ConsistFile()

Method Summary

Modifier and Type	Method	Description
static String	defaultConsistFilename()	Get the filename for the default Consist file, including location.
static String	getFileLocation()	GetFile Location.
void	propertyChange(PropertyChangeEvent evt)
void	readConsistLocoList(org.jdom2.Element consist, Consist newConsist)
void	readFile()	Read all consists from the default file name.
void	readFile(String fileName)	Read all consists from a file.
void	writeFile(List<LocoAddress> consistList)	Write all consists to the default file name.
void	writeFile(List<LocoAddress> consistList, String fileName)	Write all consists to a file.

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

consistMan

protected ConsistManager consistMan

Constructor Details

ConsistFile

public ConsistFile()

Method Details

readConsistLocoList

public void readConsistLocoList(org.jdom2.Element consist,
 Consist newConsist)

readFile

public void readFile()
              throws org.jdom2.JDOMException,
IOException

Read all consists from the default file name.

Throws:

org.jdom2.JDOMException - if unable to parse consists

IOException - if unable to read file

readFile

public void readFile(String fileName)
              throws org.jdom2.JDOMException,
IOException

Read all consists from a file.

Parameters:

fileName - path to file

Throws:

org.jdom2.JDOMException - if unable to parse consists

IOException - if unable to read file

writeFile

public void writeFile(List<LocoAddress> consistList)
               throws IOException

Write all consists to the default file name.

Parameters:

consistList - list of consist addresses

Throws:

IOException - if unable to write file

writeFile

public void writeFile(List<LocoAddress> consistList,
 String fileName)
               throws IOException

Write all consists to a file.

Parameters:

consistList - list of consist addresses

fileName - path to file

Throws:

IOException - if unable to write file

getFileLocation

public static String getFileLocation()

GetFile Location.

Returns:

the preferences subdirectory in which Consist Files are kept this is relative to the roster files location.

defaultConsistFilename

public static String defaultConsistFilename()

Get the filename for the default Consist file, including location.

Returns:

the filename

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Specified by:

propertyChange in interface PropertyChangeListener