Class DefaultModule
- java.lang.Object
-
- jmri.implementation.AbstractNamedBean
-
- jmri.jmrit.logixng.implementation.AbstractBase
-
- jmri.jmrit.logixng.implementation.DefaultModule
-
- All Implemented Interfaces:
java.lang.Comparable<NamedBean>
,PropertyChangeProvider
,Base
,FemaleSocketListener
,Module
,NamedBean
public class DefaultModule extends AbstractBase implements Module, FemaleSocketListener
The default implementation of Module.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface jmri.jmrit.logixng.Base
Base.PrintTreeSettings, Base.RunnableWithBase, Base.RunnableWithBaseThrowException
-
Nested classes/interfaces inherited from interface jmri.jmrit.logixng.Module
Module.Parameter, Module.ParameterData, Module.ReturnValueType
-
Nested classes/interfaces inherited from interface jmri.NamedBean
NamedBean.BadNameException, NamedBean.BadSystemNameException, NamedBean.BadUserNameException, NamedBean.DisplayOptions, NamedBean.DuplicateSystemNameException
-
-
Field Summary
-
Fields inherited from class jmri.jmrit.logixng.implementation.AbstractBase
_listenersAreRegistered
-
Fields inherited from class jmri.implementation.AbstractNamedBean
listenerRefs, mSystemName, register
-
Fields inherited from interface jmri.jmrit.logixng.Base
PRINT_LINE_NUMBERS_FORMAT, PROPERTY_CHILD_COUNT, PROPERTY_CHILD_REORDER, PROPERTY_LAST_RESULT_CHANGED, PROPERTY_SOCKET_CONNECTED, PROPERTY_SOCKET_DISCONNECTED, SEPARATOR, SOCKET_CONNECTED, SOCKET_DISCONNECTED
-
Fields inherited from interface jmri.NamedBean
DISPLAY_NAME_FORMAT, INCONSISTENT, PROPERTY_COMMENT, PROPERTY_ENABLED, PROPERTY_KNOWN_STATE, PROPERTY_STATE, PROPERTY_USERNAME, QUOTED_NAME_FORMAT, UNKNOWN
-
-
Constructor Summary
Constructors Constructor Description DefaultModule(java.lang.String sys, java.lang.String user, FemaleSocketManager.SocketType socketType)
DefaultModule(java.lang.String sys, java.lang.String user, FemaleSocketManager.SocketType socketType, boolean isVisible, boolean storeIfEmpty)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addLocalVariable(java.lang.String name, SymbolTable.InitialValueType initialValueType, java.lang.String initialValueData)
void
addParameter(java.lang.String name, boolean isInput, boolean isOutput)
void
addParameter(Module.Parameter parameter)
void
connected(FemaleSocket socket)
The socket is connected.void
disconnected(FemaleSocket socket)
The socket is disconnected.void
disposeMe()
Dispose this class.boolean
existsInTree()
Does this item exists in the tree?java.lang.String
getBeanType()
For instances in the code where we are dealing with just a bean and a message needs to be passed to the user or in a log.LogixNG_Category
getCategory()
Get the category.FemaleSocket
getChild(int index)
Get a child of this itemint
getChildCount()
Get the number of children.ConditionalNG
getConditionalNG()
Get the ConditionalNG of this item.Base
getDeepCopy(java.util.Map<java.lang.String,java.lang.String> systemNames, java.util.Map<java.lang.String,java.lang.String> userNames)
Create a deep copy of myself and my children The item needs to try to lookup itself in both systemNames and userNames to see if the user has given a new system name and/or a new user name.If no new system name is given, an auto system name is used.java.util.List<SymbolTable.VariableData>
getLocalVariables()
java.lang.String
getLongDescription(java.util.Locale locale)
Get a long description of this item.java.util.List<Module.Parameter>
getParameters()
Base
getParent()
Get the parent.FemaleSocket
getRootSocket()
Get the root socket of the module.FemaleSocketManager.SocketType
getRootSocketType()
Get the type of the root socket of the module.java.lang.String
getShortDescription(java.util.Locale locale)
Get a short description of this item.java.lang.String
getSocketSystemName()
int
getState()
Provide generic access to internal state.java.util.List<NamedBeanUsageReport>
getUsageReport(NamedBean bean)
Get a list of references for the specified bean.void
getUsageTree(int level, NamedBean bean, java.util.List<NamedBeanUsageReport> report, NamedBean cdl)
Navigate the LogixNG tree.boolean
isStoreIfEmpty()
Is the module stored in the tables and panels file if the module is empty?boolean
isVisible()
Is the module visible to the user?void
printTree(Base.PrintTreeSettings settings, java.io.PrintWriter writer, java.lang.String indent, MutableInt lineNumber)
Print the tree to a stream.void
printTree(Base.PrintTreeSettings settings, java.util.Locale locale, java.io.PrintWriter writer, java.lang.String indent, java.lang.String currentIndent, MutableInt lineNumber)
Print the tree to a stream.void
printTree(Base.PrintTreeSettings settings, java.util.Locale locale, java.io.PrintWriter writer, java.lang.String indent, MutableInt lineNumber)
Print the tree to a stream.protected void
registerListenersForThisClass()
Register listeners if this object needs that.void
setCurrentConditionalNG(ConditionalNG conditionalNG)
Set the current ConditionalNG of the module.void
setParent(Base parent)
Set the parent.void
setSocketSystemName(java.lang.String systemName)
void
setState(int s)
Provide generic access to internal state.void
setStoreIfEmpty(boolean value)
Set whenether the module should be stored in the tables and panels file if the module is empty.void
setup()
Setup this object and its children.void
setVisible(boolean value)
Makes the module visible or not visible to the user.protected void
unregisterListenersForThisClass()
Unregister listeners if this object needs that.-
Methods inherited from class jmri.jmrit.logixng.implementation.AbstractBase
assertListenersAreNotRegistered, compareSystemNameSuffix, deepCopyChildren, dispose, getListenerRefsIncludingChildren, getLogixNG, getRoot, getUsageDetail, isActive, printTreeRow, registerListeners, setParentForAllChildren, unregisterListeners
-
Methods inherited from class jmri.implementation.AbstractNamedBean
addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, describeState, equals, firePropertyChange, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeListenersByReference, getPropertyKeys, getSystemName, getUserName, hashCode, removeProperty, removePropertyChangeListener, removePropertyChangeListener, setComment, setProperty, setUserName, toString, toStringSuffix, updateListenerRef, vetoableChange
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface jmri.jmrit.logixng.Base
addPropertyChangeListener, addPropertyChangeListener, deepCopyChildren, dispose, doSocketOperation, forEntireTree, forEntireTreeWithException, getComment, getListenerRef, getListenerRefs, getListenerRefsIncludingChildren, getLogixNG, getLongDescription, getModule, getNumPropertyChangeListeners, getPropertyChangeListenersByReference, getRoot, getShortDescription, getSystemName, getUsageDetail, getUserName, hasChild, isActive, isEnabled, isSocketOperationAllowed, printTree, printTree, registerListeners, setComment, setParentForAllChildren, setUserName, unregisterListeners, updateListenerRef, vetoableChange
-
Methods inherited from interface jmri.jmrit.logixng.FemaleSocketListener
socketNameChanged
-
Methods inherited from interface jmri.NamedBean
addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, compareTo, describeState, dispose, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListenersByReference, getPropertyKeys, getRecommendedToolTip, getSystemName, getUserName, removeProperty, setComment, setProperty, setUserName, toString, updateListenerRef, vetoableChange
-
Methods inherited from interface jmri.beans.PropertyChangeProvider
addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener
-
-
-
-
Constructor Detail
-
DefaultModule
public DefaultModule(java.lang.String sys, java.lang.String user, FemaleSocketManager.SocketType socketType) throws NamedBean.BadUserNameException, NamedBean.BadSystemNameException
-
DefaultModule
public DefaultModule(java.lang.String sys, java.lang.String user, FemaleSocketManager.SocketType socketType, boolean isVisible, boolean storeIfEmpty) throws NamedBean.BadUserNameException, NamedBean.BadSystemNameException
-
-
Method Detail
-
isVisible
public boolean isVisible()
Description copied from interface:Module
Is the module visible to the user?
-
setVisible
public void setVisible(boolean value)
Description copied from interface:Module
Makes the module visible or not visible to the user.- Specified by:
setVisible
in interfaceModule
- Parameters:
value
- true to make the module visible, false to make it invisible
-
isStoreIfEmpty
public boolean isStoreIfEmpty()
Description copied from interface:Module
Is the module stored in the tables and panels file if the module is empty?- Specified by:
isStoreIfEmpty
in interfaceModule
- Returns:
- true if it's always stored, false if it's not stored if empty
-
setStoreIfEmpty
public void setStoreIfEmpty(boolean value)
Description copied from interface:Module
Set whenether the module should be stored in the tables and panels file if the module is empty.- Specified by:
setStoreIfEmpty
in interfaceModule
- Parameters:
value
- true if it's always stored, false if it's not stored if empty
-
setCurrentConditionalNG
public void setCurrentConditionalNG(ConditionalNG conditionalNG)
Description copied from interface:Module
Set the current ConditionalNG of the module. This method is called on all modules before a ConditionalNG is executed to let the modules know which ConditionalNG is running in which thread.- Specified by:
setCurrentConditionalNG
in interfaceModule
- Parameters:
conditionalNG
- the ConditionalNG
-
getConditionalNG
public ConditionalNG getConditionalNG()
Description copied from class:AbstractBase
Get the ConditionalNG of this item.- Specified by:
getConditionalNG
in interfaceBase
- Overrides:
getConditionalNG
in classAbstractBase
- Returns:
- the ConditionalNG that owns this item
-
getParent
public Base getParent()
Get the parent.The following rules apply
- LogixNGs has no parent. The method throws an UnsupportedOperationException if called.
- Expressions and actions has the male socket that they are connected to as their parent.
- Male sockets has the female socket that they are connected to as their parent.
- The parent of a female sockets is the LogixNG, expression or action that has this female socket.
- The parent of a male sockets is the same parent as the expression or action that it contains.
-
setParent
public void setParent(Base parent)
Set the parent.The following rules apply
- ExecutionGroups has no parent. The method throws an UnsupportedOperationException if called.
- LogixNGs has the execution group as its parent.
- Expressions and actions has the male socket that they are connected to as their parent.
- Male sockets has the female socket that they are connected to as their parent.
- The parent of a female sockets is the LogixNG, expression or action that has this female socket.
- The parent of a male sockets is the same parent as the expression or action that it contains.
-
getBeanType
public java.lang.String getBeanType()
Description copied from interface:NamedBean
For instances in the code where we are dealing with just a bean and a message needs to be passed to the user or in a log.- Specified by:
getBeanType
in interfaceNamedBean
- Returns:
- a string of the bean type, eg Turnout, Sensor etc
-
setState
public void setState(int s) throws JmriException
Description copied from interface:NamedBean
Provide generic access to internal state.This generally shouldn't be used by Java code; use the class-specific form instead (e.g. setCommandedState in Turnout). This is provided to make scripts access easier to read.
- Specified by:
setState
in interfaceNamedBean
- Parameters:
s
- the state- Throws:
JmriException
- general error when setting the state fails
-
getState
public int getState()
Description copied from interface:NamedBean
Provide generic access to internal state.This generally shouldn't be used by Java code; use the class-specific form instead (e.g. getCommandedState in Turnout). This is provided to make scripts easier to read.
-
getShortDescription
public java.lang.String getShortDescription(java.util.Locale locale)
Description copied from interface:Base
Get a short description of this item.- Specified by:
getShortDescription
in interfaceBase
- Parameters:
locale
- The locale to be used- Returns:
- a short description
-
getLongDescription
public java.lang.String getLongDescription(java.util.Locale locale)
Description copied from interface:Base
Get a long description of this item.- Specified by:
getLongDescription
in interfaceBase
- Parameters:
locale
- The locale to be used- Returns:
- a long description
-
getChild
public FemaleSocket getChild(int index) throws java.lang.IllegalArgumentException, java.lang.UnsupportedOperationException
Description copied from class:AbstractBase
Get a child of this item- Specified by:
getChild
in interfaceBase
- Overrides:
getChild
in classAbstractBase
- Parameters:
index
- the index of the child to get- Returns:
- the child
- Throws:
java.lang.IllegalArgumentException
- if the index is less than 0 or greater or equal with the value returned by getChildCount()java.lang.UnsupportedOperationException
-
getChildCount
public int getChildCount()
Description copied from class:AbstractBase
Get the number of children.- Specified by:
getChildCount
in interfaceBase
- Overrides:
getChildCount
in classAbstractBase
- Returns:
- the number of children
-
getCategory
public LogixNG_Category getCategory()
Description copied from class:AbstractBase
Get the category.- Specified by:
getCategory
in interfaceBase
- Overrides:
getCategory
in classAbstractBase
- Returns:
- the category
-
printTree
public void printTree(Base.PrintTreeSettings settings, java.io.PrintWriter writer, java.lang.String indent, MutableInt lineNumber)
Print the tree to a stream.- Specified by:
printTree
in interfaceBase
- Overrides:
printTree
in classAbstractBase
- Parameters:
settings
- settings for what to printwriter
- the stream to print the tree toindent
- the indentation of each levellineNumber
- the line number
-
printTree
public void printTree(Base.PrintTreeSettings settings, java.util.Locale locale, java.io.PrintWriter writer, java.lang.String indent, MutableInt lineNumber)
Print the tree to a stream.- Specified by:
printTree
in interfaceBase
- Overrides:
printTree
in classAbstractBase
- Parameters:
settings
- settings for what to printlocale
- The locale to be usedwriter
- the stream to print the tree toindent
- the indentation of each levellineNumber
- the line number
-
printTree
public void printTree(Base.PrintTreeSettings settings, java.util.Locale locale, java.io.PrintWriter writer, java.lang.String indent, java.lang.String currentIndent, MutableInt lineNumber)
Print the tree to a stream.- Specified by:
printTree
in interfaceBase
- Overrides:
printTree
in classAbstractBase
- Parameters:
settings
- settings for what to printlocale
- The locale to be usedwriter
- the stream to print the tree toindent
- the indentation of each levelcurrentIndent
- the current indentationlineNumber
- the line number
-
getRootSocketType
public FemaleSocketManager.SocketType getRootSocketType()
Description copied from interface:Module
Get the type of the root socket of the module.- Specified by:
getRootSocketType
in interfaceModule
- Returns:
- the type
-
getRootSocket
public FemaleSocket getRootSocket()
Description copied from interface:Module
Get the root socket of the module.- Specified by:
getRootSocket
in interfaceModule
- Returns:
- the root socket
-
addParameter
public void addParameter(java.lang.String name, boolean isInput, boolean isOutput)
- Specified by:
addParameter
in interfaceModule
-
addParameter
public void addParameter(Module.Parameter parameter)
- Specified by:
addParameter
in interfaceModule
-
addLocalVariable
public void addLocalVariable(java.lang.String name, SymbolTable.InitialValueType initialValueType, java.lang.String initialValueData)
- Specified by:
addLocalVariable
in interfaceModule
-
getParameters
public java.util.List<Module.Parameter> getParameters()
- Specified by:
getParameters
in interfaceModule
-
getLocalVariables
public java.util.List<SymbolTable.VariableData> getLocalVariables()
- Specified by:
getLocalVariables
in interfaceModule
-
connected
public void connected(FemaleSocket socket)
Description copied from interface:FemaleSocketListener
The socket is connected.- Specified by:
connected
in interfaceFemaleSocketListener
- Parameters:
socket
- the socket
-
disconnected
public void disconnected(FemaleSocket socket)
Description copied from interface:FemaleSocketListener
The socket is disconnected.- Specified by:
disconnected
in interfaceFemaleSocketListener
- Parameters:
socket
- the socket
-
setSocketSystemName
public void setSocketSystemName(java.lang.String systemName)
-
getSocketSystemName
public java.lang.String getSocketSystemName()
-
setup
public final void setup()
Setup this object and its children. This method is used to lookup system names for child sockets, turnouts, sensors, and so on.
-
disposeMe
public final void disposeMe()
Dispose this class. Listeners do not need to be unregistered by this method since they are unregistered by dispose().- Overrides:
disposeMe
in classAbstractBase
-
registerListenersForThisClass
protected void registerListenersForThisClass()
Description copied from class:AbstractBase
Register listeners if this object needs that.Important: This method may be called more than once. Methods overriding this method must ensure that listeners are not registered more than once.
- Overrides:
registerListenersForThisClass
in classAbstractBase
-
unregisterListenersForThisClass
protected void unregisterListenersForThisClass()
Description copied from class:AbstractBase
Unregister listeners if this object needs that.Important: This method may be called more than once. Methods overriding this method must ensure that listeners are not unregistered more than once.
- Overrides:
unregisterListenersForThisClass
in classAbstractBase
-
getDeepCopy
public Base getDeepCopy(java.util.Map<java.lang.String,java.lang.String> systemNames, java.util.Map<java.lang.String,java.lang.String> userNames)
Description copied from interface:Base
Create a deep copy of myself and my children The item needs to try to lookup itself in both systemNames and userNames to see if the user has given a new system name and/or a new user name.If no new system name is given, an auto system name is used. If no user name is given, a null user name is used.- Specified by:
getDeepCopy
in interfaceBase
- Parameters:
systemNames
- a map of old and new system nameuserNames
- a map of old system name and new user name- Returns:
- a deep copy
-
getUsageReport
public java.util.List<NamedBeanUsageReport> getUsageReport(NamedBean bean)
Get a list of references for the specified bean.- Specified by:
getUsageReport
in interfaceNamedBean
- Parameters:
bean
- The bean to be checked.- Returns:
- a list of NamedBeanUsageReports or an empty ArrayList.
-
getUsageTree
public void getUsageTree(int level, NamedBean bean, java.util.List<NamedBeanUsageReport> report, NamedBean cdl)
Navigate the LogixNG tree.- Specified by:
getUsageTree
in interfaceBase
- Overrides:
getUsageTree
in classAbstractBase
- Parameters:
level
- The current recursion level for debugging.bean
- The named bean that is the object of the search.report
- A list of NamedBeanUsageReport usage reports.cdl
- The current ConditionalNG bean. Null for Module searches since there is no conditional
-
existsInTree
public boolean existsInTree()
Description copied from interface:Base
Does this item exists in the tree?- Specified by:
existsInTree
in interfaceBase
- Returns:
- true if the item exists in the tree, false otherwise
-
-