Package jmri.jmrit.timetable

Class TimeTableDataManager

java.lang.Object

jmri.jmrit.timetable.TimeTableDataManager

public class TimeTableDataManager
extends Object

Provide data base management services.

The data structure was migrated from a MySQL database. As such, it contains tables implemented as TreeMaps and records implemented as Classes. The logical relationships are handled using foreign keys.

 Data Structure:
   Layout -- Global data.
     TrainTypes -- Assigned to trains for diagram colors.
     Segments -- Used for division / sub-division arrangements.
       Stations -- Any place a train can stop.
     Schedules -- Basic information about a schedule.
       Trains -- Train characteristics.
         Stops -- A junction between a train and a station that contains arrival and departure times.
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	TimeTableDataManager.SegmentStation	Internal class that provides a combined segment and station view.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) boolean	_lockCalculate
static final String	CLOCK_LT_1
static final String	DEFAULT_SPEED_LT_0
static final String	DISTANCE_LT_0
static final String	DURATION_LT_0
static final String	DURATION_RANGE
static final String	LAYOUT_HAS_CHILDREN
static final String	NEXT_SPEED_LT_0
static final String	SCALE_NF
static final String	SCHEDULE_ADD_FAIL
static final String	SCHEDULE_HAS_CHILDREN
static final String	SEGMENT_ADD_FAIL
static final String	SEGMENT_CHANGE_ERROR
static final String	SEGMENT_HAS_CHILDREN
static final String	SIDINGS_LT_0
static final String	STAGING_IN_USE
static final String	STAGING_LT_0
static final String	STAGING_RANGE
static final String	START_HOUR_RANGE
static final String	START_TIME_FORMAT
static final String	START_TIME_RANGE
static final String	STATION_ADD_FAIL
static final String	STATION_HAS_REFERENCE
static final String	STOP_ADD_FAIL
static final String	STOP_DURATION_LT_0
static final String	THROTTLE_RANGE
static final String	THROTTLES_IN_USE
static final String	THROTTLES_LT_0
static final String	TIME_OUT_OF_RANGE
static final String	TRAIN_ADD_FAIL
static final String	TRAIN_HAS_CHILDREN
static final String	TYPE_ADD_FAIL
static final String	TYPE_HAS_REFERENCE

Constructor Summary

Constructors

Constructor	Description
TimeTableDataManager(boolean loadData)	Create a TimeTableDataManager instance.

Method Summary

Modifier and Type	Method	Description
void	addLayout(int id, Layout newLayout)
void	addSchedule(int id, Schedule newSchedule)
void	addSegment(int id, Segment newSegment)
void	addStation(int id, Station newStation)	Add a new station.
void	addStop(int id, Stop newStop)
void	addTrain(int id, Train newTrain)
void	addTrainType(int id, TrainType newTrainType)
(package private) void	calculateLayoutTrains(int layoutId, boolean updateStops)	Update the stops for all of the trains for this layout.
(package private) void	calculateScheduleTrains(int scheduleId, boolean updateStops)	Update the stop times for all of the trains that use this schedule.
void	calculateTrain(int trainId, boolean updateStops)	Calculate the arrival and departure times for all of the stops.
void	deleteLayout(int id)	Delete the layout if there are no train types, segments or schedules.
void	deleteSchedule(int id)	Delete the schedule if it has no trains.
void	deleteSegment(int id)	Delete the segment if it has no stations.
void	deleteStation(int id)	Delete the station if there are no stop references.
void	deleteStop(int id)	Delete the stop and update train schedule.
void	deleteTrain(int id)	Delete the train if it has no stops.
void	deleteTrainType(int id)	Delete the train type if there are no train references.
static TimeTableDataManager	getDataManager()	Use the InstanceManager to only allow a single data manager instance.
Layout	getLayout(int id)
Layout	getLayoutForStop(int stopId)
List<Layout>	getLayouts(boolean sort)	Create a list of layouts
int	getNextId(String type)	Get the last key from the map and add 1.
Schedule	getSchedule(int id)
List<Schedule>	getSchedules(int fKeyLayout, boolean sort)	Create a list of schedules
Segment	getSegment(int id)
List<Segment>	getSegments(int fKeyLayout, boolean sort)	Create a list of segments
List<TimeTableDataManager.SegmentStation>	getSegmentStations(int layoutId)
Station	getStation(int id)
List<Station>	getStations(int fKeySegment, boolean sort)	Create a list of stations
Stop	getStop(int id)
List<Stop>	getStops(int fKeyTrain, int fKeyStation, boolean sort)	Create a list of stops
Train	getTrain(int id)
List<Train>	getTrains(int fKeySchedule, int fKeyType, boolean sort)	Create a list of trains
TrainType	getTrainType(int id)
List<TrainType>	getTrainTypes(int fKeyLayout, boolean sort)	Create a list of train types
void	setLockCalculate(boolean lock)
boolean	validateTime(int checkStart, int checkDuration, int checkTime)	Check to see if the supplied time is within the time range for the supplied schedule.

Methods inherited from class java.lang.Object

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

Field Details

CLOCK_LT_1

public static final String CLOCK_LT_1

See Also:

• Constant Field Values

DURATION_LT_0

public static final String DURATION_LT_0

See Also:

• Constant Field Values

THROTTLES_LT_0

public static final String THROTTLES_LT_0

See Also:

• Constant Field Values

THROTTLES_IN_USE

public static final String THROTTLES_IN_USE

See Also:

• Constant Field Values

SCALE_NF

public static final String SCALE_NF

See Also:

• Constant Field Values

TIME_OUT_OF_RANGE

public static final String TIME_OUT_OF_RANGE

See Also:

• Constant Field Values

SEGMENT_CHANGE_ERROR

public static final String SEGMENT_CHANGE_ERROR

See Also:

• Constant Field Values

DISTANCE_LT_0

public static final String DISTANCE_LT_0

See Also:

• Constant Field Values

SIDINGS_LT_0

public static final String SIDINGS_LT_0

See Also:

• Constant Field Values

STAGING_LT_0

public static final String STAGING_LT_0

See Also:

• Constant Field Values

STAGING_IN_USE

public static final String STAGING_IN_USE

See Also:

• Constant Field Values

START_HOUR_RANGE

public static final String START_HOUR_RANGE

See Also:

• Constant Field Values

DURATION_RANGE

public static final String DURATION_RANGE

See Also:

• Constant Field Values

DEFAULT_SPEED_LT_0

public static final String DEFAULT_SPEED_LT_0

See Also:

• Constant Field Values

START_TIME_FORMAT

public static final String START_TIME_FORMAT

See Also:

• Constant Field Values

START_TIME_RANGE

public static final String START_TIME_RANGE

See Also:

• Constant Field Values

THROTTLE_RANGE

public static final String THROTTLE_RANGE

See Also:

• Constant Field Values

STAGING_RANGE

public static final String STAGING_RANGE

See Also:

• Constant Field Values

STOP_DURATION_LT_0

public static final String STOP_DURATION_LT_0

See Also:

• Constant Field Values

NEXT_SPEED_LT_0

public static final String NEXT_SPEED_LT_0

See Also:

• Constant Field Values

LAYOUT_HAS_CHILDREN

public static final String LAYOUT_HAS_CHILDREN

See Also:

• Constant Field Values

TYPE_HAS_REFERENCE

public static final String TYPE_HAS_REFERENCE

See Also:

• Constant Field Values

SEGMENT_HAS_CHILDREN

public static final String SEGMENT_HAS_CHILDREN

See Also:

• Constant Field Values

STATION_HAS_REFERENCE

public static final String STATION_HAS_REFERENCE

See Also:

• Constant Field Values

SCHEDULE_HAS_CHILDREN

public static final String SCHEDULE_HAS_CHILDREN

See Also:

• Constant Field Values

TRAIN_HAS_CHILDREN

public static final String TRAIN_HAS_CHILDREN

See Also:

• Constant Field Values

TYPE_ADD_FAIL

public static final String TYPE_ADD_FAIL

See Also:

• Constant Field Values

SEGMENT_ADD_FAIL

public static final String SEGMENT_ADD_FAIL

See Also:

• Constant Field Values

STATION_ADD_FAIL

public static final String STATION_ADD_FAIL

See Also:

• Constant Field Values

SCHEDULE_ADD_FAIL

public static final String SCHEDULE_ADD_FAIL

See Also:

• Constant Field Values

TRAIN_ADD_FAIL

public static final String TRAIN_ADD_FAIL

See Also:

• Constant Field Values

STOP_ADD_FAIL

public static final String STOP_ADD_FAIL

See Also:

• Constant Field Values

_lockCalculate

boolean _lockCalculate

Constructor Details

TimeTableDataManager

public TimeTableDataManager(boolean loadData)

Create a TimeTableDataManager instance.

Parameters:

loadData - False to create an empty instance, otherwise load the data

Method Details

getDataManager

public static TimeTableDataManager getDataManager()

Use the InstanceManager to only allow a single data manager instance.

Returns:

the current or new data manager.

setLockCalculate

public void setLockCalculate(boolean lock)

addLayout

public void addLayout(int id,
 Layout newLayout)

addTrainType

public void addTrainType(int id,
 TrainType newTrainType)

addSegment

public void addSegment(int id,
 Segment newSegment)

addStation

public void addStation(int id,
 Station newStation)

Add a new station. Create a SegmentStation instance. Add it to the SegmentStation list.

Parameters:

id - map id.

newStation - the new station.

addSchedule

public void addSchedule(int id,
 Schedule newSchedule)

addTrain

public void addTrain(int id,
 Train newTrain)

addStop

public void addStop(int id,
 Stop newStop)

deleteLayout

public void deleteLayout(int id)

Delete the layout if there are no train types, segments or schedules.

Parameters:

id - The layout id.

Throws:

IllegalArgumentException - LAYOUT_HAS_CHILDREN

deleteTrainType

public void deleteTrainType(int id)

Delete the train type if there are no train references.

Parameters:

id - The train type id.

Throws:

IllegalArgumentException - TYPE_HAS_REFERENCE

deleteSegment

public void deleteSegment(int id)

Delete the segment if it has no stations.

Parameters:

id - The segment id.

Throws:

IllegalArgumentException - SEGMENT_HAS_CHILDREN

deleteStation

public void deleteStation(int id)

Delete the station if there are no stop references.

Parameters:

id - The station id.

Throws:

IllegalArgumentException - STATION_HAS_REFERENCE

deleteSchedule

public void deleteSchedule(int id)

Delete the schedule if it has no trains.

Parameters:

id - The schedule id.

Throws:

IllegalArgumentException - SCHEDULE_HAS_CHILDREN

deleteTrain

public void deleteTrain(int id)

Delete the train if it has no stops.

Parameters:

id - The train id.

Throws:

IllegalArgumentException - TRAIN_HAS_CHILDREN

deleteStop

public void deleteStop(int id)

Delete the stop and update train schedule.

Parameters:

id - The stop id.

getLayout

public Layout getLayout(int id)

getTrainType

public TrainType getTrainType(int id)

getSegment

public Segment getSegment(int id)

getStation

public Station getStation(int id)

getSchedule

public Schedule getSchedule(int id)

getTrain

public Train getTrain(int id)

getStop

public Stop getStop(int id)

getNextId

public int getNextId(String type)

Get the last key from the map and add 1.

Parameters:

type - The record type which is used to select the appropriate map.

Returns:

the next id, or 0 if there is an error.

getLayouts

public List<Layout> getLayouts(boolean sort)

Create a list of layouts

Parameters:

sort - If true, sort the resulting list

Returns:

a list of layouts

getTrainTypes

public List<TrainType> getTrainTypes(int fKeyLayout,
 boolean sort)

Create a list of train types

Parameters:

fKeyLayout - If non-zero, select the types that have the specified foreign key

sort - If true, sort the resulting list

Returns:

a list of train types

getSegments

public List<Segment> getSegments(int fKeyLayout,
 boolean sort)

Create a list of segments

Parameters:

fKeyLayout - If non-zero, select the segments that have the specified foreign key

sort - If true, sort the resulting list

Returns:

a list of segments

getStations

public List<Station> getStations(int fKeySegment,
 boolean sort)

Create a list of stations

Parameters:

fKeySegment - If non-zero, select the stations that have the specified foreign key

sort - If true, sort the resulting list

Returns:

a list of stations

getSchedules

public List<Schedule> getSchedules(int fKeyLayout,
 boolean sort)

Create a list of schedules

Parameters:

fKeyLayout - If non-zero, select the schedules that have the specified foreign key

sort - If true, sort the resulting list

Returns:

a list of schedules

getTrains

public List<Train> getTrains(int fKeySchedule,
 int fKeyType,
 boolean sort)

Create a list of trains

Parameters:

fKeySchedule - If non-zero, select the trains that have the specified foreign key

fKeyType - If non-zero, select the trains that have the specified foreign key

sort - If true, sort the resulting list

Returns:

a list of trains

getStops

public List<Stop> getStops(int fKeyTrain,
 int fKeyStation,
 boolean sort)

Create a list of stops

Parameters:

fKeyTrain - If non-zero, select the stops that have the specified foreign key

fKeyStation - If non-zero, select the stops that have the specified foreign key

sort - If true, sort the resulting list

Returns:

a list of stops

getLayoutForStop

public Layout getLayoutForStop(int stopId)

getSegmentStations

public List<TimeTableDataManager.SegmentStation> getSegmentStations(int layoutId)

calculateLayoutTrains

void calculateLayoutTrains(int layoutId,
 boolean updateStops)

Update the stops for all of the trains for this layout. Invoked by updates to fast clock speed, metric, scale and station distances.

Parameters:

layoutId - The id for the layout that has been updated.

updateStops - True for update

calculateScheduleTrains

void calculateScheduleTrains(int scheduleId,
 boolean updateStops)

Update the stop times for all of the trains that use this schedule.

Parameters:

scheduleId - The id for the schedule that has been updated.

updateStops - True for update

calculateTrain

public void calculateTrain(int trainId,
 boolean updateStops)

Calculate the arrival and departure times for all of the stops.

Parameters:

trainId - The id of the train to be updated.

updateStops - When true, update the arrive and depart times.

Throws:

IllegalArgumentException - when stop times are outside of the schedule times or a segment change failed. The TIME_OUT_OF_RANGE exception message includes the stop id and train name. The SEGMENT_CHANGE_ERROR message includes the segment name and the station name. The tilde character is used as the string separator.

validateTime

public boolean validateTime(int checkStart,
 int checkDuration,
 int checkTime)

Check to see if the supplied time is within the time range for the supplied schedule. If the duration is 24 hours, then all times are valid. Otherwise, we need to calculate the valid range, which can span midnight.

Parameters:

checkStart - The schedule start hour.

checkDuration - The schedule duration.

checkTime - The time value to be check.

Returns:

true if the time is valid.