Package jmri.managers

Class ProxyReporterManager

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.beans.VetoableChangeSupport

jmri.managers.AbstractProxyManager<E>

jmri.managers.AbstractProvidingProxyManager<Reporter>

jmri.managers.ProxyReporterManager

All Implemented Interfaces:

PropertyChangeListener, EventListener, PropertyChangeFirer, PropertyChangeProvider, SilenceablePropertyChangeProvider, VetoableChangeFirer, VetoableChangeProvider, Manager<Reporter>, Manager.ManagerDataListener<Reporter>, ProvidingManager<Reporter>, ProxyManager<Reporter>, ReporterManager

public class ProxyReporterManager
extends AbstractProvidingProxyManager<Reporter>
implements ReporterManager

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

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.Manager

Manager.ManagerDataEvent<E extends NamedBean>, Manager.ManagerDataListener<E extends NamedBean>, Manager.NameValidity

Field Summary

Fields inherited from class jmri.managers.AbstractProxyManager

defaultManager, listeners, silenceableProperties, silencedProperties

Fields inherited from class jmri.beans.VetoableChangeSupport

vetoableChangeSupport

Fields inherited from class jmri.beans.PropertyChangeSupport

propertyChangeSupport

Fields inherited from interface jmri.Manager

ANALOGIOS, AUDIO, BLOCKBOSS, BLOCKS, CONDITIONALS, CTCDATA, deprecatedManagerLogger, ENTRYEXIT, IDTAGS, LAYOUTBLOCKS, LIGHTS, LOGIXNG_ANALOG_ACTIONS, LOGIXNG_ANALOG_EXPRESSIONS, LOGIXNG_CONDITIONALNGS, LOGIXNG_DIGITAL_ACTIONS, LOGIXNG_DIGITAL_BOOLEAN_ACTIONS, LOGIXNG_DIGITAL_EXPRESSIONS, LOGIXNG_STRING_ACTIONS, LOGIXNG_STRING_EXPRESSIONS, LOGIXNG_TABLES, LOGIXNGS, LOGIXS, MEMORIES, METERFRAMES, METERS, OBLOCKS, PANELFILES, REPORTERS, ROUTES, SECTIONS, SENSORGROUPS, SENSORS, SIGNALGROUPS, SIGNALHEADS, SIGNALMASTLOGICS, SIGNALMASTS, STRINGIOS, TIMEBASE, TRANSITS, TURNOUTS, WARRANTS

Constructor Summary

Constructors

Constructor	Description
ProxyReporterManager()

Method Summary

Modifier and Type	Method	Description
boolean	allowMultipleAdditions(String systemName)	Determine if it is possible to add a range of reporters in numerical order.
String	getBeanTypeHandled(boolean plural)	Get the user-readable name of the type of NamedBean handled by this manager.
Reporter	getByDisplayName(String key)	Locate an instance based on a user name, or if that fails, by system name.
String	getEntryToolTip()	Get a manager-specific tool tip for adding an entry to the manager.
Class<Reporter>	getNamedBeanClass()	Get the class of NamedBean supported by this Manager.
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 addresses away from the initial address.
String	getNextValidAddress(String curAddress, String prefix, boolean ignoreInitialExisting)	Get the Next valid Reporter address.
Reporter	getReporter(String name)	Locate via user name, then system name if needed.
int	getXMLOrder()	Determine the order that types should be written when storing panel files.
protected Reporter	makeBean(Manager<Reporter> manager, String systemName, String userName)	Defer creation of the proper type to the subclass.
protected AbstractManager<Reporter>	makeInternalManager()	Create specific internal manager as needed for concrete type.
Reporter	newReporter(String systemName, String userName)	Get an instance with the specified system and user names.
Reporter	provide(String name)	Get an existing instance via user name, then system name; if no matching instance is found, create a new NameBean from the system name.
Reporter	provideReporter(String sName)	Locate via user name, then system name if needed.

Methods inherited from class jmri.managers.AbstractProvidingProxyManager

newNamedBean, provideNamedBean

Methods inherited from class jmri.managers.AbstractProxyManager

addDataListener, addManager, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, contentsChanged, createSystemManager, createSystemName, createSystemName, deleteBean, deregister, dispose, getBySystemName, getByUserName, getDefaultManager, getDisplayOrderManagerList, getInternalManager, getKnownBeanProperties, getManager, getManagerList, getManagerOrDefault, getMemo, getNamedBean, getNamedBeanList, getNamedBeanSet, getNextValidAddress, getNextValidAddress, getObjectCount, getSystemNameList, getSystemPrefix, initInternal, intervalAdded, intervalRemoved, makeSystemName, propertyChange, recomputeNamedBeanSet, register, removeDataListener, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener, setDataListenerMute, setPropertyChangesSilenced, typeLetter, validateSystemNameFormat, validSystemNameFormat

Methods inherited from class jmri.beans.VetoableChangeSupport

fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getVetoableChangeListeners, getVetoableChangeListeners

Methods inherited from class jmri.beans.PropertyChangeSupport

fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeListeners, getPropertyChangeListeners

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.Manager

addDataListener, deleteBean, deregister, dispose, getBeanBySystemName, getBeanByUserName, getBeanTypeHandled, getKnownBeanProperties, getMemo, getNamedBean, getNamedBeanList, getNamedBeanSet, getObjectCount, getSubSystemNamePrefix, getSystemNameList, getSystemNamePrefix, getSystemPrefix, isValidSystemNameFormat, makeSystemName, makeSystemName, makeSystemName, register, removeDataListener, setDataListenerMute, setPropertyChangesMuted, typeLetter, validateBadCharsInSystemNameFormat, validateIntegerSystemNameFormat, validateNmraAccessorySystemNameFormat, validateSystemNameFormat, validateSystemNameFormat, validateSystemNameFormatOnlyNumeric, validateSystemNamePrefix, validateTrimmedMin1NumberSystemNameFormat, validateTrimmedSystemNameFormat, validateUppercaseTrimmedSystemNameFormat, validSystemNameFormat

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface jmri.ReporterManager

createSystemName, getBySystemName, getByUserName

Methods inherited from interface jmri.beans.SilenceablePropertyChangeProvider

setPropertyChangesSilenced

Methods inherited from interface jmri.beans.VetoableChangeProvider

addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener

Constructor Details

ProxyReporterManager

public ProxyReporterManager()

Method Details

makeInternalManager

protected AbstractManager<Reporter> makeInternalManager()

Description copied from class: AbstractProxyManager

Create specific internal manager as needed for concrete type.

Specified by:

makeInternalManager in class AbstractProxyManager<Reporter>

Returns:

an internal manager

getXMLOrder

public int getXMLOrder()

Description copied from interface: Manager

Determine the order that types should be written when storing panel files. Uses one of the constants defined in this class.

Yes, that's an overly-centralized methodology, but it works for now.

Specified by:

getXMLOrder in interface Manager<Reporter>

Returns:

write order for this Manager; larger is later.

getReporter

public Reporter getReporter(@Nonnull String name)

Locate via user name, then system name if needed.

Specified by:

getReporter in interface ReporterManager

Parameters:

name - User name or system name to match

Returns:

Null if nothing by that name exists

makeBean

protected Reporter makeBean(Manager<Reporter> manager, String systemName, String userName)

Description copied from class: AbstractProvidingProxyManager

Defer creation of the proper type to the subclass.

Specified by:

makeBean in class AbstractProvidingProxyManager<Reporter>

Parameters:

manager - the manager to invoke

systemName - the system name

userName - the user name

Returns:

a bean

provideReporter

@Nonnull public Reporter provideReporter(@Nonnull String sName) throws IllegalArgumentException

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.

This provides the same function as ProvidingManager.provide(java.lang.String) which has a more generic form.

Specified by:

provideReporter in interface ReporterManager

Parameters:

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

Returns:

Never null

Throws:

IllegalArgumentException - if Reporter doesn't already exist and the manager cannot create the Reporter due to an illegal name or name that can't be parsed.

provide

@Nonnull public Reporter provide(@Nonnull String name) throws IllegalArgumentException

Get an existing instance via user name, then system name; if no matching instance is found, create a new NameBean from the system name.

If the name is a valid system name, it will be used for the new NamedBean. Otherwise, the Manager.makeSystemName(java.lang.String) method will attempt to turn it into a valid system name which the manager will attempt to use. If that fails, an exception is thrown.

This is similar to the specific methods found in certain type-specific managers: TurnoutManager.provideTurnout(java.lang.String), SensorManager.provideSensor(java.lang.String), et al. Those might be more mnemonic; this one is more generic. Neither is preferred nor deprecated; use your choice.

Specified by:

provide in interface ProvidingManager<Reporter>

Specified by:

provide in interface ReporterManager

Parameters:

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

Returns:

Never null

Throws:

IllegalArgumentException - if NamedBean doesn't already exist and the manager cannot create it due to an illegal name or name that can't be parsed.

getByDisplayName

public Reporter getByDisplayName(@Nonnull String key)

Description copied from interface: ReporterManager

Locate an instance based on a user name, or if that fails, by system name. Returns null if no instance already exists.

Specified by:

getByDisplayName in interface ReporterManager

Parameters:

key - the name to locate

Returns:

requested Reporter object or null if none exists

newReporter

@Nonnull public Reporter newReporter(@Nonnull String systemName, String userName)

Get 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

Parameters:

systemName - the system name

userName - the user name

Returns:

requested Reporter object (never null)

allowMultipleAdditions

public boolean allowMultipleAdditions(@Nonnull String systemName)

Description copied from interface: ReporterManager

Determine if it is possible to add a range of reporters in numerical order.

Specified by:

allowMultipleAdditions in interface ReporterManager

Parameters:

systemName - the system name

Returns:

true if multiple reporters can be added

getNextValidAddress

public String getNextValidAddress(@Nonnull String curAddress, @Nonnull String prefix) throws JmriException

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 addresses away from the initial address.

Specified by:

getNextValidAddress in interface ReporterManager

Parameters:

curAddress - hardware address of the turnout to check

prefix - system prefix used to make up the systemName

Returns:

the next available address

Throws:

JmriException - if unable to create a system name for the given address, possibly due to invalid address format or no free addresses 10 away.

getNextValidAddress

public String getNextValidAddress(@Nonnull String curAddress, @Nonnull String prefix, boolean ignoreInitialExisting) throws JmriException

Description copied from interface: ReporterManager

Get the Next valid Reporter address.

Specified by:

getNextValidAddress in interface ReporterManager

Parameters:

curAddress - the starting hardware address to get the next valid from.

prefix - system prefix, just system name, not type letter.

ignoreInitialExisting - false to return the starting address if it does not exist, else true to force an increment.

Returns:

the next valid system name, excluding both system name prefix and type letter.

Throws:

JmriException - if unable to get the current / next address, or more than 10 next addresses in use.

getEntryToolTip

public String getEntryToolTip()

Get a manager-specific tool tip for adding an entry to the manager.

Specified by:

getEntryToolTip in interface Manager<Reporter>

Specified by:

getEntryToolTip in interface ReporterManager

Returns:

the tool tip or null to disable the tool tip

getBeanTypeHandled

@Nonnull public String getBeanTypeHandled(boolean plural)

Description copied from interface: Manager

Get the user-readable name of the type of NamedBean handled by this manager.

For instance, in the code where we are dealing with just a bean and a message that needs to be passed to the user or in a log.

Specified by:

getBeanTypeHandled in interface Manager<Reporter>

Parameters:

plural - true to return plural form of the type; false to return singular form

Returns:

a string of the bean type that the manager handles, eg Turnout, Sensor etc

getNamedBeanClass

public Class<Reporter> getNamedBeanClass()

Get the class of NamedBean supported by this Manager. This should be the generic class used in the Manager's class declaration.

Specified by:

getNamedBeanClass in interface Manager<Reporter>

Returns:

the class supported by this Manager.