Package jmri.jmrit.operations.trains

Class TrainManager

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.jmrit.operations.trains.TrainManager

All Implemented Interfaces:

PropertyChangeListener, EventListener, PropertyChangeFirer, PropertyChangeProvider, InstanceManagerAutoDefault, InstanceManagerAutoInitialize

public class TrainManager
extends PropertyChangeSupport
implements InstanceManagerAutoDefault, InstanceManagerAutoInitialize, PropertyChangeListener

Manages trains.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) int	_maxTrainNameLength
protected List<String>	_shutDownScripts
protected List<String>	_startUpScripts
static final String	LISTLENGTH_CHANGED_PROPERTY
(package private) static final String	NONE
static final String	OPEN_FILE_CHANGED_PROPERTY
static final String	PRINTPREVIEW_CHANGED_PROPERTY
static final String	ROW_COLOR_NAME_CHANGED_PROPERTY
static final String	RUN_FILE_CHANGED_PROPERTY
protected static final String	SEVEN
static final String	TRAIN_ACTION_CHANGED_PROPERTY
static final String	TRAINS_BUILT_CHANGED_PROPERTY
static final String	TRAINS_SAVED_PROPERTY
static final String	TRAINS_SHOW_FULL_NAME_PROPERTY

Fields inherited from class jmri.beans.PropertyChangeSupport

propertyChangeSupport

Constructor Summary

Constructors

Constructor	Description
TrainManager()

Method Summary

Modifier and Type	Method	Description
void	addShutDownScript(String pathname)	Add a script to run at shutdown
void	addStartUpScript(String pathname)	Add a script to run after trains have been loaded
void	buildSelectedTrains(List<Train> trains)
Train	copyTrain(Train train, String trainName)	Makes a copy of an existing train.
void	deleteShutDownScript(String pathname)
void	deleteStartUpScript(String pathname)
void	deregister(Train train)	Forget a NamedBean Object created outside the manager.
void	dispose()
List<Train>	getExcludeTrainListForCar(Car car, PrintWriter buildReport)
List<Train>	getList()
int	getMaxTrainNameLength()
int	getNumEntries()	Get the number of items in the roster
JComboBox<String>	getRowColorComboBox()	JColorChooser is not a replacement for getRowColorComboBox as it doesn't support no color as a selection.
String	getRowColorNameForBuildFailed()
String	getRowColorNameForBuilt()
String	getRowColorNameForReset()
String	getRowColorNameForTerminated()
String	getRowColorNameForTrainEnRoute()
List<String>	getShutDownScripts()	Gets a list of pathnames to run at shutdown
List<String>	getStartUpScripts()	Gets a list of pathnames to run after trains have been loaded
Train	getTrainById(String id)
Train	getTrainByName(String name)
JComboBox<Train>	getTrainComboBox()
Train	getTrainForCar(Car car, PrintWriter buildReport)
Train	getTrainForCar(Car car, List<Train> excludeTrains, PrintWriter buildReport, boolean isExcludeRoutes)
List<Train>	getTrainsArrivingThisLocationList(Location location)	Provides a list of trains ordered by arrival time to a location
List<Train>	getTrainsByDepartureList()	Sort by train departure location name
List<Train>	getTrainsByDescriptionList()	Sort by train description
List<Train>	getTrainsByIdList()	Sort by train id
List<Train>	getTrainsByNameList()	Sort by train name
List<Train>	getTrainsByRouteList()	Sort by train route name
List<Train>	getTrainsByStatusList()	Sort by train status
List<Train>	getTrainsByTerminatesList()	Sort by train termination location name
List<Train>	getTrainsByTimeList()	Sort by train departure time
String	getTrainsFrameTrainAction()
void	initialize()	Perform any initialization that occurs after this object has been constructed and made available by the InstanceManager.
boolean	isAnyTrainBuilding()
boolean	isAnyTrainBuilt()
boolean	isBuildMessagesEnabled()
boolean	isBuildReportEnabled()
boolean	isBuiltRestricted()	Used to determine if a train has any restrictions with regard to car built dates.
boolean	isCabooseRoadRestricted()	Used to determine if a train has any restrictions with regard to caboose roads.
boolean	isCarRoadRestricted()	Used to determine if a train has any restrictions with regard to car roads.
boolean	isLoadRestricted()	Used to determine if a train has any restrictions with regard to car loads.
boolean	isLocoRoadRestricted()	Used to determine if a train has any restrictions with regard to Locomotive roads.
boolean	isOpenFileEnabled()
boolean	isOwnerRestricted()	Used to determine if a train has any restrictions with regard to car owners.
boolean	isPrintPreviewEnabled()
boolean	isRowColorManual()
boolean	isRunFileEnabled()
boolean	isShowLocationHyphenNameEnabled()	When true show entire location name including hyphen
void	load(org.jdom2.Element root)
void	loadTrainIcons()	Loads train icons if needed
Train	newTrain(String name)	Finds an existing train or creates a new train if needed.
boolean	printSelectedTrains(List<Train> trains)
void	propertyChange(PropertyChangeEvent e)	Not currently used.
void	register(Train train)	Remember a NamedBean Object created outside the manager.
void	replaceLoad(String type, String oldLoadName, String newLoadName)
void	resetBuildFailedTrains()
void	runShutDownScripts()
void	runStartUpScripts()
void	setBuildMessagesEnabled(boolean enable)
void	setBuildReportEnabled(boolean enable)
void	setOpenFileEnabled(boolean enable)
void	setPrintPreviewEnabled(boolean enable)
void	setRowColorNameForBuildFailed(String colorName)
void	setRowColorNameForBuilt(String colorName)
void	setRowColorNameForReset(String colorName)
void	setRowColorNameForTerminated(String colorName)
void	setRowColorNameForTrainEnRoute(String colorName)
void	setRowColorsManual(boolean manual)
void	setRunFileEnabled(boolean enable)
void	setShowLocationHyphenNameEnabled(boolean enable)
void	setTrainsFrameTrainAction(String action)
void	setTrainsModified()	Sets all built trains manifests to modified.
void	setTrainsSwitchListStatus(String status)	Sets the switch list status for all built trains.
void	store(org.jdom2.Element root)	Create an XML element to represent this Entry.
boolean	terminateSelectedTrains(List<Train> trains)
void	updateTrainComboBox(JComboBox<Train> box)
void	updateTrainComboBox(JComboBox<Train> box, Car car)	Update combo box with trains that will service this car

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

NONE

static final String NONE

See Also:

• Constant Field Values

_startUpScripts

protected List<String> _startUpScripts

_shutDownScripts

protected List<String> _shutDownScripts

LISTLENGTH_CHANGED_PROPERTY

public static final String LISTLENGTH_CHANGED_PROPERTY

See Also:

• Constant Field Values

PRINTPREVIEW_CHANGED_PROPERTY

public static final String PRINTPREVIEW_CHANGED_PROPERTY

See Also:

• Constant Field Values

OPEN_FILE_CHANGED_PROPERTY

public static final String OPEN_FILE_CHANGED_PROPERTY

See Also:

• Constant Field Values

RUN_FILE_CHANGED_PROPERTY

public static final String RUN_FILE_CHANGED_PROPERTY

See Also:

• Constant Field Values

TRAIN_ACTION_CHANGED_PROPERTY

public static final String TRAIN_ACTION_CHANGED_PROPERTY

See Also:

• Constant Field Values

ROW_COLOR_NAME_CHANGED_PROPERTY

public static final String ROW_COLOR_NAME_CHANGED_PROPERTY

See Also:

• Constant Field Values

TRAINS_BUILT_CHANGED_PROPERTY

public static final String TRAINS_BUILT_CHANGED_PROPERTY

See Also:

• Constant Field Values

TRAINS_SHOW_FULL_NAME_PROPERTY

public static final String TRAINS_SHOW_FULL_NAME_PROPERTY

See Also:

• Constant Field Values

TRAINS_SAVED_PROPERTY

public static final String TRAINS_SAVED_PROPERTY

See Also:

• Constant Field Values

SEVEN

protected static final String SEVEN

See Also:

• Constant Field Values

_maxTrainNameLength

int _maxTrainNameLength

Constructor Details

TrainManager

public TrainManager()

Method Details

getNumEntries

public int getNumEntries()

Get the number of items in the roster

Returns:

Number of trains in the roster

isBuildMessagesEnabled

public boolean isBuildMessagesEnabled()

Returns:

true if build messages are enabled

setBuildMessagesEnabled

public void setBuildMessagesEnabled(boolean enable)

isBuildReportEnabled

public boolean isBuildReportEnabled()

Returns:

true if build reports are enabled

setBuildReportEnabled

public void setBuildReportEnabled(boolean enable)

isOpenFileEnabled

public boolean isOpenFileEnabled()

Returns:

true if open file is enabled

setOpenFileEnabled

public void setOpenFileEnabled(boolean enable)

isRunFileEnabled

public boolean isRunFileEnabled()

Returns:

true if open file is enabled

setRunFileEnabled

public void setRunFileEnabled(boolean enable)

isPrintPreviewEnabled

public boolean isPrintPreviewEnabled()

Returns:

true if print preview is enabled

setPrintPreviewEnabled

public void setPrintPreviewEnabled(boolean enable)

isShowLocationHyphenNameEnabled

public boolean isShowLocationHyphenNameEnabled()

When true show entire location name including hyphen

Returns:

true when showing entire location name

setShowLocationHyphenNameEnabled

public void setShowLocationHyphenNameEnabled(boolean enable)

getTrainsFrameTrainAction

public String getTrainsFrameTrainAction()

setTrainsFrameTrainAction

public void setTrainsFrameTrainAction(String action)

addStartUpScript

public void addStartUpScript(String pathname)

Add a script to run after trains have been loaded

Parameters:

pathname - The script's pathname

deleteStartUpScript

public void deleteStartUpScript(String pathname)

getStartUpScripts

public List<String> getStartUpScripts()

Gets a list of pathnames to run after trains have been loaded

Returns:

A list of pathnames to run after trains have been loaded

runStartUpScripts

public void runStartUpScripts()

addShutDownScript

public void addShutDownScript(String pathname)

Add a script to run at shutdown

Parameters:

pathname - The script's pathname

deleteShutDownScript

public void deleteShutDownScript(String pathname)

getShutDownScripts

public List<String> getShutDownScripts()

Gets a list of pathnames to run at shutdown

Returns:

A list of pathnames to run at shutdown

runShutDownScripts

public void runShutDownScripts()

isBuiltRestricted

public boolean isBuiltRestricted()

Used to determine if a train has any restrictions with regard to car built dates.

Returns:

true if there's a restriction

isLoadRestricted

public boolean isLoadRestricted()

Used to determine if a train has any restrictions with regard to car loads.

Returns:

true if there's a restriction

isCarRoadRestricted

public boolean isCarRoadRestricted()

Used to determine if a train has any restrictions with regard to car roads.

Returns:

true if there's a restriction

isCabooseRoadRestricted

public boolean isCabooseRoadRestricted()

Used to determine if a train has any restrictions with regard to caboose roads.

Returns:

true if there's a restriction

isLocoRoadRestricted

public boolean isLocoRoadRestricted()

Used to determine if a train has any restrictions with regard to Locomotive roads.

Returns:

true if there's a restriction

isOwnerRestricted

public boolean isOwnerRestricted()

Used to determine if a train has any restrictions with regard to car owners.

Returns:

true if there's a restriction

dispose

public void dispose()

getTrainByName

public Train getTrainByName(String name)

Parameters:

name - The train's name.

Returns:

requested Train object or null if none exists

getTrainById

public Train getTrainById(String id)

newTrain

public Train newTrain(String name)

Finds an existing train or creates a new train if needed. Requires train's name and creates a unique id for a new train

Parameters:

name - The train's name.

Returns:

new train or existing train

register

public void register(Train train)

Remember a NamedBean Object created outside the manager.

Parameters:

train - The Train to be added.

deregister

public void deregister(Train train)

Forget a NamedBean Object created outside the manager.

Parameters:

train - The Train to delete.

replaceLoad

public void replaceLoad(String type,
 String oldLoadName,
 String newLoadName)

isAnyTrainBuilt

public boolean isAnyTrainBuilt()

Returns:

true if there's a built train

isAnyTrainBuilding

public boolean isAnyTrainBuilding()

Returns:

true if there's a train being built

getTrainForCar

public Train getTrainForCar(Car car,
 PrintWriter buildReport)

Parameters:

car - The car looking for a train.

buildReport - The optional build report for logging.

Returns:

Train that can service car from its current location to the its destination.

getTrainForCar

public Train getTrainForCar(Car car,
 List<Train> excludeTrains,
 PrintWriter buildReport,
 boolean isExcludeRoutes)

Parameters:

car - The car looking for a train.

excludeTrains - The trains not to try.

buildReport - The optional build report for logging.

isExcludeRoutes - When true eliminate trains that have the same route in the exclude trains list.

Returns:

Train that can service car from its current location to the its destination.

getExcludeTrainListForCar

public List<Train> getExcludeTrainListForCar(Car car,
 PrintWriter buildReport)

getTrainsByNameList

public List<Train> getTrainsByNameList()

Sort by train name

Returns:

list of trains ordered by name

getTrainsByTimeList

public List<Train> getTrainsByTimeList()

Sort by train departure time

Returns:

list of trains ordered by departure time

getTrainsByDepartureList

public List<Train> getTrainsByDepartureList()

Sort by train departure location name

Returns:

list of trains ordered by departure name

getTrainsByTerminatesList

public List<Train> getTrainsByTerminatesList()

Sort by train termination location name

Returns:

list of trains ordered by termination name

getTrainsByRouteList

public List<Train> getTrainsByRouteList()

Sort by train route name

Returns:

list of trains ordered by route name

getTrainsByStatusList

public List<Train> getTrainsByStatusList()

Sort by train status

Returns:

list of trains ordered by status

getTrainsByDescriptionList

public List<Train> getTrainsByDescriptionList()

Sort by train description

Returns:

list of trains ordered by train description

getTrainsByIdList

public List<Train> getTrainsByIdList()

Sort by train id

Returns:

list of trains ordered by id

getList

public List<Train> getList()

getTrainComboBox

public JComboBox<Train> getTrainComboBox()

updateTrainComboBox

public void updateTrainComboBox(JComboBox<Train> box)

updateTrainComboBox

public void updateTrainComboBox(JComboBox<Train> box,
 Car car)

Update combo box with trains that will service this car

Parameters:

box - the combo box to update

car - the car to be serviced

isRowColorManual

public boolean isRowColorManual()

setRowColorsManual

public void setRowColorsManual(boolean manual)

getRowColorNameForBuilt

public String getRowColorNameForBuilt()

setRowColorNameForBuilt

public void setRowColorNameForBuilt(String colorName)

getRowColorNameForBuildFailed

public String getRowColorNameForBuildFailed()

setRowColorNameForBuildFailed

public void setRowColorNameForBuildFailed(String colorName)

getRowColorNameForTrainEnRoute

public String getRowColorNameForTrainEnRoute()

setRowColorNameForTrainEnRoute

public void setRowColorNameForTrainEnRoute(String colorName)

getRowColorNameForTerminated

public String getRowColorNameForTerminated()

setRowColorNameForTerminated

public void setRowColorNameForTerminated(String colorName)

getRowColorNameForReset

public String getRowColorNameForReset()

setRowColorNameForReset

public void setRowColorNameForReset(String colorName)

getRowColorComboBox

public JComboBox<String> getRowColorComboBox()

JColorChooser is not a replacement for getRowColorComboBox as it doesn't support no color as a selection.

Returns:

the available colors used highlighting table rows including no color.

copyTrain

public Train copyTrain(Train train,
 String trainName)

Makes a copy of an existing train.

Parameters:

train - the train to copy

trainName - the name of the new train

Returns:

a copy of train

getTrainsArrivingThisLocationList

public List<Train> getTrainsArrivingThisLocationList(Location location)

Provides a list of trains ordered by arrival time to a location

Parameters:

location - The location

Returns:

A list of trains ordered by arrival time.

loadTrainIcons

public void loadTrainIcons()

Loads train icons if needed

setTrainsSwitchListStatus

public void setTrainsSwitchListStatus(String status)

Sets the switch list status for all built trains. Used for switch lists in consolidated mode.

Parameters:

status - Train.PRINTED, Train.UNKNOWN

setTrainsModified

public void setTrainsModified()

Sets all built trains manifests to modified. This causes the train's manifest to be recreated.

buildSelectedTrains

public void buildSelectedTrains(List<Train> trains)

printSelectedTrains

public boolean printSelectedTrains(List<Train> trains)

terminateSelectedTrains

public boolean terminateSelectedTrains(List<Train> trains)

resetBuildFailedTrains

public void resetBuildFailedTrains()

getMaxTrainNameLength

public int getMaxTrainNameLength()

load

public void load(org.jdom2.Element root)

store

public void store(org.jdom2.Element root)

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

Parameters:

root - common Element for operations-trains.dtd.

propertyChange

public void propertyChange(PropertyChangeEvent e)

Not currently used.

Specified by:

propertyChange in interface PropertyChangeListener

initialize

public void initialize()

Description copied from interface: InstanceManagerAutoInitialize

Perform any initialization that occurs after this object has been constructed and made available by the InstanceManager.

Specified by:

initialize in interface InstanceManagerAutoInitialize