Interface ReporterManager
-
- All Superinterfaces:
Manager<Reporter>
,NameIncrementingManager
,PropertyChangeProvider
,ProvidingManager<Reporter>
,SilenceablePropertyChangeProvider
,VetoableChangeProvider
- All Known Implementing Classes:
AbstractReporterManager
,BiDiBReporterManager
,CbusReporterManager
,ConcentratorReporterManager
,Dcc4PcReporterManager
,EcosReporterManager
,InternalReporterManager
,JMRIClientReporterManager
,LnReporterManager
,MqttReporterManager
,OlcbReporterManager
,ProxyReporterManager
,RfidReporterManager
,RpsReporterManager
,StandaloneReporterManager
,Z21ReporterManager
public interface ReporterManager extends ProvidingManager<Reporter>, NameIncrementingManager
Locate a Reporter object representing some specific device on the layout.Reporter objects are obtained from a ReporterManager, which in turn is generally located from the InstanceManager. A typical call sequence might be:
Reporter device = InstanceManager.getDefault(jmri.ReporterManager.class).newReporter("23",null);
Each Reporter has a two names. The "user" name is entirely free form, and can be used for any purpose. The "system" name is provided by the system-specific implementations, and provides a unique mapping to the layout control system (for example LocoNet or NCE) and address within that system.
Much of the book-keeping is implemented in the AbstractReporterManager class, which can form the basis for a system-specific implementation.
This file is part of JMRI.JMRI is free software; you can redistribute it and/or modify it under the terms of version 2 of the GNU General Public License as published by the Free Software Foundation. See the "COPYING" file for a copy of this license.
JMRI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
- See Also:
Reporter
,InstanceManager
-
-
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 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
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description java.lang.String
createSystemName(java.lang.String curAddress, java.lang.String prefix)
Get a system name for a given hardware address and system prefix.Reporter
getByDisplayName(java.lang.String userName)
Locate an instance based on a user name, or if that fails, by system name.Reporter
getBySystemName(java.lang.String systemName)
Locate an instance based on a system name.Reporter
getByUserName(java.lang.String userName)
Locate an instance based on a user name.java.lang.String
getEntryToolTip()
Get a manager-specific tool tip for adding an entry to the manager.Reporter
getReporter(java.lang.String name)
Locate via user name, then system name if needed.Reporter
newReporter(java.lang.String systemName, java.lang.String userName)
Return an instance with the specified system and user names.default 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 name)
Locate via user name, then system name if needed.-
Methods inherited from interface jmri.Manager
addDataListener, deleteBean, deregister, dispose, getBeanTypeHandled, getBeanTypeHandled, getKnownBeanProperties, getMemo, getNamedBean, getNamedBeanClass, getNamedBeanSet, getObjectCount, getSubSystemNamePrefix, getSystemNamePrefix, getSystemPrefix, getXMLOrder, 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
allowMultipleAdditions, getNextValidSystemName
-
Methods inherited from interface jmri.beans.PropertyChangeProvider
addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener
-
Methods inherited from interface jmri.beans.SilenceablePropertyChangeProvider
setPropertyChangesSilenced
-
Methods inherited from interface jmri.beans.VetoableChangeProvider
addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener
-
-
-
-
Method Detail
-
provideReporter
@Nonnull Reporter provideReporter(@Nonnull java.lang.String name) 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.- Parameters:
name
- 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 default 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>
- 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.
-
getReporter
@CheckForNull Reporter getReporter(@Nonnull java.lang.String name)
Locate via user name, then system name if needed. If that fails, return null- Parameters:
name
- User name or system name to match- Returns:
- null if no match found
-
getBySystemName
@CheckForNull Reporter getBySystemName(@Nonnull java.lang.String systemName)
Locate an instance based on a system name. Returns null if no instance already exists.- Specified by:
getBySystemName
in interfaceManager<Reporter>
- Parameters:
systemName
- the system name to locate- Returns:
- requested Reporter object or null if none exists
-
getByUserName
@CheckForNull Reporter getByUserName(@Nonnull java.lang.String userName)
Locate an instance based on a user name. Returns null if no instance already exists.- Specified by:
getByUserName
in interfaceManager<Reporter>
- Parameters:
userName
- the user name to locate- Returns:
- requested Reporter object or null if none exists
-
getByDisplayName
@CheckForNull Reporter getByDisplayName(@Nonnull java.lang.String userName)
Locate an instance based on a user name, or if that fails, by system name. Returns null if no instance already exists.- Parameters:
userName
- the name to locate- Returns:
- requested Reporter object or null if none exists
-
newReporter
@Nonnull Reporter newReporter(@Nonnull java.lang.String systemName, 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.
- 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.
-
createSystemName
@Nonnull java.lang.String createSystemName(@Nonnull java.lang.String curAddress, @Nonnull java.lang.String prefix) throws JmriException
Get a system name for a given hardware address and system prefix.- Parameters:
curAddress
- desired hardware addressprefix
- system prefix used in system name, excluding Bean type-letter..- Returns:
- the complete Reporter system name for the prefix and current address
- Throws:
JmriException
- if unable to create a system name for the given address, possibly due to invalid address format
-
getEntryToolTip
java.lang.String getEntryToolTip()
Get a manager-specific tool tip for adding an entry to the manager.- Specified by:
getEntryToolTip
in interfaceManager<Reporter>
- Returns:
- the tool tip or null to disable the tool tip
-
-