Package jmri.managers
Class AbstractReporterManager
- java.lang.Object
-
- jmri.beans.PropertyChangeSupport
-
- jmri.beans.VetoableChangeSupport
-
- jmri.managers.AbstractManager<Reporter>
-
- jmri.managers.AbstractReporterManager
-
- All Implemented Interfaces:
java.beans.PropertyChangeListener
,java.beans.VetoableChangeListener
,java.util.EventListener
,PropertyChangeFirer
,PropertyChangeProvider
,SilenceablePropertyChangeProvider
,VetoableChangeFirer
,VetoableChangeProvider
,Manager<Reporter>
,NameIncrementingManager
,ProvidingManager<Reporter>
,ReporterManager
- Direct Known Subclasses:
BiDiBReporterManager
,CbusReporterManager
,Dcc4PcReporterManager
,EcosReporterManager
,InternalReporterManager
,JMRIClientReporterManager
,LnReporterManager
,MqttReporterManager
,OlcbReporterManager
,RfidReporterManager
,RpsReporterManager
,Z21ReporterManager
public abstract class AbstractReporterManager extends AbstractManager<Reporter> implements ReporterManager
Abstract partial implementation of a ReporterManager.
-
-
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.AbstractManager
_beans, _tsys, _tuser, lastAutoNamedBeanRef, memo, paddedNumber, 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 AbstractReporterManager(SystemConnectionMemo memo)
Create a new ReporterManager instance.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract 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
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.String
getEntryToolTip()
Get a manager-specific tool tip for adding an entry to the manager.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.Reporter
newReporter(java.lang.String systemName, java.lang.String userName)
Return an instance with the specified system and user names.Reporter
provideReporter(java.lang.String sName)
Locate via user name, then system name if needed.char
typeLetter()
-
Methods inherited from class jmri.managers.AbstractManager
addDataListener, checkNumeric, createSystemName, deleteBean, deregister, dispose, fireDataListenersAdded, fireDataListenersRemoved, fireVetoableChange, getAutoSystemName, getBySystemName, getBySystemName, getByUserName, getKnownBeanProperties, getMemo, getNamedBean, getNamedBeanSet, getObjectCount, getOuterBean, getSystemPrefix, handleUserNameUniqueness, makeSystemName, propertyChange, register, registerSelf, registerUserName, removeDataListener, setDataListenerMute, setPropertyChangesSilenced, setRegisterSelf, updateAutoNumber, validSystemNameFormat, 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, getKnownBeanProperties, getMemo, getNamedBean, getNamedBeanSet, getObjectCount, getSubSystemNamePrefix, getSystemNamePrefix, getSystemPrefix, isValidSystemNameFormat, makeSystemName, makeSystemName, makeSystemName, register, removeDataListener, setDataListenerMute, validateBadCharsInSystemNameFormat, validateIntegerSystemNameFormat, validateNmraAccessorySystemNameFormat, validateSystemNameFormat, validateSystemNameFormat, validateSystemNameFormatOnlyNumeric, validateSystemNamePrefix, validateTrimmedMin1NumberSystemNameFormat, validateTrimmedSystemNameFormat, validateUppercaseTrimmedSystemNameFormat, validSystemNameFormat
-
Methods inherited from interface jmri.NameIncrementingManager
allowMultipleAdditions, 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
-
-
-
-
Constructor Detail
-
AbstractReporterManager
public AbstractReporterManager(SystemConnectionMemo memo)
Create a new ReporterManager instance.- Parameters:
memo
- the system connection
-
-
Method Detail
-
getXMLOrder
public int getXMLOrder()
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.
-
typeLetter
public char typeLetter()
- Specified by:
typeLetter
in interfaceManager<Reporter>
- Returns:
- The type letter for a specific implementation
-
provideReporter
@Nonnull public Reporter provideReporter(@Nonnull java.lang.String sName) throws java.lang.IllegalArgumentException
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.
-
getReporter
@CheckForNull public Reporter getReporter(@Nonnull java.lang.String name)
Locate via user name, then system name if needed. If that fails, return null- Specified by:
getReporter
in interfaceReporterManager
- Parameters:
name
- User name or system name to match- Returns:
- null if no match found
-
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.
-
getByDisplayName
@CheckForNull public Reporter getByDisplayName(@Nonnull java.lang.String key)
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, @CheckForNull java.lang.String userName) throws java.lang.IllegalArgumentException
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; 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 both names are provided, the system name defines the hardware access of the desired Reporter, and the user address is associated with it. The system name must be valid.
- 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.
-
createNewReporter
@Nonnull protected abstract 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.- Parameters:
systemName
- system name.userName
- username.- Returns:
- never null
- Throws:
java.lang.IllegalArgumentException
-
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
- Returns:
- the tool tip or null to disable the tool tip
-
-