Package jmri.jmrit.logixng.implementation

Class DefaultLogixNGManager

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.beans.VetoableChangeSupport

jmri.managers.AbstractManager<LogixNG>

jmri.jmrit.logixng.implementation.DefaultLogixNGManager

All Implemented Interfaces:

PropertyChangeListener, VetoableChangeListener, EventListener, PropertyChangeFirer, PropertyChangeProvider, SilenceablePropertyChangeProvider, VetoableChangeFirer, VetoableChangeProvider, LogixNG_Manager, Manager<LogixNG>

public class DefaultLogixNGManager
extends AbstractManager<LogixNG>
implements LogixNG_Manager

Class providing the basic logic of the LogixNG_Manager interface.

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
(package private) static DefaultLogixNGManager	_instance

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.jmrit.logixng.LogixNG_Manager

ERROR_HANDLING_MODULE_NAME, PROPERTY_SETUP

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
DefaultLogixNGManager()

Method Summary

Modifier and Type	Method	Description
void	activateAllLogixNGs()	Activate all LogixNGs, starts LogixNG processing by connecting all inputs that are included the ConditionalNGs in this LogixNG.
void	activateAllLogixNGs(boolean runDelayed, boolean runOnSeparateThread)	Activate all LogixNGs, starts LogixNG processing by connecting all inputs that are included the ConditionalNGs in this LogixNG.
LogixNG	createLogixNG(String userName)	For use with User GUI, to allow the auto generation of systemNames, where the user can optionally supply a username.
LogixNG	createLogixNG(String userName, boolean inline)	For use with User GUI, to allow the auto generation of systemNames, where the user can optionally supply a username.
LogixNG	createLogixNG(String systemName, String userName)	Method to create a new LogixNG if the LogixNG does not exist.
LogixNG	createLogixNG(String systemName, String userName, boolean inline)	Method to create a new LogixNG if the LogixNG does not exist.
void	deActivateAllLogixNGs()	DeActivate all LogixNGs, stops LogixNG processing by disconnecting all inputs that are included the ConditionalNGs in this LogixNG.
final void	deleteBean(LogixNG logixNG, String property)	Method for a UI to delete a bean.
void	deleteLogixNG(LogixNG x)	Delete LogixNG by removing it from the manager.
void	executeModule(Module module, Object parameter)	Executes a LogixNG Module.
void	executeModule(Module module, Map<String,Object> parameters)	Executes a LogixNG Module.
void	fireVetoableChange(String p, Object old)	Inform all registered listeners of a vetoable change.If the propertyName is "CanDelete" ALL listeners with an interest in the bean will throw an exception, which is recorded returned back to the invoking method, so that it can be presented back to the user.However if a listener decides that the bean can not be deleted then it should throw an exception with a property name of "DoNotDelete", this is thrown back up to the user and the delete process should be aborted.
String	getBeanTypeHandled(boolean plural)	Get the user-readable name of the type of NamedBean handled by this manager.
LogixNG	getBySystemName(String name)	Locate an existing instance based on a system name.
LogixNG	getByUserName(String name)	Locate an existing instance based on a user name.
Clipboard	getClipboard()	Get the clipboard
FemaleSocket	getErrorHandlingModuleSocket()	Get the female socket of the error handling module.
LogixNG	getLogixNG(String name)	Locate via user name, then system name if needed.
Manager<? extends MaleSocket>	getManager(String className)	Get manager by class name
Class<LogixNG>	getNamedBeanClass()	Get the class of NamedBean supported by this Manager.
int	getXMLOrder()	Determine the order that types should be written when storing panel files.
static DefaultLogixNGManager	instance()
boolean	isActive()	Is LogixNGs active?
boolean	isErrorHandlingModuleEnabled()	Is the error handling module enabled?
boolean	isStartLogixNGsOnLoad()	Should the LogixNGs not be started when the configuration file is loaded?
void	printTree(Base.PrintTreeSettings settings, PrintWriter writer, String indent, MutableInt lineNumber)	Print the tree to a stream.
void	printTree(Base.PrintTreeSettings settings, Locale locale, PrintWriter writer, String indent, MutableInt lineNumber)	Print the tree to a stream.
void	propertyChange(PropertyChangeEvent e)	The PropertyChangeListener interface in this class is intended to keep track of user name changes to individual NamedBeans.
void	registerManager(Manager<? extends MaleSocket> manager)	Register a manager for later retrieval by getManager()
void	registerSetupTask(Runnable task)	Register a task to be run when setup LogixNGs
void	setLoadDisabled(boolean value)	Should the LogixNGs be disabled when the configuration file is loaded?
void	setupAllLogixNGs()	Setup all LogixNGs.
void	startLogixNGsOnLoad(boolean value)	Should the LogixNGs be started when the configuration file is loaded?
char	typeLetter()
Manager.NameValidity	validSystemNameFormat(String systemName)	Test if parameter is a properly formatted system name.

Methods inherited from class jmri.managers.AbstractManager

addDataListener, checkNumeric, createSystemName, deregister, dispose, fireDataListenersAdded, fireDataListenersRemoved, fireVetoableChange, getAutoSystemName, getBySystemName, getKnownBeanProperties, getMemo, getNamedBean, getNamedBeanSet, getObjectCount, getOuterBean, getSystemPrefix, handleUserNameUniqueness, makeSystemName, 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.jmrit.logixng.LogixNG_Manager

getAutoSystemName, printTree, printTree

Methods inherited from interface jmri.Manager

addDataListener, deregister, dispose, getBeanTypeHandled, getEntryToolTip, 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

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

Field Details

_instance

static volatile DefaultLogixNGManager _instance

Constructor Details

DefaultLogixNGManager

public DefaultLogixNGManager()

Method Details

getXMLOrder

public int getXMLOrder()

Description copied from interface: Manager

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 interface Manager<LogixNG>

Returns:

write order for this Manager; larger is later.

typeLetter

public char typeLetter()

Specified by:

typeLetter in interface Manager<LogixNG>

Returns:

The type letter for a specific implementation

validSystemNameFormat

public Manager.NameValidity validSystemNameFormat(String systemName)

Test if parameter is a properly formatted system name.

Specified by:

validSystemNameFormat in interface Manager<LogixNG>

Overrides:

validSystemNameFormat in class AbstractManager<LogixNG>

Parameters:

systemName - the system name

Returns:

enum indicating current validity, which might be just as a prefix

createLogixNG

public LogixNG createLogixNG(String systemName,
 String userName)
                      throws IllegalArgumentException

Method to create a new LogixNG if the LogixNG does not exist.

Returns null if a Logix with the same systemName or userName already exists, or if there is trouble creating a new LogixNG.

Specified by:

createLogixNG in interface LogixNG_Manager

Parameters:

systemName - the system name

userName - the user name

Returns:

a new LogixNG or null if unable to create

Throws:

IllegalArgumentException - when needed

createLogixNG

public LogixNG createLogixNG(String systemName,
 String userName,
 boolean inline)
                      throws IllegalArgumentException

Method to create a new LogixNG if the LogixNG does not exist.

Returns null if a Logix with the same systemName or userName already exists, or if there is trouble creating a new LogixNG.

Specified by:

createLogixNG in interface LogixNG_Manager

Parameters:

systemName - the system name

userName - the user name

inline - true if this LogixNG is an inline LogixNG

Returns:

a new LogixNG or null if unable to create

Throws:

IllegalArgumentException - when needed

createLogixNG

public LogixNG createLogixNG(String userName)
                      throws IllegalArgumentException

Description copied from interface: LogixNG_Manager

For use with User GUI, to allow the auto generation of systemNames, where the user can optionally supply a username.

Specified by:

createLogixNG in interface LogixNG_Manager

Parameters:

userName - the user name

Returns:

a new LogixNG or null if unable to create

Throws:

IllegalArgumentException - when needed

createLogixNG

public LogixNG createLogixNG(String userName,
 boolean inline)
                      throws IllegalArgumentException

Description copied from interface: LogixNG_Manager

For use with User GUI, to allow the auto generation of systemNames, where the user can optionally supply a username.

Specified by:

createLogixNG in interface LogixNG_Manager

Parameters:

userName - the user name

inline - true if this LogixNG is an inline LogixNG

Returns:

a new LogixNG or null if unable to create

Throws:

IllegalArgumentException - when needed

getLogixNG

public LogixNG getLogixNG(String name)

Description copied from interface: LogixNG_Manager

Locate via user name, then system name if needed. Does not create a new one if nothing found

Specified by:

getLogixNG in interface LogixNG_Manager

Parameters:

name - User name or system name to match

Returns:

null if no match found

getByUserName

public LogixNG getByUserName(String name)

Description copied from class: AbstractManager

Locate an existing instance based on a user name.

Specified by:

getByUserName in interface LogixNG_Manager

Specified by:

getByUserName in interface Manager<LogixNG>

Overrides:

getByUserName in class AbstractManager<LogixNG>

Parameters:

name - System Name of the required NamedBean

Returns:

requested NamedBean object or null if none exists

getBySystemName

public LogixNG getBySystemName(String name)

Description copied from class: AbstractManager

Locate an existing instance based on a system name.

Specified by:

getBySystemName in interface LogixNG_Manager

Specified by:

getBySystemName in interface Manager<LogixNG>

Overrides:

getBySystemName in class AbstractManager<LogixNG>

Parameters:

name - System Name of the required NamedBean

Returns:

requested NamedBean object or null if none exists

getBeanTypeHandled

public 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 interface Manager<LogixNG>

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

setLoadDisabled

public void setLoadDisabled(boolean value)

Should the LogixNGs be disabled when the configuration file is loaded?

Specified by:

setLoadDisabled in interface LogixNG_Manager

Parameters:

value - true if they should be disabled, false otherwise.

startLogixNGsOnLoad

public void startLogixNGsOnLoad(boolean value)

Should the LogixNGs be started when the configuration file is loaded?

Specified by:

startLogixNGsOnLoad in interface LogixNG_Manager

Parameters:

value - true if they should be started, false otherwise.

isStartLogixNGsOnLoad

public boolean isStartLogixNGsOnLoad()

Should the LogixNGs not be started when the configuration file is loaded?

Specified by:

isStartLogixNGsOnLoad in interface LogixNG_Manager

Returns:

true if they should be started, false otherwise.

setupAllLogixNGs

public void setupAllLogixNGs()

Setup all LogixNGs. This method is called after a configuration file is loaded.

Specified by:

setupAllLogixNGs in interface LogixNG_Manager

activateAllLogixNGs

public void activateAllLogixNGs()

Activate all LogixNGs, starts LogixNG processing by connecting all inputs that are included the ConditionalNGs in this LogixNG.

A LogixNG must be activated before it will calculate any of its ConditionalNGs.

Specified by:

activateAllLogixNGs in interface LogixNG_Manager

activateAllLogixNGs

public void activateAllLogixNGs(boolean runDelayed,
 boolean runOnSeparateThread)

Activate all LogixNGs, starts LogixNG processing by connecting all inputs that are included the ConditionalNGs in this LogixNG.

A LogixNG must be activated before it will calculate any of its ConditionalNGs.

Specified by:

activateAllLogixNGs in interface LogixNG_Manager

Parameters:

runDelayed - true if execute() should run on LogixNG thread delayed, false otherwise.

runOnSeparateThread - true if the activation should run on a separate thread, false otherwise

deActivateAllLogixNGs

public void deActivateAllLogixNGs()

DeActivate all LogixNGs, stops LogixNG processing by disconnecting all inputs that are included the ConditionalNGs in this LogixNG.

A LogixNG must be activated before it will calculate any of its ConditionalNGs.

Specified by:

deActivateAllLogixNGs in interface LogixNG_Manager

isActive

public boolean isActive()

Is LogixNGs active?

Specified by:

isActive in interface LogixNG_Manager

Returns:

true if LogixNGs are active, false otherwise

deleteLogixNG

public void deleteLogixNG(LogixNG x)

Delete LogixNG by removing it from the manager. The LogixNG must first be deactivated so it stops processing.

Specified by:

deleteLogixNG in interface LogixNG_Manager

Parameters:

x - the LogixNG to delete

printTree

public void printTree(Base.PrintTreeSettings settings,
 PrintWriter writer,
 String indent,
 MutableInt lineNumber)

Print the tree to a stream.

Specified by:

printTree in interface LogixNG_Manager

Parameters:

settings - settings for what to print

writer - the stream to print the tree to

indent - the indentation of each level

lineNumber - the line number

printTree

public void printTree(Base.PrintTreeSettings settings,
 Locale locale,
 PrintWriter writer,
 String indent,
 MutableInt lineNumber)

Print the tree to a stream.

Specified by:

printTree in interface LogixNG_Manager

Parameters:

settings - settings for what to print

locale - The locale to be used

writer - the stream to print the tree to

indent - the indentation of each level

lineNumber - the line number

instance

@InvokeOnGuiThread
public static DefaultLogixNGManager instance()

getNamedBeanClass

public Class<LogixNG> 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 interface Manager<LogixNG>

Returns:

the class supported by this Manager.

getClipboard

public Clipboard getClipboard()

Get the clipboard

Specified by:

getClipboard in interface LogixNG_Manager

Returns:

the clipboard

registerManager

public void registerManager(Manager<? extends MaleSocket> manager)

Register a manager for later retrieval by getManager()

Specified by:

registerManager in interface LogixNG_Manager

Parameters:

manager - the manager

getManager

public Manager<? extends MaleSocket> getManager(String className)

Get manager by class name

Specified by:

getManager in interface LogixNG_Manager

Parameters:

className - the class name of the manager

Returns:

the manager

fireVetoableChange

@OverridingMethodsMustInvokeSuper
public void fireVetoableChange(String p,
 Object old)
                        throws PropertyVetoException

Inform all registered listeners of a vetoable change.If the propertyName is "CanDelete" ALL listeners with an interest in the bean will throw an exception, which is recorded returned back to the invoking method, so that it can be presented back to the user.However if a listener decides that the bean can not be deleted then it should throw an exception with a property name of "DoNotDelete", this is thrown back up to the user and the delete process should be aborted.

Parameters:

p - The programmatic name of the property that is to be changed. "CanDelete" will inquire with all listeners if the item can be deleted. "DoDelete" tells the listener to delete the item.

old - The old value of the property.

Throws:

PropertyVetoException - If the recipients wishes the delete to be aborted (see above)

deleteBean

public final void deleteBean(@Nonnull
 LogixNG logixNG,
 @Nonnull
 String property)
                      throws PropertyVetoException

Method for a UI to delete a bean.

The UI should first request a "CanDelete", this will return a list of locations (and descriptions) where the bean is in use via throwing a VetoException, then if that comes back clear, or the user agrees with the actions, then a "DoDelete" can be called which inform the listeners to delete the bean, then it will be deregistered and disposed of.

If a property name of "DoNotDelete" is thrown back in the VetoException then the delete process should be aborted.

Specified by:

deleteBean in interface Manager<LogixNG>

Overrides:

deleteBean in class AbstractManager<LogixNG>

Parameters:

logixNG - The NamedBean to be deleted

property - The programmatic name of the request. "CanDelete" will enquire with all listeners if the item can be deleted. "DoDelete" tells the listener to delete the item

Throws:

PropertyVetoException - If the recipients wishes the delete to be aborted (see above)

registerSetupTask

public void registerSetupTask(Runnable task)

Register a task to be run when setup LogixNGs

Specified by:

registerSetupTask in interface LogixNG_Manager

Parameters:

task - the task

executeModule

public void executeModule(Module module,
 Object parameter)
                   throws IllegalArgumentException

Executes a LogixNG Module. Note that the module must be a Digital Action Module.

Specified by:

executeModule in interface LogixNG_Manager

Parameters:

module - The module to be executed

parameter - The parameter. The module must have exactly one parameter.

Throws:

IllegalArgumentException - If module is null or if module is not a DigitalActionModule.

executeModule

public void executeModule(Module module,
 Map<String,Object> parameters)
                   throws IllegalArgumentException

Executes a LogixNG Module. Note that the module must be a Digital Action Module.

Specified by:

executeModule in interface LogixNG_Manager

Parameters:

module - The module to be executed

parameters - The parameters

Throws:

IllegalArgumentException - If module or parameters is null or if module is not a DigitalActionModule.

getErrorHandlingModuleSocket

public FemaleSocket getErrorHandlingModuleSocket()

Get the female socket of the error handling module.

Specified by:

getErrorHandlingModuleSocket in interface LogixNG_Manager

Returns:

the socket.

isErrorHandlingModuleEnabled

public boolean isErrorHandlingModuleEnabled()

Is the error handling module enabled? It's enabled if it exists and the root socket is connected.

Specified by:

isErrorHandlingModuleEnabled in interface LogixNG_Manager

Returns:

true if it's in use, false otherwise.

propertyChange

@OverridingMethodsMustInvokeSuper
public void propertyChange(PropertyChangeEvent e)

The PropertyChangeListener interface in this class is intended to keep track of user name changes to individual NamedBeans. It is not completely implemented yet. In particular, listeners are not added to newly registered objects.

Specified by:

propertyChange in interface PropertyChangeListener

Overrides:

propertyChange in class AbstractManager<LogixNG>

Parameters:

e - the event