jmri.managers
Class DefaultRouteManager

Show UML class diagram
java.lang.Object
  extended by jmri.managers.AbstractManager
      extended by jmri.managers.DefaultRouteManager
All Implemented Interfaces:
PropertyChangeListener, EventListener, Manager, RouteManager

public class DefaultRouteManager
extends AbstractManager
implements RouteManager, PropertyChangeListener

Basic Implementation of a RouteManager.

Note that this does not enforce any particular system naming convention


Field Summary
(package private) static DefaultRouteManager _instance
           
(package private)  int lastAutoRouteRef
           
(package private) static org.slf4j.Logger log
           
(package private)  DecimalFormat paddedNumber
           
 
Fields inherited from class jmri.managers.AbstractManager
_tsys, _tuser, pcs
 
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
 
Constructor Summary
DefaultRouteManager()
           
 
Method Summary
 void deleteRoute(Route r)
          Remove an existing route.
 Route getBySystemName(String name)
           
 Route getByUserName(String key)
           
 Route getRoute(String name)
          Method to get an existing Route.
 String getSystemPrefix()
          Provides access to the system prefix string.
 int getXMLOrder()
           
static DefaultRouteManager instance()
           
 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 provide a Route whether or not is already exists.
 char typeLetter()
           
 
Methods inherited from class jmri.managers.AbstractManager
addPropertyChangeListener, deregister, dispose, firePropertyChange, getBeanBySystemName, getBeanByUserName, getInstanceBySystemName, getInstanceByUserName, getNamedBean, getNamedBeanList, getSystemNameArray, getSystemNameList, makeSystemName, propertyChange, register, registerSelf, removePropertyChangeListener, systemLetter
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface jmri.RouteManager
dispose, getSystemNameList
 
Methods inherited from interface jmri.Manager
addPropertyChangeListener, deregister, getBeanBySystemName, getBeanByUserName, getNamedBean, getNamedBeanList, getSystemNameArray, makeSystemName, register, removePropertyChangeListener, systemLetter
 
Methods inherited from interface java.beans.PropertyChangeListener
propertyChange
 

Field Detail

paddedNumber

DecimalFormat paddedNumber

lastAutoRouteRef

int lastAutoRouteRef

_instance

static DefaultRouteManager _instance

log

static org.slf4j.Logger log
Constructor Detail

DefaultRouteManager

public DefaultRouteManager()
Method Detail

getXMLOrder

public int getXMLOrder()
Specified by:
getXMLOrder in interface Manager
Specified by:
getXMLOrder in class AbstractManager

getSystemPrefix

public String getSystemPrefix()
Description copied from interface: Manager
Provides access to the system prefix string. This was previously called the "System letter"

Specified by:
getSystemPrefix in interface Manager

typeLetter

public char typeLetter()
Specified by:
typeLetter in interface Manager
Returns:
The type letter for a specific implementation

provideRoute

public Route provideRoute(String systemName,
                          String userName)
Method to provide a Route whether or not is already exists.

Specified by:
provideRoute in interface RouteManager

newRoute

public Route newRoute(String userName)
Description copied from interface: RouteManager
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.

Specified by:
newRoute in interface RouteManager

deleteRoute

public void deleteRoute(Route r)
Remove an existing route. Route must have been deactivated before invoking this.

Specified by:
deleteRoute in interface RouteManager

getRoute

public Route getRoute(String name)
Method to get an existing Route. First looks up assuming that name is a User Name. If this fails looks up assuming that name is a System Name. If both fail, returns null.

Specified by:
getRoute in interface RouteManager
Returns:
null if no match found

getBySystemName

public Route getBySystemName(String name)
Specified by:
getBySystemName in interface RouteManager

getByUserName

public Route getByUserName(String key)
Specified by:
getByUserName in interface RouteManager

instance

public static DefaultRouteManager instance()


Copyright © 1997-2013 JMRI Community.
JMRI, DecoderPro, PanelPro, SoundPro, DispatcherPro and associated logos are our trademarks.

Additional information on copyright, trademarks and licenses is linked here.
Site hosted by: Get JMRI Model Railroad Interface at SourceForge.net. Fast, secure and Free Open Source software downloads