Package jmri.jmrix.mqtt

Class MqttReporterManager

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.beans.VetoableChangeSupport

jmri.managers.AbstractManager<Reporter>

jmri.managers.AbstractReporterManager

jmri.jmrix.mqtt.MqttReporterManager

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 MqttReporterManager
extends AbstractReporterManager

Provide a ReporterManager implementation for MQTT communications

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
java.lang.String	rcvTopicPrefix

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
MqttReporterManager(SystemConnectionMemo memo)

Method Summary

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.
Reporter	createNewReporter(java.lang.String systemName, java.lang.String userName)	Create an new sensor object.
java.lang.String	createSystemName(java.lang.String topicSuffix, java.lang.String prefix)	Create a System Name from hardware address and system letter prefix.
java.lang.String	getEntryToolTip()	Get a manager-specific tool tip for adding an entry to the manager.
MqttSystemConnectionMemo	getMemo()	Get the system connection for this manager.
void	setRcvTopicPrefix(java.lang.String rcvTopicPrefix)
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, deleteBean, deregister, dispose, fireDataListenersAdded, fireDataListenersRemoved, fireVetoableChange, getAutoSystemName, getBySystemName, getBySystemName, getByUserName, getKnownBeanProperties, getNamedBean, getNamedBeanSet, getObjectCount, 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, getKnownBeanProperties, getNamedBean, getNamedBeanSet, getObjectCount, getSubSystemNamePrefix, getSystemNamePrefix, getSystemPrefix, isValidSystemNameFormat, makeSystemName, makeSystemName, makeSystemName, register, removeDataListener, setDataListenerMute, validateBadCharsInSystemNameFormat, validateIntegerSystemNameFormat, validateNmraAccessorySystemNameFormat, validateSystemNameFormat, 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

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

rcvTopicPrefix

@Nonnull
public java.lang.String rcvTopicPrefix

Constructor Detail

MqttReporterManager

public MqttReporterManager(@Nonnull
                           SystemConnectionMemo memo)

Method Detail

getMemo

@Nonnull
public MqttSystemConnectionMemo 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

setRcvTopicPrefix

public void setRcvTopicPrefix(@Nonnull
                              java.lang.String rcvTopicPrefix)

allowMultipleAdditions

public 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.

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

createSystemName

public java.lang.String createSystemName(@Nonnull
                                         java.lang.String topicSuffix,
                                         @Nonnull
                                         java.lang.String prefix)

Create a System Name from hardware address and system letter prefix. AbstractManager performs no validation. Accepts any string.

Specified by:

createSystemName in interface ReporterManager

Overrides:

createSystemName in class AbstractManager<Reporter>

Parameters:

topicSuffix - hardware address, no system prefix or type letter.

prefix - - just system prefix, not including Type Letter.

Returns:

full system name with system prefix, type letter and hardware address.

createNewReporter

@Nonnull
public Reporter createNewReporter(java.lang.String systemName,
                                  java.lang.String userName)

Create an new sensor object. 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(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<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.

getEntryToolTip

public java.lang.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