jmri
Interface RouteManager

Show UML class diagram

All Superinterfaces:

Manager

All Known Implementing Classes:

DefaultRouteManager

public interface RouteManager
extends Manager

Interface for obtaining Routes

This doesn't have a "new" method, since Routes are separately implemented, instead of being system-specific.

This file is part of JMRI.

JMRI is free software; you can redistribute it and/or modify it under the terms of version 2 of the GNU General Public License as published by the Free Software Foundation. See the "COPYING" file for a copy of this license.

JMRI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Field Summary

Fields inherited from interface jmri.Manager

AUDIO, BLOCKBOSS, BLOCKS, CONDITIONALS, ENTRYEXIT, IDTAGS, LAYOUTBLOCKS, LIGHTS, LOGIXS, MEMORIES, OBLOCKS, PANELFILES, REPORTERS, ROUTES, SECTIONS, SENSORGROUPS, SENSORS, SIGNALGROUPS, SIGNALHEADS, SIGNALMASTLOGICS, SIGNALMASTS, TIMEBASE, TRANSITS, TURNOUTS, WARRANTS

Method Summary

void	deleteRoute(Route r) Delete Route by removing it from the manager.
void	dispose() Free resources when no longer used.
Route	getBySystemName(String s)
Route	getByUserName(String s)
Route	getRoute(String name) Locate via user name, then system name if needed.
List<String>	getSystemNameList() Get a list of all Route system names.
Route	newRoute(String userName) For use with User GUI, to allow the auto generation of systemNames, where the user can optionally supply a username.
Route	provideRoute(String systemName, String userName) Method to create a new Route if the route does not exist Returns null if a Route with the same systemName or userName already exists, or if there is trouble creating a new Route.

Methods inherited from interface jmri.Manager

addPropertyChangeListener, deregister, getBeanBySystemName, getBeanByUserName, getNamedBean, getNamedBeanList, getSystemNameArray, getSystemPrefix, getXMLOrder, makeSystemName, register, removePropertyChangeListener, systemLetter, typeLetter

Method Detail

dispose

void dispose()

Description copied from interface: Manager

Free resources when no longer used. Specifically, remove all references to and from this object, so it can be garbage-collected.

Specified by:

dispose in interface Manager

provideRoute

Route provideRoute(String systemName,
                   String userName)

Method to create a new Route if the route does not exist Returns null if a Route with the same systemName or userName already exists, or if there is trouble creating a new Route.

newRoute

Route newRoute(String userName)

For use with User GUI, to allow the auto generation of systemNames, where the user can optionally supply a username. Method to create a new Route if the route does not exist Returns null if a Route with the same userName already exists, or if there is trouble creating a new Route.

getRoute

Route getRoute(String name)

Locate via user name, then system name if needed. Does not create a new one if nothing found

Parameters:

name -

Returns:

null if no match found

getByUserName

Route getByUserName(String s)

getBySystemName

Route getBySystemName(String s)

getSystemNameList

List<String> getSystemNameList()

Get a list of all Route system names.

Specified by:

getSystemNameList in interface Manager

deleteRoute

void deleteRoute(Route r)

Delete Route by removing it from the manager. The Route must first be deactivated so it stops processing.