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:
java.beans.PropertyChangeListener
,java.util.EventListener
,PropertyChangeFirer
,PropertyChangeProvider
,SilenceablePropertyChangeProvider
,VetoableChangeFirer
,VetoableChangeProvider
,Manager<Reporter>
,Manager.ManagerDataListener<Reporter>
,NameIncrementingManager
,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, ENTRYEXIT, IDTAGS, LAYOUTBLOCKS, LIGHTS, LOGIXNG_ANALOG_ACTIONS, LOGIXNG_ANALOG_EXPRESSIONS, LOGIXNG_CONDITIONALNGS, LOGIXNG_DIGITAL_ACTIONS, LOGIXNG_DIGITAL_BOOLEAN_ACTIONS, LOGIXNG_DIGITAL_EXPRESSIONS, LOGIXNG_GLOBAL_VARIABLES, LOGIXNG_MODULES, 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
allowMultipleAdditions(java.lang.String systemName)
Determines if it is possible to add a range of NamedBeans in numerical order for a particular system implementation.java.lang.String
getBeanTypeHandled(boolean plural)
Get the user-readable name of the type of NamedBean handled by this manager.Reporter
getByDisplayName(java.lang.String key)
Locate an instance based on a user name, or if that fails, by system name.java.lang.Class<Reporter>
getNamedBeanClass()
Get the class of NamedBean supported by this Manager.Reporter
getReporter(java.lang.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, java.lang.String systemName, java.lang.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(java.lang.String systemName, java.lang.String userName)
Get an instance with the specified system and user names.Reporter
provide(java.lang.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(java.lang.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, getEntryToolTip, getInternalManager, getKnownBeanProperties, getManager, getManagerList, getManagerOrDefault, getMemo, getNamedBean, getNamedBeanSet, getNextValidSystemName, getObjectCount, 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, getBeanTypeHandled, getKnownBeanProperties, getMemo, getNamedBean, getNamedBeanSet, getObjectCount, getSubSystemNamePrefix, getSystemNamePrefix, getSystemPrefix, isValidSystemNameFormat, makeSystemName, makeSystemName, makeSystemName, register, removeDataListener, setDataListenerMute, typeLetter, validateBadCharsInSystemNameFormat, validateIntegerSystemNameFormat, validateNmraAccessorySystemNameFormat, validateSystemNameFormat, validateSystemNameFormat, validateSystemNameFormatOnlyNumeric, validateSystemNamePrefix, validateTrimmedMin1NumberSystemNameFormat, validateTrimmedSystemNameFormat, validateUppercaseTrimmedSystemNameFormat, validSystemNameFormat
-
Methods inherited from interface jmri.NameIncrementingManager
getNextValidSystemName
-
Methods inherited from interface jmri.beans.PropertyChangeProvider
addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener
-
Methods inherited from interface jmri.ReporterManager
createSystemName, getBySystemName, getByUserName, getEntryToolTip
-
Methods inherited from interface jmri.beans.SilenceablePropertyChangeProvider
setPropertyChangesSilenced
-
Methods inherited from interface jmri.beans.VetoableChangeProvider
addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener
-
-
-
-
Constructor Detail
-
ProxyReporterManager
public ProxyReporterManager()
-
-
Method Detail
-
makeInternalManager
protected AbstractManager<Reporter> makeInternalManager()
Description copied from class:AbstractProxyManager
Create specific internal manager as needed for concrete type.- Specified by:
makeInternalManager
in classAbstractProxyManager<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 interfaceManager<Reporter>
- Returns:
- write order for this Manager; larger is later.
-
getReporter
@CheckForNull public Reporter getReporter(@Nonnull java.lang.String name)
Locate via user name, then system name if needed.- Specified by:
getReporter
in interfaceReporterManager
- Parameters:
name
- User name or system name to match- Returns:
- Null if nothing by that name exists
-
makeBean
@Nonnull protected Reporter makeBean(Manager<Reporter> manager, java.lang.String systemName, java.lang.String userName) throws java.lang.IllegalArgumentException
Description copied from class:AbstractProvidingProxyManager
Defer creation of the proper type to the subclass.- Specified by:
makeBean
in classAbstractProvidingProxyManager<Reporter>
- Parameters:
manager
- the manager to invokesystemName
- the system nameuserName
- the user name- Returns:
- a bean
- Throws:
java.lang.IllegalArgumentException
- if unable to make.
-
provideReporter
@Nonnull public Reporter provideReporter(@Nonnull java.lang.String sName) throws java.lang.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 interfaceReporterManager
- Parameters:
sName
- User name, system name, or address which can be promoted to system name- Returns:
- Never null
- Throws:
java.lang.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 java.lang.String name) throws java.lang.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 interfaceProvidingManager<Reporter>
- Specified by:
provide
in interfaceReporterManager
- Parameters:
name
- User name, system name, or address which can be promoted to system name- Returns:
- Never null
- Throws:
java.lang.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
@CheckForNull public Reporter getByDisplayName(@Nonnull java.lang.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 interfaceReporterManager
- Parameters:
key
- the name to locate- Returns:
- requested Reporter object or null if none exists
-
newReporter
@Nonnull public Reporter newReporter(@Nonnull java.lang.String systemName, java.lang.String userName) throws java.lang.IllegalArgumentException
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.
- If both names are provided, the system name defines the hardware access of the desired Reporter, and the user address is associated with it.
- Specified by:
newReporter
in interfaceReporterManager
- Parameters:
systemName
- the system nameuserName
- the user name- Returns:
- requested Reporter object (never null)
- Throws:
java.lang.IllegalArgumentException
- if cannot create the Reporter due to an illegal name or name that can't be parsed.
-
allowMultipleAdditions
public boolean allowMultipleAdditions(@Nonnull java.lang.String systemName)
Description copied from interface:NameIncrementingManager
Determines if it is possible to add a range of NamedBeans in numerical order for a particular system implementation.Default is not providing this service. Systems should override this method if they do provide the service.
- Specified by:
allowMultipleAdditions
in interfaceNameIncrementingManager
- Parameters:
systemName
- the system name to check against; appears to be ignored in all implementations- Returns:
- true if possible; false otherwise
-
getBeanTypeHandled
@Nonnull public java.lang.String getBeanTypeHandled(boolean plural)
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 interfaceManager<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 java.lang.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 interfaceManager<Reporter>
- Returns:
- the class supported by this Manager.
-
-