jmri
Class DefaultRouteManager

java.lang.Object
  extended by jmri.AbstractManager
      extended by jmri.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

Author:
Dave Duchamp Copyright (C) 2004

Field Summary
 
Fields inherited from class jmri.AbstractManager
_tsys, _tuser
 
Constructor Summary
DefaultRouteManager()
           
 
Method Summary
 Route createNewRoute(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.
 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.
static DefaultRouteManager instance()
           
 char systemLetter()
           
 char typeLetter()
           
 
Methods inherited from class jmri.AbstractManager
addPropertyChangeListener, deregister, dispose, firePropertyChange, getInstanceBySystemName, getInstanceByUserName, getSystemNameList, makeSystemName, propertyChange, register, removePropertyChangeListener
 
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, makeSystemName, register, removePropertyChangeListener
 
Methods inherited from interface java.beans.PropertyChangeListener
propertyChange
 

Constructor Detail

DefaultRouteManager

public DefaultRouteManager()
Method Detail

systemLetter

public char systemLetter()
Specified by:
systemLetter in interface Manager
Returns:
The system-specific prefix letter for a specific implementation

typeLetter

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

createNewRoute

public Route createNewRoute(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.

Specified by:
createNewRoute 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 - 2008 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: SourceForge_Logo