Class ProxySensorManager
- java.lang.Object
-
- jmri.beans.PropertyChangeSupport
-
- jmri.beans.VetoableChangeSupport
-
- jmri.managers.AbstractProxyManager<E>
-
- jmri.managers.AbstractProvidingProxyManager<Sensor>
-
- jmri.managers.ProxySensorManager
-
- All Implemented Interfaces:
java.beans.PropertyChangeListener
,java.util.EventListener
,PropertyChangeFirer
,PropertyChangeProvider
,SilenceablePropertyChangeProvider
,VetoableChangeFirer
,VetoableChangeProvider
,Manager<Sensor>
,Manager.ManagerDataListener<Sensor>
,NameIncrementingManager
,ProvidingManager<Sensor>
,ProxyManager<Sensor>
,SensorManager
public class ProxySensorManager extends AbstractProvidingProxyManager<Sensor> implements SensorManager
Implementation of a SensorManager 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 ProxySensorManager()
-
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.long
getDefaultSensorDebounceGoingActive()
long
getDefaultSensorDebounceGoingInActive()
java.lang.Class<Sensor>
getNamedBeanClass()
Get the class of NamedBean supported by this Manager.Sensor
getSensor(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.boolean
isPullResistanceConfigurable()
Do the sensor objects provided by this manager support configuring an internal pull up or pull down resistor?boolean
isPullResistanceConfigurable(java.lang.String systemName)
Do the sensor objects provided by the manager for this system name support configuring an internal pull up or pull down resistor?protected Sensor
makeBean(Manager<Sensor> manager, java.lang.String systemName, java.lang.String userName)
Defer creation of the proper type to the subclass.protected AbstractManager<Sensor>
makeInternalManager()
Create specific internal manager as needed for concrete type.Sensor
newSensor(java.lang.String systemName, java.lang.String userName)
Return a Sensor with the specified user or system name.Sensor
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.Sensor
provideSensor(java.lang.String sName)
Get the Sensor with the user name, then system name if needed; if that fails, create a new Sensor.void
setDefaultSensorDebounceGoingActive(long timer)
void
setDefaultSensorDebounceGoingInActive(long timer)
void
updateAll()
Triggers #updateAll on all SensorManagers.-
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, 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.SensorManager
createSystemName, dispose, 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
-
ProxySensorManager
public ProxySensorManager()
-
-
Method Detail
-
makeInternalManager
protected AbstractManager<Sensor> makeInternalManager()
Description copied from class:AbstractProxyManager
Create specific internal manager as needed for concrete type.- Specified by:
makeInternalManager
in classAbstractProxyManager<Sensor>
- Returns:
- an internal manager
-
getSensor
@CheckForNull public Sensor getSensor(@Nonnull java.lang.String name)
Locate via user name, then system name if needed.- Specified by:
getSensor
in interfaceSensorManager
- Parameters:
name
- User name or system name to match- Returns:
- Null if nothing by that name exists
-
makeBean
@Nonnull protected Sensor makeBean(Manager<Sensor> manager, java.lang.String systemName, java.lang.String userName) throws java.lang.IllegalArgumentException
Defer creation of the proper type to the subclass.- Specified by:
makeBean
in classAbstractProvidingProxyManager<Sensor>
- Parameters:
manager
- the manager to invokesystemName
- the system nameuserName
- the user name- Returns:
- a bean
- Throws:
java.lang.IllegalArgumentException
- if unable to make.
-
provideSensor
@Nonnull public Sensor provideSensor(@Nonnull java.lang.String sName) throws java.lang.IllegalArgumentException
Description copied from interface:SensorManager
Get the Sensor with the user name, then system name if needed; if that fails, create a new Sensor. If the name is a valid system name, it will be used for the new Sensor. Otherwise, theManager.makeSystemName(java.lang.String)
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:
provideSensor
in interfaceSensorManager
- Parameters:
sName
- User name, system name, or address which can be promoted to system name- Returns:
- Never null
- Throws:
java.lang.IllegalArgumentException
- if Sensor doesn't already exist and the manager cannot create the Sensor due to an illegal name or name that can't be parsed.
-
provide
@Nonnull public Sensor 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<Sensor>
- Specified by:
provide
in interfaceSensorManager
- 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.
-
newSensor
@Nonnull public Sensor newSensor(@Nonnull java.lang.String systemName, java.lang.String userName) throws java.lang.IllegalArgumentException
Return a Sensor with the specified user or system name. Return Sensor by UserName else provide by SystemName.Note that two calls with the same arguments will get the same instance; there is only one Sensor object representing a given physical turnout and therefore only one with a specific system or user name.
This will always return a valid object reference; 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 Sensor object created; a valid system name must be provided
- If both names are provided, the system name defines the hardware access of the desired sensor, and the user address is associated with it. The system name must be valid.
- Specified by:
newSensor
in interfaceSensorManager
- Parameters:
systemName
- the desired system nameuserName
- the desired user name- Returns:
- requested Sensor object
- Throws:
java.lang.IllegalArgumentException
- if cannot create the Sensor due to e.g. an illegal name or name that can't be parsed.
-
updateAll
public void updateAll()
Triggers #updateAll on all SensorManagers.- Specified by:
updateAll
in interfaceSensorManager
-
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
-
getDefaultSensorDebounceGoingActive
public long getDefaultSensorDebounceGoingActive()
- Specified by:
getDefaultSensorDebounceGoingActive
in interfaceSensorManager
-
getDefaultSensorDebounceGoingInActive
public long getDefaultSensorDebounceGoingInActive()
- Specified by:
getDefaultSensorDebounceGoingInActive
in interfaceSensorManager
-
setDefaultSensorDebounceGoingActive
public void setDefaultSensorDebounceGoingActive(long timer)
- Specified by:
setDefaultSensorDebounceGoingActive
in interfaceSensorManager
-
setDefaultSensorDebounceGoingInActive
public void setDefaultSensorDebounceGoingInActive(long timer)
- Specified by:
setDefaultSensorDebounceGoingInActive
in interfaceSensorManager
-
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<Sensor>
- Returns:
- write order for this Manager; larger is later.
-
getBeanTypeHandled
@Nonnull public java.lang.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 interfaceManager<Sensor>
- 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<Sensor> 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<Sensor>
- Returns:
- the class supported by this Manager.
-
isPullResistanceConfigurable
public boolean isPullResistanceConfigurable()
Do the sensor objects provided by this manager support configuring an internal pull up or pull down resistor?- Specified by:
isPullResistanceConfigurable
in interfaceSensorManager
- Returns:
- true if pull up/pull down configuration is supported, default to false to satisfy the SensorManager interface
-
isPullResistanceConfigurable
public boolean isPullResistanceConfigurable(java.lang.String systemName)
Do the sensor objects provided by the manager for this system name support configuring an internal pull up or pull down resistor?- Parameters:
systemName
- to select correct manager- Returns:
- true if pull up/pull down configuration is supported
-
-