Class DefaultLogixNG
- java.lang.Object
-
- jmri.implementation.AbstractNamedBean
-
- jmri.jmrit.logixng.implementation.DefaultLogixNG
-
- All Implemented Interfaces:
java.lang.Comparable<NamedBean>
,PropertyChangeProvider
,Base
,LogixNG
,NamedBean
public class DefaultLogixNG extends AbstractNamedBean implements LogixNG
The default implementation of LogixNG.
-
-
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.NamedBean
NamedBean.BadNameException, NamedBean.BadSystemNameException, NamedBean.BadUserNameException, NamedBean.DisplayOptions, NamedBean.DuplicateSystemNameException
-
-
Field Summary
-
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.jmrit.logixng.LogixNG
PROPERTY_ENABLED, PROPERTY_INLINE
-
Fields inherited from interface jmri.NamedBean
DISPLAY_NAME_FORMAT, INCONSISTENT, PROPERTY_STATE, QUOTED_NAME_FORMAT, UNKNOWN
-
-
Constructor Summary
Constructors Constructor Description DefaultLogixNG(java.lang.String sys, java.lang.String user)
DefaultLogixNG(java.lang.String sys, java.lang.String user, boolean inline)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
activate()
Activates this LogixNG.boolean
addConditionalNG(ConditionalNG conditionalNG)
Add a child ConditionalNG to the parent LogixNG.void
clearStartup()
Clear the startup flag.Base
deepCopyChildren(Base original, java.util.Map<java.lang.String,java.lang.String> systemNames, java.util.Map<java.lang.String,java.lang.String> userNames)
Do a deep copy of children from the original to me.void
deleteConditionalNG(ConditionalNG conditionalNG)
Delete a ConditionalNG from this LogixNG.void
execute()
Execute all ConditionalNGs if the LogixNG is enabled and activated.void
execute(boolean allowRunDelayed)
Execute all ConditionalNGs if the LogixNG is enabled and activated.void
execute(boolean allowRunDelayed, boolean isStartup)
Execute all ConditionalNGs if the LogixNG is enabled and activated.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.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.ConditionalNG
getConditionalNG(int order)
Returns the conditionalNG that will calculate in the specified order.ConditionalNG
getConditionalNG(java.lang.String systemName)
Get a ConditionalNG belonging to this LogixNG.java.lang.String
getConditionalNG_SystemName(int index)
Set the system name for the conditionalNG at the specified position in this listConditionalNG
getConditionalNGByUserName(java.lang.String userName)
Get a ConditionalNG belonging to this LogixNG.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.InlineLogixNG
getInlineLogixNG()
Get the InlineLogixNG that owns this LogixNG, if the LogixNG is inline.void
getListenerRefsIncludingChildren(java.util.List<java.lang.String> list)
Returns a list of all the listeners references for this object and all its children.LogixNG
getLogixNG()
Get the LogixNG of this item.java.lang.String
getLongDescription(java.util.Locale locale)
Get a long description of this item.int
getNumConditionalNGs()
Get number of ConditionalNGs for this LogixNG.Base
getParent()
Get the parent.Base
getRoot()
Get the root of the tree that this item belongs to.java.lang.String
getShortDescription(java.util.Locale locale)
Get a short description of this item.int
getState()
Provide generic access to internal state.void
getUsageDetail(int level, NamedBean bean, java.util.List<NamedBeanUsageReport> report, NamedBean cdl)
Add a new NamedBeanUsageReport to the report list if there are any matches in this action or expresssion.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
isActivated()
Is this item active?boolean
isActive()
Is this item active?boolean
isEnabled()
Determines whether this LogixNG is enabled.boolean
isInline()
Determines whether this LogixNG is inline or not.boolean
isStartup()
Determines whether this LogixNG is currently during startup.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
printTreeRow(Base.PrintTreeSettings settings, java.util.Locale locale, java.io.PrintWriter writer, java.lang.String currentIndent, MutableInt lineNumber)
void
registerListeners()
Register listeners if this object needs that.void
setActive(boolean active)
Activates/deactivates this LogixNG.void
setConditionalNG_SystemName(int index, java.lang.String systemName)
Set the system name for the conditionalNG at the specified position in this listvoid
setEnabled(boolean enable)
Set whenether this LogixNG is enabled or disabled.void
setInline(boolean inline)
Sets whether this LogixNG is inline or not.void
setInlineLogixNG(InlineLogixNG inlineLogixNG)
Set the InlineLogixNG that owns this LogixNG, if the LogixNG is inline.void
setParent(Base parent)
Set the parent.boolean
setParentForAllChildren(java.util.List<java.lang.String> errors)
Set the parent for all the children.void
setState(int s)
Provide generic access to internal state.void
setup()
Setup this object and its children.void
swapConditionalNG(int nextInOrder, int row)
Move 'row' to 'nextInOrder' and shift all between 'nextInOrder' and 'row' up one position.void
unregisterListeners()
Unregister listeners if this object needs that.-
Methods inherited from class jmri.implementation.AbstractNamedBean
addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, describeState, dispose, 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, dispose, doSocketOperation, existsInTree, forEntireTree, forEntireTreeWithException, getComment, getListenerRef, getListenerRefs, getLongDescription, getModule, getNumPropertyChangeListeners, getPropertyChangeListenersByReference, getShortDescription, getSystemName, getUserName, hasChild, isSocketOperationAllowed, printTree, printTree, setComment, setUserName, updateListenerRef, vetoableChange
-
Methods inherited from interface jmri.NamedBean
addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, compareTo, describeState, dispose, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListenersByReference, getPropertyKeys, getSystemName, getUserName, removeProperty, setComment, setProperty, setUserName, toString, updateListenerRef, vetoableChange
-
Methods inherited from interface jmri.beans.PropertyChangeProvider
addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener
-
-
-
-
Constructor Detail
-
DefaultLogixNG
public DefaultLogixNG(java.lang.String sys, java.lang.String user) throws NamedBean.BadUserNameException, NamedBean.BadSystemNameException
-
DefaultLogixNG
public DefaultLogixNG(java.lang.String sys, java.lang.String user, boolean inline) throws NamedBean.BadUserNameException, NamedBean.BadSystemNameException
-
-
Method Detail
-
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 interface:Base
Get a child of this item
-
getChildCount
public int getChildCount()
Description copied from interface:Base
Get the number of children.- Specified by:
getChildCount
in interfaceBase
- Returns:
- the number of children
-
getCategory
public Category getCategory()
Description copied from interface:Base
Get the category.- Specified by:
getCategory
in interfaceBase
- Returns:
- the category
-
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.
-
clearStartup
public void clearStartup()
Clear the startup flag.- Specified by:
clearStartup
in interfaceLogixNG
-
isStartup
public boolean isStartup()
Determines whether this LogixNG is currently during startup.
-
setInline
public void setInline(boolean inline)
Sets whether this LogixNG is inline or not.
-
isInline
public boolean isInline()
Determines whether this LogixNG is inline or not.
-
setInlineLogixNG
public void setInlineLogixNG(InlineLogixNG inlineLogixNG)
Set the InlineLogixNG that owns this LogixNG, if the LogixNG is inline.- Specified by:
setInlineLogixNG
in interfaceLogixNG
- Parameters:
inlineLogixNG
- the InlineLogixNG that owns this LogixNG, if the LogixNG is inline.
-
getInlineLogixNG
public InlineLogixNG getInlineLogixNG()
Get the InlineLogixNG that owns this LogixNG, if the LogixNG is inline.- Specified by:
getInlineLogixNG
in interfaceLogixNG
- Returns:
- the InlineLogixNG
-
setEnabled
public void setEnabled(boolean enable)
Set whenether this LogixNG is enabled or disabled.This method must call registerListeners() / unregisterListeners() and also call execute() if enable is true.
- Specified by:
setEnabled
in interfaceLogixNG
- Parameters:
enable
- true if this LogixNG should be enabled, false otherwise
-
activate
public void activate()
Activates this LogixNG.This method is called by the LogixNG manager during initialization of the LogixNGs.
-
setActive
public void setActive(boolean active)
Activates/deactivates this LogixNG.This method is used by the LogixNG action EnableLogixNG to temporary activate or deactivate a LogixNG.
-
isEnabled
public boolean isEnabled()
Determines whether this LogixNG is enabled.
-
getConditionalNG_SystemName
public java.lang.String getConditionalNG_SystemName(int index)
Set the system name for the conditionalNG at the specified position in this list- Specified by:
getConditionalNG_SystemName
in interfaceLogixNG
- Parameters:
index
- index of the element to set the system name- Returns:
- the system name
-
setConditionalNG_SystemName
public void setConditionalNG_SystemName(int index, java.lang.String systemName)
Set the system name for the conditionalNG at the specified position in this list- Specified by:
setConditionalNG_SystemName
in interfaceLogixNG
- Parameters:
index
- index of the element to set the system namesystemName
- the new system name
-
getNumConditionalNGs
public int getNumConditionalNGs()
Get number of ConditionalNGs for this LogixNG.- Specified by:
getNumConditionalNGs
in interfaceLogixNG
- Returns:
- the number of conditionals
-
swapConditionalNG
public void swapConditionalNG(int nextInOrder, int row)
Move 'row' to 'nextInOrder' and shift all between 'nextInOrder' and 'row' up one position. Requiresrow > nextInOrder
.- Specified by:
swapConditionalNG
in interfaceLogixNG
- Parameters:
nextInOrder
- target order for ConditionalNG at rowrow
- position of ConditionalNG to move
-
getConditionalNG
public ConditionalNG getConditionalNG(int order)
Returns the conditionalNG that will calculate in the specified order. This is also the order the ConditionalNG is listed in the Add/Edit LogixNG dialog. If 'order' is greater than the number of ConditionalNGs for this LogixNG, null is returned.- Specified by:
getConditionalNG
in interfaceLogixNG
- Parameters:
order
- order in which the ConditionalNG calculates- Returns:
- the conditionalNG or null
-
addConditionalNG
public boolean addConditionalNG(ConditionalNG conditionalNG)
Add a child ConditionalNG to the parent LogixNG.The first part handles adding conditionalNGs to the LogixNG list during file loading.
The second part handles normal additions using the GUI, Logix imports or tests.
- Specified by:
addConditionalNG
in interfaceLogixNG
- Parameters:
conditionalNG
- The ConditionalNG object.- Returns:
- true if the ConditionalNG was added, false otherwise.
-
getConditionalNG
public ConditionalNG getConditionalNG(java.lang.String systemName)
Get a ConditionalNG belonging to this LogixNG.- Specified by:
getConditionalNG
in interfaceLogixNG
- Parameters:
systemName
- The name of the ConditionalNG object.- Returns:
- the ConditionalNG object or null if not found.
-
getConditionalNGByUserName
public ConditionalNG getConditionalNGByUserName(java.lang.String userName)
Get a ConditionalNG belonging to this LogixNG.- Specified by:
getConditionalNGByUserName
in interfaceLogixNG
- Parameters:
userName
- The name of the ConditionalNG object.- Returns:
- the ConditionalNG object or null if not found.
-
deleteConditionalNG
public void deleteConditionalNG(ConditionalNG conditionalNG)
Delete a ConditionalNG from this LogixNG.Note: Since each LogixNG must have at least one ConditionalNG, the last ConditionalNG will not be deleted.
Returns An array of names used in an error message explaining why ConditionalNG should not be deleted.
- Specified by:
deleteConditionalNG
in interfaceLogixNG
- Parameters:
conditionalNG
- The ConditionalNG to delete
-
isActive
public boolean isActive()
Is this item active? If this item is enabled and all the parents are enabled, this item is active.
-
isActivated
public boolean isActivated()
Is this item active? This method returns true if the the LogixNG is active but not enabled, while the methodBase.isActive()
only returns true if the LogixNG is both active and enabled.- Specified by:
isActivated
in interfaceLogixNG
- Returns:
- true if active, false otherwise.
-
execute
public void execute()
Execute all ConditionalNGs if the LogixNG is enabled and activated.
-
execute
public void execute(boolean allowRunDelayed)
Execute all ConditionalNGs if the LogixNG is enabled and activated.
-
execute
public void execute(boolean allowRunDelayed, boolean isStartup)
Execute all ConditionalNGs if the LogixNG is enabled and activated.
-
getConditionalNG
public ConditionalNG getConditionalNG()
Get the ConditionalNG of this item.- Specified by:
getConditionalNG
in interfaceBase
- Returns:
- the ConditionalNG that owns this item
-
getLogixNG
public LogixNG getLogixNG()
Get the LogixNG of this item.- Specified by:
getLogixNG
in interfaceBase
- Returns:
- the LogixNG that owns this item
-
setParentForAllChildren
public boolean setParentForAllChildren(java.util.List<java.lang.String> errors)
Set the parent for all the children.- Specified by:
setParentForAllChildren
in interfaceBase
- Parameters:
errors
- a list of potential errors- Returns:
- true if success, false otherwise
-
registerListeners
public void registerListeners()
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.
- Specified by:
registerListeners
in interfaceBase
-
unregisterListeners
public void unregisterListeners()
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.
- Specified by:
unregisterListeners
in interfaceBase
-
printTreeRow
protected void printTreeRow(Base.PrintTreeSettings settings, java.util.Locale locale, java.io.PrintWriter writer, java.lang.String currentIndent, MutableInt lineNumber)
-
printTree
public void printTree(Base.PrintTreeSettings settings, java.io.PrintWriter writer, java.lang.String indent, MutableInt lineNumber)
Print the tree to a stream.
-
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.
-
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.
-
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
-
deepCopyChildren
public Base deepCopyChildren(Base original, java.util.Map<java.lang.String,java.lang.String> systemNames, java.util.Map<java.lang.String,java.lang.String> userNames) throws JmriException
Description copied from interface:Base
Do a deep copy of children from the original to me.- Specified by:
deepCopyChildren
in interfaceBase
- Parameters:
original
- the item to copy fromsystemNames
- a map of old and new system nameuserNames
- a map of old system name and new user name- Returns:
- myself
- Throws:
JmriException
- in case of an error
-
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
- 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
-
getUsageDetail
public void getUsageDetail(int level, NamedBean bean, java.util.List<NamedBeanUsageReport> report, NamedBean cdl)
Add a new NamedBeanUsageReport to the report list if there are any matches in this action or expresssion.NamedBeanUsageReport Usage keys:
- LogixNGAction
- LogixNGExpression
- Specified by:
getUsageDetail
in interfaceBase
- 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
-
getListenerRefsIncludingChildren
public void getListenerRefsIncludingChildren(java.util.List<java.lang.String> list)
Returns a list of all the listeners references for this object and all its children.- Specified by:
getListenerRefsIncludingChildren
in interfaceBase
- Parameters:
list
- a list of textual references
-
-