Package jmri.jmrix.loconet

Class LnReporterManager

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.beans.VetoableChangeSupport

jmri.managers.AbstractManager<Reporter>

jmri.managers.AbstractReporterManager

jmri.jmrix.loconet.LnReporterManager

All Implemented Interfaces:

PropertyChangeListener, VetoableChangeListener, EventListener, PropertyChangeFirer, PropertyChangeProvider, SilenceablePropertyChangeProvider, VetoableChangeFirer, VetoableChangeProvider, LocoNetListener, Manager<Reporter>, ProvidingManager<Reporter>, ReporterManager

public class LnReporterManager
extends AbstractReporterManager
implements LocoNetListener

Manage the LocoNet-specific Reporter implementation.

System names are "LRnnn", where L is the user configurable system prefix, nnn is the Reporter number without padding.

Some of the message formats used in this class are Copyright Digitrax, Inc. and used with permission as part of the JMRI project. That permission does not extend to uses in other software products. If you wish to use this code, algorithm or these message formats outside of JMRI, please contact Digitrax Inc for separate permission.

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 LnTrafficController	tc

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, deprecatedManagerLogger, ENTRYEXIT, IDTAGS, LAYOUTBLOCKS, LIGHTS, LOGIXNG_ANALOG_ACTIONS, LOGIXNG_ANALOG_EXPRESSIONS, LOGIXNG_CONDITIONALNGS, LOGIXNG_DIGITAL_ACTIONS, LOGIXNG_DIGITAL_BOOLEAN_ACTIONS, LOGIXNG_DIGITAL_EXPRESSIONS, 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
LnReporterManager(LocoNetSystemConnectionMemo memo)

Method Summary

Modifier and Type	Method	Description
Reporter	createNewReporter(String systemName, String userName)	Internal method to invoke the factory, after all the logic for returning an existing Reporter has been invoked.
void	dispose()	Free resources when no longer used.
int	getBitFromSystemName(String systemName)	Get the bit address from the system name.
String	getEntryToolTip()	Get a manager-specific tool tip for adding an entry to the manager.
LocoNetSystemConnectionMemo	getMemo()	Get the system connection for this manager.
void	message(LocoNetMessage l)	Member function that will be invoked by a LocoNetInterface implementation to forward a LocoNet message from the layout.
String	validateSystemNameFormat(String systemName, Locale locale)	Validate the format of name, returning it unchanged if valid.
Manager.NameValidity	validSystemNameFormat(String systemName)	Test if parameter is a properly formatted system name.

Methods inherited from class jmri.managers.AbstractReporterManager

allowMultipleAdditions, getBeanTypeHandled, getByDisplayName, getNamedBeanClass, getReporter, getXMLOrder, newReporter, provideReporter, typeLetter

Methods inherited from class jmri.managers.AbstractManager

addDataListener, checkNumeric, createSystemName, deleteBean, deregister, fireDataListenersAdded, fireDataListenersRemoved, fireVetoableChange, getAutoSystemName, getBySystemName, getBySystemName, getByUserName, getIncrement, getIncrementFromExistingNumber, getInstanceBySystemName, getInstanceByUserName, getKnownBeanProperties, getNamedBean, getNamedBeanList, getNamedBeanSet, getNextValidAddress, getNextValidAddress, getObjectCount, getSystemNameList, 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, getBeanBySystemName, getBeanByUserName, getBeanTypeHandled, getKnownBeanProperties, getNamedBean, getNamedBeanList, getNamedBeanSet, getObjectCount, getSubSystemNamePrefix, getSystemNameList, getSystemNamePrefix, getSystemPrefix, isValidSystemNameFormat, makeSystemName, makeSystemName, makeSystemName, register, removeDataListener, setDataListenerMute, setPropertyChangesMuted, validateBadCharsInSystemNameFormat, validateIntegerSystemNameFormat, validateNmraAccessorySystemNameFormat, validateSystemNameFormat, validateSystemNameFormatOnlyNumeric, validateSystemNamePrefix, validateTrimmedMin1NumberSystemNameFormat, validateTrimmedSystemNameFormat, validateUppercaseTrimmedSystemNameFormat

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface jmri.ReporterManager

createSystemName, getBySystemName, getByUserName, getNextValidAddress, getNextValidAddress, provide

Methods inherited from interface jmri.beans.SilenceablePropertyChangeProvider

setPropertyChangesSilenced

Methods inherited from interface jmri.beans.VetoableChangeProvider

addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener

Field Details

tc

protected final LnTrafficController tc

Constructor Details

LnReporterManager

public LnReporterManager(LocoNetSystemConnectionMemo memo)

Method Details

getMemo

@Nonnull public LocoNetSystemConnectionMemo getMemo()

Get the system connection for this manager.

Specified by:

getMemo in interface Manager<Reporter>

Overrides:

getMemo in class AbstractManager<Reporter>

Returns:

the system connection for this manager

dispose

public void dispose()

Description copied from class: AbstractManager

Free resources when no longer used. Specifically, remove all references to and from this object, so it can be garbage-collected.

Specified by:

dispose in interface Manager<Reporter>

Overrides:

dispose in class AbstractManager<Reporter>

createNewReporter

public Reporter createNewReporter(@Nonnull String systemName, String userName)

Description copied from class: AbstractReporterManager

Internal method to invoke the factory, after all the logic for returning an existing Reporter has been invoked.

Specified by:

createNewReporter in class AbstractReporterManager

Parameters:

systemName - system name.

userName - username.

Returns:

never null

validSystemNameFormat

public Manager.NameValidity validSystemNameFormat(@Nonnull 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.

Specified by:

validSystemNameFormat in interface Manager<Reporter>

Overrides:

validSystemNameFormat in class AbstractManager<Reporter>

Parameters:

systemName - the system name

Returns:

Manager.NameValidity.INVALID if system name does not start with Manager.getSystemNamePrefix(); Manager.NameValidity.VALID_AS_PREFIX_ONLY if system name equals Manager.getSystemNamePrefix(); otherwise Manager.NameValidity.VALID to allow Managers that do not perform more specific validation to be considered valid.

validateSystemNameFormat

@Nonnull public String validateSystemNameFormat(@Nonnull String systemName, @Nonnull Locale locale)

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 return Manager.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.

Specified by:

validateSystemNameFormat in interface Manager<Reporter>

Parameters:

systemName - the system name to validate

locale - 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

getBitFromSystemName

public int getBitFromSystemName(String systemName)

Get the bit address from the system name.

Parameters:

systemName - a valid LocoNet-based Reporter System Name

Returns:

the turnout number extracted from the system name

getEntryToolTip

public String getEntryToolTip()

Get a manager-specific tool tip for adding an entry to the manager.

Specified by:

getEntryToolTip in interface Manager<Reporter>

Specified by:

getEntryToolTip in interface ReporterManager

Overrides:

getEntryToolTip in class AbstractReporterManager

Returns:

the tool tip or null to disable the tool tip

message

public void message(LocoNetMessage l)

Description copied from interface: LocoNetListener

Member function that will be invoked by a LocoNetInterface implementation to forward a LocoNet message from the layout.

Specified by:

message in interface LocoNetListener

Parameters:

l - The received LocoNet message. Note that this same object may be presented to multiple users. It should not be modified here.