jmri.managers
Class ProxyReporterManager

java.lang.Object
  jmri.managers.AbstractProxyManager
      jmri.managers.ProxyReporterManager

All Implemented Interfaces:

Manager, ReporterManager

public class ProxyReporterManager
extends AbstractProxyManager
implements ReporterManager

Implementation of a ReporterManager that can serves as a proxy for multiple system-specific implementations.

Author:

Bob Jacobsen Copyright (C) 2003, 2010

Field Summary

Fields inherited from interface jmri.Manager

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

Constructor Summary

ProxyReporterManager()

Method Summary

boolean	allowMultipleAdditions(String systemName) A method that determines if it is possible to add a range of turnouts in numerical order eg 10 to 30 will return true.
Reporter	getBySystemName(String sName) Locate an instance based on a system name.
Reporter	getByUserName(String userName) Locate an instance based on a user name.
String	getNextValidAddress(String curAddress, String prefix) Determine if the address supplied is valid and free, if not then it shall return the next free valid address up to a maximum of 10 address away from the initial address.
Reporter	getReporter(String name) Locate via user name, then system name if needed.
int	getXMLOrder()
protected NamedBean	makeBean(int i, String systemName, String userName) Defer creation of the proper type to the subclass
protected AbstractManager	makeInternalManager()
Reporter	newReporter(String systemName, String userName) Return an instance with the specified system and user names.
Reporter	provideReporter(String sName) Locate via user name, then system name if needed.

Methods inherited from class jmri.managers.AbstractProxyManager

addManager, addPropertyChangeListener, deregister, dispose, getBeanBySystemName, getBeanByUserName, getManagerList, getMgr, getNamedBean, getSystemNameArray, getSystemNameList, getSystemPrefix, makeSystemName, match, matchTentative, newNamedBean, nMgrs, provideNamedBean, register, removePropertyChangeListener, systemLetter, typeLetter

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.ReporterManager

getSystemNameList

Methods inherited from interface jmri.Manager

addPropertyChangeListener, deregister, dispose, getBeanBySystemName, getSystemNameArray, getSystemPrefix, makeSystemName, register, removePropertyChangeListener, systemLetter, typeLetter

Constructor Detail

ProxyReporterManager

public ProxyReporterManager()

Method Detail

makeInternalManager

protected AbstractManager makeInternalManager()

Specified by:

makeInternalManager in class AbstractProxyManager

getXMLOrder

public int getXMLOrder()

Specified by:

getXMLOrder in interface Manager

getReporter

public Reporter getReporter(String name)

Locate via user name, then system name if needed.

Specified by:

getReporter in interface ReporterManager

Parameters:

name -

Returns:

Null if nothing by that name exists

makeBean

protected NamedBean makeBean(int i,
                             String systemName,
                             String userName)

Description copied from class: AbstractProxyManager

Defer creation of the proper type to the subclass

Specified by:

makeBean in class AbstractProxyManager

Parameters:

i - Which manager to invoke

provideReporter

public Reporter provideReporter(String sName)

Description copied from interface: ReporterManager

Locate via user name, then system name if needed. If that fails, create a new Reporter. If the name is a valid system name, it will be used for the new Reporter. Otherwise, the makeSystemName method will attempt to turn it into a valid system name.

Specified by:

provideReporter in interface ReporterManager

Parameters:

sName - User name, system name, or address which can be promoted to system name

Returns:

Never null

getBySystemName

public Reporter getBySystemName(String sName)

Locate an instance based on a system name. Returns null if no instance already exists.

Specified by:

getBySystemName in interface ReporterManager

Returns:

requested Reporter object or null if none exists

getByUserName

public Reporter getByUserName(String userName)

Locate an instance based on a user name. Returns null if no instance already exists.

Specified by:

getByUserName in interface ReporterManager

Returns:

requested Reporter object or null if none exists

newReporter

public Reporter newReporter(String systemName,
                            String userName)

Return an instance with the specified system and user names. Note that two calls with the same arguments will get the same instance; there is only one Reporter object representing a given physical Reporter and therefore only one with a specific system or user name.

This will always return a valid object reference for a valid request; a new object will be created if necessary. In that case:

• If a null reference is given for user name, no user name will be associated with the Reporter object created; a valid system name must be provided
• If a null reference is given for the system name, a system name will _somehow_ be inferred from the user name. How this is done is system specific. Note: a future extension of this interface will add an exception to signal that this was not possible.
• If both names are provided, the system name defines the hardware access of the desired Reporter, and the user address is associated with it.

Note that it is possible to make an inconsistent request if both addresses are provided, but the given values are associated with different objects. This is a problem, and we don't have a good solution except to issue warnings. This will mostly happen if you're creating Reporters when you should be looking them up.

Specified by:

newReporter in interface ReporterManager

Returns:

requested Reporter object (never null)

allowMultipleAdditions

public boolean allowMultipleAdditions(String systemName)

Description copied from interface: ReporterManager

A method that determines if it is possible to add a range of turnouts in numerical order eg 10 to 30 will return true. where as if the address format is 1b23 this will return false.

Specified by:

allowMultipleAdditions in interface ReporterManager

getNextValidAddress

public String getNextValidAddress(String curAddress,
                                  String prefix)

Description copied from interface: ReporterManager

Determine if the address supplied is valid and free, if not then it shall return the next free valid address up to a maximum of 10 address away from the initial address.

Specified by:

getNextValidAddress in interface ReporterManager

Parameters:

curAddress - - The hardware address of the turnout we which to check.

prefix - - The System Prefix used to make up the systemName