Package jmri.jmrit.roster

Class RosterEntry

java.lang.Object

jmri.beans.UnboundBean

jmri.beans.Bean

jmri.beans.ArbitraryBean

jmri.jmrit.roster.RosterEntry

All Implemented Interfaces:

BasicRosterEntry, BeanInterface, PropertyChangeFirer, PropertyChangeProvider, RosterObject

public class RosterEntry
extends ArbitraryBean
implements RosterObject, BasicRosterEntry

RosterEntry represents a single element in a locomotive roster, including information on how to locate it from decoder information.

The RosterEntry is the central place to find information about a locomotive's configuration, including CV and "programming variable" information. RosterEntry handles persistence through the LocoFile class. Creating a RosterEntry does not necessarily read the corresponding file (which might not even exist), please see readFile(), writeFile() member functions.

All the data attributes have a content, not null. FileName, however, is special. A null value for it indicates that no physical file is (yet) associated with this entry.

When the filePath attribute is non-null, the user has decided to organize the roster into directories.

Each entry can have one or more "Attributes" associated with it. These are (key, value) pairs. The key has to be unique, and currently both objects have to be Strings.

All properties, including the "Attributes", are bound.

See Also:

• LocoFile

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_comment
protected String	_dateUpdated
protected String	_dccAddress
protected String	_decoderComment
protected String	_decoderFamily
protected String	_decoderModel
protected String	_developerID
protected String	_fileName
protected String	_iconFilePath
protected String	_id
protected String	_imageFilePath
protected String	_isShuntingOn
protected String	_manufacturerID
protected String	_maxFnNum
protected int	_maxSpeedPCT
protected String	_mfg
protected String	_model
protected String	_owner
protected String	_productID
protected String	_programmingModes
protected LocoAddress.Protocol	_protocol
protected String	_roadName
protected String	_roadNumber
protected RosterSpeedProfile	_sp
protected String	_URL
static final String	ATTRIBUTE_DELETED
static final String	ATTRIBUTE_LAST_OPERATED
static final String	ATTRIBUTE_OPERATING_DURATION
static final String	ATTRIBUTE_UPDATED
protected final TreeMap<String,String>	attributePairs
static final String	COMMENT
static final String	DATE_UPDATED
protected Date	dateModified
static final String	DCC_ADDRESS
static final String	DECODER_COMMENT
static final String	DECODER_DEVELOPERID
static final String	DECODER_FAMILY
static final String	DECODER_MANUFACTURERID
static final String	DECODER_MAXFNNUM
static final String	DECODER_MODEL
static final String	DECODER_MODES
static final String	DECODER_PRODUCTID
static final String	DEFAULT_MAXFNNUM
static final String	FILENAME
static final String	FUNCTION_IMAGE
static final String	FUNCTION_LABEL
static final String	FUNCTION_LOCKABLE
static final String	FUNCTION_SELECTED_IMAGE
protected Map<Integer,String>	functionImages
protected Map<Integer,String>	functionLabels
protected Map<Integer,Boolean>	functionLockables
protected Map<Integer,String>	functionSelectedImages
protected Map<Integer,Boolean>	functionVisibles
static final String	ICON_FILE_PATH
static final String	ID
static final String	IMAGE_FILE_PATH
(package private) String	indent
(package private) int	indentWidth
(package private) boolean	loadedOnce
static final String	LONG_ADDRESS
static final String	MAX_SPEED
static final String	MFG
static final String	MODEL
(package private) String	newLine
(package private) int	openCounter
static final String	OWNER
static final String	PROGRAMMING
static final String	PROTOCOL
static final String	ROADNAME
static final String	SHUNTING_FUNCTION
static final String	SOUND_LABEL
protected Map<Integer,String>	soundLabels
static final String	SPEED_PROFILE
static final String	URL

Fields inherited from class jmri.beans.ArbitraryBean

arbitraryPropertySupport

Fields inherited from class jmri.beans.Bean

propertyChangeSupport

Constructor Summary

Constructors

Constructor	Description
RosterEntry()	Construct a blank object.
RosterEntry(String fileName)	Constructor based on a given file name.
RosterEntry(RosterEntry pEntry, String pID)	Constructor based on a given RosterEntry object and name/ID.
RosterEntry(org.jdom2.Element e)	Construct this Entry from XML.

Method Summary

Modifier and Type	Method	Description
void	changeDateUpdated()	Mark the date updated, e.g. from storing this roster entry.
void	deleteAttribute(String key)
void	ensureFilenameExists()	Ensure the entry has a valid filename.
static RosterEntry	fromFile(File file)	Create a RosterEntry from a file.
String	getAttribute(String key)
String[]	getAttributeList()
Set<String>	getAttributes()	Provide access to the set of attributes.
String	getComment()
Date	getDateModified()
String	getDateUpdated()	Get the date this entry was last modified.
String	getDccAddress()
DccLocoAddress	getDccLocoAddress()
String	getDecoderComment()
String	getDecoderFamily()
String	getDecoderModel()
String	getDeveloperID()
String	getDisplayName()	Get the formatted single-line String for displaying the object.
String	getFileName()
String	getFunctionImage(int fn)
String	getFunctionLabel(int fn)	If a label has been defined for a specific function, return it, otherwise return null.
boolean	getFunctionLockable(int fn)	Return the lockable/latchable state of a specific function.
String	getFunctionSelectedImage(int fn)
boolean	getFunctionVisible(int fn)	Return the UI visibility of a specific function button.
List<RosterGroup>	getGroups()	List the roster groups this entry is a member of, returning existing RosterGroups from the default Roster if they exist.
List<RosterGroup>	getGroups(Roster roster)	List the roster groups this entry is a member of, returning existing RosterGroups from the specified Roster if they exist.
String	getIconPath()
String	getId()
String	getImagePath()
String	getManufacturerID()
String	getMaxFnNum()
int	getMaxFnNumAsInt()	Get the highest valid Fn key number for this roster entry.
int	getMaxSpeedPCT()
String	getMfg()
String	getModel()
String	getOwner()
String	getPathName()
String	getProductID()
String	getProgrammingModes()	Get the modes as defined in a roster entry's decoder definition.
LocoAddress.Protocol	getProtocol()
String	getProtocolAsString()
String	getRoadName()
String	getRoadNumber()
String	getShuntingFunction()
String	getSoundLabel(int fn)	If a label has been defined for a specific sound, return it, otherwise return null.
RosterSpeedProfile	getSpeedProfile()
String	getURL()
boolean	isLongAddress()
boolean	isOpen()
void	loadAttributes(org.jdom2.Element e3)	Load attribute key/value pairs from a JDOM element.
void	loadCvModel(VariableTableModel varModel, CvTableModel cvModel)	Load pre-existing Variable and CvTableModel object with the contents of this entry.
void	loadFunctions(org.jdom2.Element e3)	Load function names from a JDOM element.
void	loadFunctions(org.jdom2.Element e3, String source)	Loads function names from a JDOM element.
void	loadSounds(org.jdom2.Element e3, String source)	Loads sound names from a JDOM element.
void	printEntry(HardcopyWriter w)
void	printEntryDetails(Writer w)	Print the roster entry information.
void	printEntryLine(HardcopyWriter w)	Ultra-compact list view of roster entries.
void	putAttribute(String key, String value)
void	readFile()	Read a file containing the contents of this RosterEntry.
void	setComment(String s)
void	setDateModified(String date)	Set the date modified given a string representing a date.
void	setDateModified(Date date)
protected void	setDateUpdated(String s)	Set the date last updated.
void	setDccAddress(String s)
void	setDecoderComment(String s)
void	setDecoderFamily(String s)
void	setDecoderModel(String s)
void	setDeveloperID(String s)
void	setFileName(String s)	Set the file name for this roster entry.
void	setFunctionImage(int fn, String s)
void	setFunctionLabel(int fn, String label)	Set the label for a specific function.
void	setFunctionLockable(int fn, boolean lockable)	Define whether a specific function is lockable.
void	setFunctionSelectedImage(int fn, String s)
void	setFunctionVisible(int fn, boolean visible)	Define whether a specific function button is visible.
void	setIconPath(String s)
void	setId(String s)	Set the roster ID for this roster entry.
void	setImagePath(String s)
void	setLongAddress(boolean b)
void	setManufacturerID(String s)
void	setMaxFnNum(String s)
void	setMaxSpeedPCT(int maxSpeedPCT)
void	setMfg(String s)
void	setModel(String s)
void	setOpen(boolean boo)
void	setOwner(String s)
void	setProductID(String s)
void	setProgrammingModes(String s)	Set programming modes as defined in a roster entry's decoder definition.
void	setProtocol(LocoAddress.Protocol protocol)
void	setRoadName(String s)
void	setRoadNumber(String s)
void	setShuntingFunction(String fn)
void	setSoundLabel(int fn, String label)	Define label for a specific sound.
void	setSpeedProfile(RosterSpeedProfile sp)
void	setURL(String s)
org.jdom2.Element	store()	Create an XML element to represent this Entry.
String	titleString()
String	toString()
void	updateFile()	Write the contents of this RosterEntry back to a file, preserving all existing decoder CV content.
protected void	warnShortLong(String id)	Warn user that the roster entry needs to be resaved.
Vector<String>	wrapComment(String comment, int textSpace)	Line wrap a comment.
void	writeFile(CvTableModel cvModel, VariableTableModel variableModel)	Write the contents of this RosterEntry to a file.

Methods inherited from class jmri.beans.ArbitraryBean

getIndexedProperty, getProperty, getPropertyNames, hasIndexedProperty, hasProperty, setIndexedProperty, setProperty

Methods inherited from class jmri.beans.Bean

addPropertyChangeListener, addPropertyChangeListener, fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeListeners, getPropertyChangeListeners, isNotifyOnEDT, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.BasicRosterEntry

addPropertyChangeListener, removePropertyChangeListener

Methods inherited from interface jmri.beans.BeanInterface

getIndexedProperty, getProperty, getPropertyNames, hasIndexedProperty, hasProperty, setIndexedProperty, setProperty

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

FILENAME

public static final String FILENAME

See Also:

• Constant Field Values

ROADNAME

public static final String ROADNAME

See Also:

• Constant Field Values

MFG

public static final String MFG

See Also:

• Constant Field Values

MODEL

public static final String MODEL

See Also:

• Constant Field Values

OWNER

public static final String OWNER

See Also:

• Constant Field Values

DCC_ADDRESS

public static final String DCC_ADDRESS

See Also:

• Constant Field Values

LONG_ADDRESS

public static final String LONG_ADDRESS

See Also:

• Constant Field Values

PROTOCOL

public static final String PROTOCOL

See Also:

• Constant Field Values

COMMENT

public static final String COMMENT

See Also:

• Constant Field Values

DECODER_MODEL

public static final String DECODER_MODEL

See Also:

• Constant Field Values

DECODER_DEVELOPERID

public static final String DECODER_DEVELOPERID

See Also:

• Constant Field Values

DECODER_MANUFACTURERID

public static final String DECODER_MANUFACTURERID

See Also:

• Constant Field Values

DECODER_PRODUCTID

public static final String DECODER_PRODUCTID

See Also:

• Constant Field Values

PROGRAMMING

public static final String PROGRAMMING

See Also:

• Constant Field Values

DECODER_FAMILY

public static final String DECODER_FAMILY

See Also:

• Constant Field Values

DECODER_MODES

public static final String DECODER_MODES

See Also:

• Constant Field Values

DECODER_COMMENT

public static final String DECODER_COMMENT

See Also:

• Constant Field Values

DECODER_MAXFNNUM

public static final String DECODER_MAXFNNUM

See Also:

• Constant Field Values

DEFAULT_MAXFNNUM

public static final String DEFAULT_MAXFNNUM

See Also:

• Constant Field Values

IMAGE_FILE_PATH

public static final String IMAGE_FILE_PATH

See Also:

• Constant Field Values

ICON_FILE_PATH

public static final String ICON_FILE_PATH

See Also:

• Constant Field Values

URL

public static final String URL

See Also:

• Constant Field Values

DATE_UPDATED

public static final String DATE_UPDATED

See Also:

• Constant Field Values

FUNCTION_IMAGE

public static final String FUNCTION_IMAGE

See Also:

• Constant Field Values

FUNCTION_LABEL

public static final String FUNCTION_LABEL

See Also:

• Constant Field Values

FUNCTION_LOCKABLE

public static final String FUNCTION_LOCKABLE

See Also:

• Constant Field Values

FUNCTION_SELECTED_IMAGE

public static final String FUNCTION_SELECTED_IMAGE

See Also:

• Constant Field Values

ATTRIBUTE_UPDATED

public static final String ATTRIBUTE_UPDATED

See Also:

• Constant Field Values

ATTRIBUTE_DELETED

public static final String ATTRIBUTE_DELETED

See Also:

• Constant Field Values

MAX_SPEED

public static final String MAX_SPEED

See Also:

• Constant Field Values

SHUNTING_FUNCTION

public static final String SHUNTING_FUNCTION

See Also:

• Constant Field Values

SPEED_PROFILE

public static final String SPEED_PROFILE

See Also:

• Constant Field Values

SOUND_LABEL

public static final String SOUND_LABEL

See Also:

• Constant Field Values

ATTRIBUTE_OPERATING_DURATION

public static final String ATTRIBUTE_OPERATING_DURATION

See Also:

• Constant Field Values

ATTRIBUTE_LAST_OPERATED

public static final String ATTRIBUTE_LAST_OPERATED

See Also:

• Constant Field Values

_fileName

protected String _fileName

_id

protected String _id

_roadName

protected String _roadName

_roadNumber

protected String _roadNumber

_mfg

protected String _mfg

_owner

protected String _owner

_model

protected String _model

_dccAddress

protected String _dccAddress

_protocol

protected LocoAddress.Protocol _protocol

_comment

protected String _comment

_decoderModel

protected String _decoderModel

_decoderFamily

protected String _decoderFamily

_decoderComment

protected String _decoderComment

_maxFnNum

protected String _maxFnNum

_dateUpdated

protected String _dateUpdated

dateModified

protected Date dateModified

_maxSpeedPCT

protected int _maxSpeedPCT

_developerID

protected String _developerID

_manufacturerID

protected String _manufacturerID

_productID

protected String _productID

_programmingModes

protected String _programmingModes

functionLabels

protected Map<Integer,String> functionLabels

soundLabels

protected Map<Integer,String> soundLabels

functionSelectedImages

protected Map<Integer,String> functionSelectedImages

functionImages

protected Map<Integer,String> functionImages

functionLockables

protected Map<Integer,Boolean> functionLockables

functionVisibles

protected Map<Integer,Boolean> functionVisibles

_isShuntingOn

protected String _isShuntingOn

attributePairs

protected final TreeMap<String,String> attributePairs

_imageFilePath

protected String _imageFilePath

_iconFilePath

protected String _iconFilePath

_URL

protected String _URL

_sp

protected RosterSpeedProfile _sp

openCounter

int openCounter

loadedOnce

boolean loadedOnce

indent

String indent

indentWidth

int indentWidth

newLine

String newLine

Constructor Details

RosterEntry

public RosterEntry()

Construct a blank object.

RosterEntry

public RosterEntry(String fileName)

Constructor based on a given file name.

Parameters:

fileName - xml file name for the user's Roster entry

RosterEntry

public RosterEntry(RosterEntry pEntry,
 String pID)

Constructor based on a given RosterEntry object and name/ID.

Parameters:

pEntry - RosterEntry object

pID - unique name/ID for the roster entry

RosterEntry

public RosterEntry(org.jdom2.Element e)

Construct this Entry from XML.

This member has to remain synchronized with the detailed schema in xml/schema/locomotive-config.xsd.

Parameters:

e - Locomotive XML element

Method Details

getMaxFnNumAsInt

public int getMaxFnNumAsInt()

Get the highest valid Fn key number for this roster entry.

The default value (28) can be overridden by a "maxFnNum" attribute in the "model" element of a decoder definition file

• A European standard (RCN-212) extends NMRA S9.2.1 up to F68.
• ESU LokSound 5 already uses up to F31.

Returns:

the highest function number (Fn) supported by this roster entry.

See Also:

• "http://normen.railcommunity.de/RCN-212.pdf"

setId

public void setId(String s)

Set the roster ID for this roster entry.

Parameters:

s - new ID

getId

public String getId()

Specified by:

getId in interface BasicRosterEntry

setFileName

public void setFileName(String s)

Set the file name for this roster entry.

Parameters:

s - the new roster entry file name

getFileName

public String getFileName()

getPathName

public String getPathName()

ensureFilenameExists

public void ensureFilenameExists()

Ensure the entry has a valid filename.

If none exists, create one based on the ID string. Does _not_ enforce any particular naming; you have to check separately for "<none>" or whatever your convention is for indicating an invalid name. Does replace the space, period, colon, slash and backslash characters so that the filename will be generally usable.

setRoadName

public void setRoadName(String s)

getRoadName

public String getRoadName()

setRoadNumber

public void setRoadNumber(String s)

getRoadNumber

public String getRoadNumber()

setMfg

public void setMfg(String s)

getMfg

public String getMfg()

setModel

public void setModel(String s)

getModel

public String getModel()

setOwner

public void setOwner(String s)

getOwner

public String getOwner()

setDccAddress

public void setDccAddress(String s)

getDccAddress

public String getDccAddress()

Specified by:

getDccAddress in interface BasicRosterEntry

setLongAddress

public void setLongAddress(boolean b)

getSpeedProfile

public RosterSpeedProfile getSpeedProfile()

setSpeedProfile

public void setSpeedProfile(RosterSpeedProfile sp)

isLongAddress

public boolean isLongAddress()

Specified by:

isLongAddress in interface BasicRosterEntry

setProtocol

public void setProtocol(LocoAddress.Protocol protocol)

getProtocol

public LocoAddress.Protocol getProtocol()

getProtocolAsString

public String getProtocolAsString()

setComment

public void setComment(String s)

getComment

public String getComment()

setDecoderModel

public void setDecoderModel(String s)

getDecoderModel

public String getDecoderModel()

setDeveloperID

public void setDeveloperID(String s)

getDeveloperID

public String getDeveloperID()

setManufacturerID

public void setManufacturerID(String s)

getManufacturerID

public String getManufacturerID()

setProductID

public void setProductID(@CheckForNull
 String s)

getProductID

public String getProductID()

setProgrammingModes

public void setProgrammingModes(@CheckForNull
 String s)

Set programming modes as defined in a roster entry's decoder definition.

Parameters:

s - a comma separated string of predefined mode elements

getProgrammingModes

public String getProgrammingModes()

Get the modes as defined in a roster entry's decoder definition.

Returns:

a comma separated string of predefined mode elements

setDecoderFamily

public void setDecoderFamily(String s)

getDecoderFamily

public String getDecoderFamily()

setDecoderComment

public void setDecoderComment(String s)

getDecoderComment

public String getDecoderComment()

setMaxFnNum

public void setMaxFnNum(String s)

getMaxFnNum

public String getMaxFnNum()

getDccLocoAddress

public DccLocoAddress getDccLocoAddress()

Specified by:

getDccLocoAddress in interface BasicRosterEntry

setImagePath

public void setImagePath(String s)

getImagePath

public String getImagePath()

setIconPath

public void setIconPath(String s)

getIconPath

public String getIconPath()

setShuntingFunction

public void setShuntingFunction(String fn)

getShuntingFunction

public String getShuntingFunction()

Specified by:

getShuntingFunction in interface BasicRosterEntry

setURL

public void setURL(String s)

getURL

public String getURL()

setDateModified

public void setDateModified(@Nonnull
 Date date)

setDateModified

public void setDateModified(@Nonnull
 String date)
                     throws ParseException

Set the date modified given a string representing a date.

Tries ISO 8601 and the current Java defaults as formats for parsing a date.

Parameters:

date - the string to parse into a date

Throws:

ParseException - if the date cannot be parsed

getDateModified

@CheckForNull
public Date getDateModified()

setDateUpdated

protected void setDateUpdated(String s)

Set the date last updated.

Parameters:

s - the string to parse into a date

getDateUpdated

public String getDateUpdated()

Get the date this entry was last modified. Returns the value of getDateModified() in ISO 8601 format if that is not null, otherwise returns the raw value for the last modified date from the XML file for the roster entry.

Use getDateModified() if control over formatting is required

Returns:

the string representation of the date last modified

setOpen

public void setOpen(boolean boo)

Specified by:

setOpen in interface BasicRosterEntry

isOpen

public boolean isOpen()

Specified by:

isOpen in interface BasicRosterEntry

loadFunctions

public void loadFunctions(org.jdom2.Element e3)

Load function names from a JDOM element.

Does not change values that are already present!

Parameters:

e3 - the XML element containing functions

loadFunctions

public void loadFunctions(org.jdom2.Element e3,
 String source)

Loads function names from a JDOM element. Does not change values that are already present!

Parameters:

e3 - the XML element containing the functions

source - "family" if source is the decoder definition, or "model" if source is the roster entry itself

loadSounds

public void loadSounds(org.jdom2.Element e3,
 String source)

Loads sound names from a JDOM element. Does not change values that are already present!

Parameters:

e3 - the XML element containing sound names

source - "family" if source is the decoder definition, or "model" if source is the roster entry itself

loadAttributes

public void loadAttributes(org.jdom2.Element e3)

Load attribute key/value pairs from a JDOM element.

Parameters:

e3 - XML element containing roster entry attributes

setFunctionLabel

public void setFunctionLabel(int fn,
 String label)

Set the label for a specific function.

Parameters:

fn - function number, starting with 0

label - the label to use

getFunctionLabel

public String getFunctionLabel(int fn)

If a label has been defined for a specific function, return it, otherwise return null.

Parameters:

fn - function number, starting with 0

Returns:

function label or null if not defined

setSoundLabel

public void setSoundLabel(int fn,
 String label)

Define label for a specific sound.

Parameters:

fn - sound number, starting with 0

label - display label for the sound function

getSoundLabel

public String getSoundLabel(int fn)

If a label has been defined for a specific sound, return it, otherwise return null.

Parameters:

fn - sound number, starting with 0

Returns:

sound label or null

setFunctionImage

public void setFunctionImage(int fn,
 String s)

getFunctionImage

public String getFunctionImage(int fn)

setFunctionSelectedImage

public void setFunctionSelectedImage(int fn,
 String s)

getFunctionSelectedImage

public String getFunctionSelectedImage(int fn)

setFunctionLockable

public void setFunctionLockable(int fn,
 boolean lockable)

Define whether a specific function is lockable.

Parameters:

fn - function number, starting with 0

lockable - true if function is continuous; false if momentary

getFunctionLockable

public boolean getFunctionLockable(int fn)

Return the lockable/latchable state of a specific function. Defaults to true.

Parameters:

fn - function number, starting with 0

Returns:

true if function is lockable/latchable

setFunctionVisible

public void setFunctionVisible(int fn,
 boolean visible)

Define whether a specific function button is visible.

Parameters:

fn - function number, starting with 0

visible - true if function button is visible; false to hide

getFunctionVisible

public boolean getFunctionVisible(int fn)

Return the UI visibility of a specific function button. Defaults to true.

Parameters:

fn - function number, starting with 0

Returns:

true if function button is visible

putAttribute

public void putAttribute(String key,
 String value)

Specified by:

putAttribute in interface BasicRosterEntry

getAttribute

public String getAttribute(String key)

Specified by:

getAttribute in interface BasicRosterEntry

deleteAttribute

public void deleteAttribute(String key)

Specified by:

deleteAttribute in interface BasicRosterEntry

getAttributes

public Set<String> getAttributes()

Provide access to the set of attributes.

This is directly backed access, so e.g. removing an item from this Set removes it from the RosterEntry too.

Returns:

a set of attribute keys

getAttributeList

public String[] getAttributeList()

Specified by:

getAttributeList in interface BasicRosterEntry

getGroups

public List<RosterGroup> getGroups()

List the roster groups this entry is a member of, returning existing RosterGroups from the default Roster if they exist.

Returns:

list of roster groups

getGroups

public List<RosterGroup> getGroups(Roster roster)

List the roster groups this entry is a member of, returning existing RosterGroups from the specified Roster if they exist.

Parameters:

roster - the roster to get matching groups from

Returns:

list of roster groups

getMaxSpeedPCT

public int getMaxSpeedPCT()

Specified by:

getMaxSpeedPCT in interface BasicRosterEntry

setMaxSpeedPCT

public void setMaxSpeedPCT(int maxSpeedPCT)

warnShortLong

protected void warnShortLong(String id)

Warn user that the roster entry needs to be resaved.

Parameters:

id - roster ID to warn about

store

public org.jdom2.Element store()

Create an XML element to represent this Entry.

This member has to remain synchronized with the detailed schema in xml/schema/locomotive-config.xsd.

Specified by:

store in interface BasicRosterEntry

Returns:

Contents in a JDOM Element

titleString

public String titleString()

Specified by:

titleString in interface BasicRosterEntry

toString

public String toString()

Specified by:

toString in interface BasicRosterEntry

Overrides:

toString in class Object

updateFile

public void updateFile()

Write the contents of this RosterEntry back to a file, preserving all existing decoder CV content.

This writes the file back in place, with the same decoder-specific content.

writeFile

public void writeFile(CvTableModel cvModel,
 VariableTableModel variableModel)

Write the contents of this RosterEntry to a file.

Information on the contents is passed through the parameters, as the actual XML creation is done in the LocoFile class.

Parameters:

cvModel - CV contents to include in file

variableModel - Variable contents to include in file

changeDateUpdated

public void changeDateUpdated()

Mark the date updated, e.g. from storing this roster entry.

loadCvModel

public void loadCvModel(VariableTableModel varModel,
 CvTableModel cvModel)

Load pre-existing Variable and CvTableModel object with the contents of this entry.

Parameters:

varModel - the variable model to load

cvModel - CV contents to load

printEntryLine

public void printEntryLine(HardcopyWriter w)

Ultra-compact list view of roster entries. Shows text from fields as initially visible in the Roster frame table.

Header is created in PrintListAction.actionPerformed(java.awt.event.ActionEvent) so keep column widths identical with values of colWidth below.

Parameters:

w - writer providing output

printEntry

public void printEntry(HardcopyWriter w)

printEntryDetails

public void printEntryDetails(Writer w)

Print the roster entry information.

Updated to allow for multiline comment and decoder comment fields. Separate write statements for text and line feeds to work around the HardcopyWriter bug that misplaces borders.

Parameters:

w - the HardcopyWriter used to print

wrapComment

public Vector<String> wrapComment(String comment,
 int textSpace)

Line wrap a comment.

Parameters:

comment - the comment to wrap at word boundaries

textSpace - the width of the space to print

Returns:

comment wrapped to fit given width

readFile

public void readFile()

Read a file containing the contents of this RosterEntry.

This has to be done before a call to loadCvModel, for example.

fromFile

public static RosterEntry fromFile(@Nonnull
 File file)
                            throws org.jdom2.JDOMException,
IOException

Create a RosterEntry from a file.

Parameters:

file - The file containing the RosterEntry

Returns:

a new RosterEntry

Throws:

org.jdom2.JDOMException - if unable to parse file

IOException - if unable to read file

getDisplayName

public String getDisplayName()

Description copied from interface: RosterObject

Get the formatted single-line String for displaying the object.

Specified by:

getDisplayName in interface RosterObject

Returns:

a formatted name