Class CbusReporterManager
- java.lang.Object
-
- jmri.beans.PropertyChangeSupport
-
- jmri.beans.VetoableChangeSupport
-
- jmri.managers.AbstractManager<Reporter>
-
- jmri.managers.AbstractReporterManager
-
- jmri.jmrix.can.cbus.CbusReporterManager
-
- All Implemented Interfaces:
java.beans.PropertyChangeListener
,java.beans.VetoableChangeListener
,java.util.EventListener
,PropertyChangeFirer
,PropertyChangeProvider
,SilenceablePropertyChangeProvider
,VetoableChangeFirer
,VetoableChangeProvider
,Manager<Reporter>
,NameIncrementingManager
,ProvidingManager<Reporter>
,ReporterManager
public class CbusReporterManager extends AbstractReporterManager
Implement ReporterManager for CAN CBUS systems.System names are "MRnnnnn", where M is the user-configurable system getSystemPrefix(), nnnnn is the reporter number without padding.
CBUS Reporters are NOT automatically created.
-
-
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 Modifier and Type Field Description protected static java.lang.String
CBUS_DEFAULT_REPORTER_TYPE
protected static java.lang.String
CBUS_MAINTAIN_SENSOR_DESCRIPTOR_KEY
protected static java.lang.String
CBUS_REPORTER_DESCRIPTOR_KEY
protected static java.lang.String
CBUS_REPORTER_TYPE_CLASSIC
protected static java.lang.String
CBUS_REPORTER_TYPE_DDES_DESCRIBING
(package private) static java.lang.String[]
CBUS_REPORTER_TYPE_TIPS
(package private) static java.lang.String[]
CBUS_REPORTER_TYPES
-
Fields inherited from class jmri.managers.AbstractManager
_beans, _tsys, _tuser, memo, 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 CbusReporterManager(CanSystemConnectionMemo memo)
-
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.protected Reporter
createNewReporter(java.lang.String systemName, java.lang.String userName)
Internal method to invoke the factory, after all the logic for returning an existing Reporter has been invoked.java.lang.String
getEntryToolTip()
Get a manager-specific tool tip for adding an entry to the manager.java.util.List<NamedBeanPropertyDescriptor<?>>
getKnownBeanProperties()
By default there are no custom properties.CanSystemConnectionMemo
getMemo()
Get the system connection for this manager.int
getTimeout()
Get the Reporter Timeout.void
setTimeout(int timeout)
Set the Reporter timeout.java.lang.String
validateSystemNameFormat(java.lang.String name, java.util.Locale locale)
Validates to only numeric system names.Manager.NameValidity
validSystemNameFormat(java.lang.String systemName)
Test if parameter is a properly formatted system name.-
Methods inherited from class jmri.managers.AbstractReporterManager
getBeanTypeHandled, getByDisplayName, getNamedBeanClass, getReporter, getXMLOrder, newReporter, provideReporter, typeLetter
-
Methods inherited from class jmri.managers.AbstractManager
addDataListener, checkNumeric, createSystemName, deleteBean, deregister, dispose, fireDataListenersAdded, fireDataListenersRemoved, fireVetoableChange, getAutoSystemName, getBySystemName, getBySystemName, getByUserName, getNamedBean, getNamedBeanSet, getObjectCount, getOuterBean, getSystemPrefix, handleUserNameUniqueness, makeSystemName, propertyChange, register, registerSelf, registerUserName, removeDataListener, setDataListenerMute, setPropertyChangesSilenced, updateAutoNumber, vetoableChange
-
Methods inherited from class jmri.beans.VetoableChangeSupport
addVetoableChangeListener, addVetoableChangeListener, fireVetoableChange, fireVetoableChange, fireVetoableChange, getVetoableChangeListeners, getVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener
-
Methods inherited from class jmri.beans.PropertyChangeSupport
addPropertyChangeListener, addPropertyChangeListener, fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener
-
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, getNamedBean, getNamedBeanSet, getObjectCount, getSubSystemNamePrefix, getSystemNamePrefix, getSystemPrefix, isValidSystemNameFormat, makeSystemName, makeSystemName, makeSystemName, register, removeDataListener, setDataListenerMute, validateBadCharsInSystemNameFormat, validateIntegerSystemNameFormat, validateNmraAccessorySystemNameFormat, validateSystemNameFormat, validateSystemNameFormatOnlyNumeric, validateSystemNamePrefix, validateTrimmedMin1NumberSystemNameFormat, validateTrimmedSystemNameFormat, validateUppercaseTrimmedSystemNameFormat
-
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, provide
-
Methods inherited from interface jmri.beans.SilenceablePropertyChangeProvider
setPropertyChangesSilenced
-
Methods inherited from interface jmri.beans.VetoableChangeProvider
addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener
-
-
-
-
Field Detail
-
CBUS_REPORTER_DESCRIPTOR_KEY
protected static final java.lang.String CBUS_REPORTER_DESCRIPTOR_KEY
- See Also:
- Constant Field Values
-
CBUS_REPORTER_TYPE_CLASSIC
protected static final java.lang.String CBUS_REPORTER_TYPE_CLASSIC
- See Also:
- Constant Field Values
-
CBUS_REPORTER_TYPE_DDES_DESCRIBING
protected static final java.lang.String CBUS_REPORTER_TYPE_DDES_DESCRIBING
- See Also:
- Constant Field Values
-
CBUS_REPORTER_TYPES
static final java.lang.String[] CBUS_REPORTER_TYPES
-
CBUS_REPORTER_TYPE_TIPS
static final java.lang.String[] CBUS_REPORTER_TYPE_TIPS
-
CBUS_DEFAULT_REPORTER_TYPE
protected static final java.lang.String CBUS_DEFAULT_REPORTER_TYPE
-
CBUS_MAINTAIN_SENSOR_DESCRIPTOR_KEY
protected static final java.lang.String CBUS_MAINTAIN_SENSOR_DESCRIPTOR_KEY
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CbusReporterManager
public CbusReporterManager(CanSystemConnectionMemo memo)
-
-
Method Detail
-
getMemo
@Nonnull public CanSystemConnectionMemo getMemo()
Get the system connection for this manager.
-
createNewReporter
@Nonnull protected Reporter createNewReporter(@Nonnull java.lang.String systemName, java.lang.String userName) throws java.lang.IllegalArgumentException
Internal method to invoke the factory, after all the logic for returning an existing Reporter has been invoked.- Specified by:
createNewReporter
in classAbstractReporterManager
- Parameters:
systemName
- system name.userName
- username.- Returns:
- never null
- Throws:
java.lang.IllegalArgumentException
-
validSystemNameFormat
public Manager.NameValidity validSystemNameFormat(@Nonnull java.lang.String systemName)
Test if parameter is a properly formatted system name. Implementations of this method must not throw an exception, log an error, or otherwise disrupt the user. Checks for reporter number between 0 and 65535- Specified by:
validSystemNameFormat
in interfaceManager<Reporter>
- Overrides:
validSystemNameFormat
in classAbstractManager<Reporter>
- Parameters:
systemName
- the system name- Returns:
Manager.NameValidity.INVALID
if system name does not start withManager.getSystemNamePrefix()
;Manager.NameValidity.VALID_AS_PREFIX_ONLY
if system name equalsManager.getSystemNamePrefix()
; otherwiseManager.NameValidity.VALID
to allow Managers that do not perform more specific validation to be considered valid.
-
allowMultipleAdditions
public boolean allowMultipleAdditions(@Nonnull java.lang.String systemName)
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.
- Parameters:
systemName
- the system name to check against; appears to be ignored in all implementations- Returns:
- true if possible; false otherwise
-
getEntryToolTip
public java.lang.String getEntryToolTip()
Get a manager-specific tool tip for adding an entry to the manager.- Specified by:
getEntryToolTip
in interfaceManager<Reporter>
- Specified by:
getEntryToolTip
in interfaceReporterManager
- Overrides:
getEntryToolTip
in classAbstractReporterManager
- Returns:
- the tool tip or null to disable the tool tip
-
validateSystemNameFormat
@Nonnull public java.lang.String validateSystemNameFormat(@Nonnull java.lang.String name, @Nonnull java.util.Locale locale) throws NamedBean.BadSystemNameException
Validates to only numeric system names. Validate the format of name, returning it unchanged if valid.Although further restrictions may be added by system-specific implementations, at a minimum, the implementation must consider a name that does not start with the System Name prefix for this manager to be invalid, and must consider a name that is the same as the System Name prefix to be invalid.
Overriding implementations may rely on
Manager.validSystemNameFormat(java.lang.String)
, however they must provide an actionable message in the thrown exception if that method does not returnManager.NameValidity.VALID
. When overriding implementations of this method rely on validSystemNameFormat(), implementations of that method must not throw an exception, log an error, or otherwise disrupt the user.- Parameters:
name
- the system name to validatelocale
- the locale for a localized exception; this is needed for the JMRI web server, which supports multiple locales- Returns:
- the unchanged value of the name parameter
- Throws:
NamedBean.BadSystemNameException
- if provided name is an invalid format
-
getKnownBeanProperties
@Nonnull public java.util.List<NamedBeanPropertyDescriptor<?>> getKnownBeanProperties()
Description copied from class:AbstractManager
By default there are no custom properties.- Specified by:
getKnownBeanProperties
in interfaceManager<Reporter>
- Overrides:
getKnownBeanProperties
in classAbstractManager<Reporter>
- Returns:
- empty list
-
setTimeout
public void setTimeout(int timeout)
Set the Reporter timeout.- Parameters:
timeout
- time in milliseconds that CbusReporters stay at IdTag.SEEN after hearing an ID Tag.
-
getTimeout
public int getTimeout()
Get the Reporter Timeout.- Returns:
- milliseconds for CbusReporters to return to IdTag.UNSEEN
-
-