Package jmri.jmrit.operations.trains.manualtrainbuilder

Class TrainManualBuild

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.jmrit.operations.trains.manualtrainbuilder.TrainManualBuild

All Implemented Interfaces:

PropertyChangeListener, EventListener, PropertyChangeFirer, PropertyChangeProvider

public class TrainManualBuild
extends PropertyChangeSupport
implements PropertyChangeListener

Train Manual Build. Allows a user to manually assign cars to a train.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_comment
protected String	_id
protected int	_IdNumber
protected Hashtable<String,TrainManualBuildItem>	_manualBuildHashTable
protected int	_sequenceNum
protected String	_trainId
static final String	DISPOSE
static final String	LISTCHANGE_CHANGED_PROPERTY

Fields inherited from class jmri.beans.PropertyChangeSupport

propertyChangeSupport

Constructor Summary

Constructors

Constructor	Description
TrainManualBuild(String id, String trainId)
TrainManualBuild(org.jdom2.Element e)	Construct this Entry from XML.

Method Summary

Modifier and Type	Method	Description
TrainManualBuildItem	addItem()	Adds build item to the end of this manual build
TrainManualBuildItem	addItem(int sequence)	Add a manual build item at a specific place (sequence) in the manual build.
void	deleteItem(TrainManualBuildItem mbi)	Delete a manual build item
void	dispose()
String	getComment()
String	getId()
TrainManualBuildItem	getItemById(String id)	Get a ManualBuildItem by id
TrainManualBuildItem	getItemBySequenceId(int sequenceId)
List<TrainManualBuildItem>	getItemsBySequenceList()	Get a list of ManualBuildItems sorted by sequence order
int	getSize()
String	getTrainId()
String	getTrainName()
void	moveItemDown(TrainManualBuildItem mbi)	Places a ManualBuildItem later in the manualBuild
void	moveItemUp(TrainManualBuildItem mbi)	Places a ManualBuildItem earlier in the manual build
void	propertyChange(PropertyChangeEvent e)
void	register(TrainManualBuildItem mbi)	Remember a NamedBean Object created outside the manager.
void	setComment(String comment)
protected void	setDirtyAndFirePropertyChange(String p, Object old, Object n)
void	setTrainId(String trainId)
org.jdom2.Element	store()	Create an XML element to represent this Entry.

Methods inherited from class jmri.beans.PropertyChangeSupport

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

Methods inherited from class java.lang.Object

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

Field Details

_id

protected String _id

_trainId

protected String _trainId

_comment

protected String _comment

_manualBuildHashTable

protected Hashtable<String,TrainManualBuildItem> _manualBuildHashTable

_IdNumber

protected int _IdNumber

_sequenceNum

protected int _sequenceNum

LISTCHANGE_CHANGED_PROPERTY

public static final String LISTCHANGE_CHANGED_PROPERTY

See Also:

• Constant Field Values

DISPOSE

public static final String DISPOSE

See Also:

• Constant Field Values

Constructor Details

TrainManualBuild

public TrainManualBuild(String id,
 String trainId)

TrainManualBuild

public TrainManualBuild(org.jdom2.Element e)

Construct this Entry from XML. This member has to remain synchronized with the detailed DTD in operations-config.xml

Parameters:

e - Consist XML element

Method Details

getId

public String getId()

setTrainId

public void setTrainId(String trainId)

getTrainId

public String getTrainId()

getTrainName

public String getTrainName()

getSize

public int getSize()

setComment

public void setComment(String comment)

getComment

public String getComment()

dispose

public void dispose()

addItem

public TrainManualBuildItem addItem()

Adds build item to the end of this manual build

Returns:

ManualBuildItem created

addItem

public TrainManualBuildItem addItem(int sequence)

Add a manual build item at a specific place (sequence) in the manual build. Allowable sequence numbers are 0 to max size of manual build. 0 = start of list.

Parameters:

sequence - Where in the Manual Build to add the item.

Returns:

manual build item

register

public void register(TrainManualBuildItem mbi)

Remember a NamedBean Object created outside the manager.

Parameters:

mbi - The manual build item to add.

deleteItem

public void deleteItem(TrainManualBuildItem mbi)

Delete a manual build item

Parameters:

mbi - The manual build item to delete.

getItemById

public TrainManualBuildItem getItemById(String id)

Get a ManualBuildItem by id

Parameters:

id - The string id of the ManualBuildItem.

Returns:

manual build item

getItemsBySequenceList

public List<TrainManualBuildItem> getItemsBySequenceList()

Get a list of ManualBuildItems sorted by sequence order

Returns:

list of ManualBuildItems ordered by sequence

moveItemUp

public void moveItemUp(TrainManualBuildItem mbi)

Places a ManualBuildItem earlier in the manual build

Parameters:

mbi - The ManualBuildItem to move.

moveItemDown

public void moveItemDown(TrainManualBuildItem mbi)

Places a ManualBuildItem later in the manualBuild

Parameters:

mbi - The ManualBuildItem to move.

getItemBySequenceId

public TrainManualBuildItem getItemBySequenceId(int sequenceId)

store

public org.jdom2.Element store()

Create an XML element to represent this Entry. This member has to remain synchronized with the detailed DTD in operations-config.xml.

Returns:

Contents in a JDOM Element

propertyChange

public void propertyChange(PropertyChangeEvent e)

Specified by:

propertyChange in interface PropertyChangeListener

setDirtyAndFirePropertyChange

protected void setDirtyAndFirePropertyChange(String p,
 Object old,
 Object n)