Package jmri.jmrix.acela

Class AcelaLightManager

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.beans.VetoableChangeSupport

jmri.managers.AbstractManager<Light>

jmri.managers.AbstractLightManager

jmri.jmrix.acela.AcelaLightManager

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.beans.VetoableChangeListener, java.util.EventListener, PropertyChangeFirer, PropertyChangeProvider, SilenceablePropertyChangeProvider, VetoableChangeFirer, VetoableChangeProvider, LightManager, Manager<Light>, NameIncrementingManager, ProvidingManager<Light>

public class AcelaLightManager
extends AbstractLightManager

Implement LightManager for Acela systems.

System names are "ALnnn", where A is the user configurable system prefix, nnn is the bit number without padding.

Based in part on AcelaTurnoutManager.java

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, 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, PROPERTY_BEANS, PROPERTY_CAN_DELETE, PROPERTY_DISPLAY_LIST_NAME, PROPERTY_DO_DELETE, PROPERTY_DO_NOT_DELETE, PROPERTY_LENGTH, REPORTERS, ROUTES, SECTIONS, SENSORGROUPS, SENSORS, SIGNALGROUPS, SIGNALHEADS, SIGNALMASTLOGICS, SIGNALMASTS, STRINGIOS, TIMEBASE, TRANSITS, TURNOUTS, WARRANTS

Constructor Summary

Constructors

Constructor	Description
AcelaLightManager(AcelaSystemConnectionMemo memo)

Method Summary

Modifier and Type	Method	Description
java.lang.String	convertSystemNameToAlternate(java.lang.String systemName)	Public method to convert system name to its alternate format.
protected Light	createNewLight(java.lang.String systemName, java.lang.String userName)	Method to create a new Light based on the system name.
AcelaSystemConnectionMemo	getMemo()	Get the system connection for this manager.
java.lang.String	validateSystemNameFormat(java.lang.String systemName, java.util.Locale locale)	Validate the format of name, returning it unchanged if valid.
boolean	validSystemNameConfig(java.lang.String systemName)	Public method to validate system name for configuration.
Manager.NameValidity	validSystemNameFormat(java.lang.String systemName)	Test if parameter is a properly formatted system name.

Methods inherited from class jmri.managers.AbstractLightManager

activateAllLights, getBeanTypeHandled, getEntryToolTip, getLight, getNamedBeanClass, getXMLOrder, newLight, provideLight, supportsVariableLights, typeLetter

Methods inherited from class jmri.managers.AbstractManager

addDataListener, checkNumeric, createSystemName, deleteBean, deregister, dispose, fireDataListenersAdded, fireDataListenersRemoved, fireVetoableChange, getAutoSystemName, getBySystemName, getBySystemName, getByUserName, getKnownBeanProperties, 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.LightManager

createSystemName, dispose, getBySystemName, getByUserName, provide

Methods inherited from interface jmri.Manager

addDataListener, deleteBean, deregister, getBeanTypeHandled, getKnownBeanProperties, 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

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

Constructor Detail

AcelaLightManager

public AcelaLightManager(AcelaSystemConnectionMemo memo)

Method Detail

getMemo

@Nonnull
public AcelaSystemConnectionMemo getMemo()

Description copied from class: AbstractManager

Get the system connection for this manager.

Specified by:

getMemo in interface Manager<Light>

Overrides:

getMemo in class AbstractManager<Light>

Returns:

the system connection for this manager

createNewLight

@Nonnull
protected Light createNewLight(@Nonnull
                               java.lang.String systemName,
                               java.lang.String userName)
                        throws java.lang.IllegalArgumentException

Method to create a new Light based on the system name.

Assumes calling method has checked that a Light with this system name does not already exist.

Specified by:

createNewLight in class AbstractLightManager

Parameters:

systemName - the system name to use for this light

userName - the user name to use for this light

Returns:

null if the system name is not in a valid format

Throws:

java.lang.IllegalArgumentException - something failed in the names

validateSystemNameFormat

@Nonnull
public java.lang.String validateSystemNameFormat(@Nonnull
                                                 java.lang.String systemName,
                                                 @Nonnull
                                                 java.util.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.

Verifies system name has valid prefix and is an integer from 0 to 16383.

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

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.

Specified by:

validSystemNameFormat in interface Manager<Light>

Overrides:

validSystemNameFormat in class AbstractManager<Light>

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.

validSystemNameConfig

public boolean validSystemNameConfig(@Nonnull
                                     java.lang.String systemName)

Public method to validate system name for configuration.

Parameters:

systemName - the system name

Returns:

'true' if system name has a valid meaning in current configuration, else returns 'false'

convertSystemNameToAlternate

@Nonnull
public java.lang.String convertSystemNameToAlternate(@Nonnull
                                                     java.lang.String systemName)

Public method to convert system name to its alternate format.

Specified by:

convertSystemNameToAlternate in interface LightManager

Overrides:

convertSystemNameToAlternate in class AbstractLightManager

Parameters:

systemName - the system name to convert

Returns:

a normalized system name if system name is valid and has a valid alternate representation, else return ""