Package jmri.jmrit.logixng.actions

Class ActionCreateBeansFromTable

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.jmrit.logixng.implementation.AbstractBase

jmri.jmrit.logixng.actions.AbstractDigitalAction

jmri.jmrit.logixng.actions.ActionCreateBeansFromTable

All Implemented Interfaces:

PropertyChangeListener, VetoableChangeListener, Comparable<NamedBean>, EventListener, PropertyChangeProvider, Base, DigitalAction, DigitalActionBean, NamedBean

public class ActionCreateBeansFromTable
extends AbstractDigitalAction
implements PropertyChangeListener, VetoableChangeListener

This action listens on some beans and runs the ConditionalNG on property change.

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.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
ActionCreateBeansFromTable(String sys, String user)

Method Summary

Modifier and Type	Method	Description
void	disposeMe()	Dispose this class.
void	execute()	Execute this DigitalActionBean.
LogixNG_Category	getCategory()	Get the category.
FemaleSocket	getChild(int index)	Get a child of this item
int	getChildCount()	Get the number of children.
Base	getDeepCopy(Map<String,String> systemNames, Map<String,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.
String	getLongDescription(Locale locale)	Get a long description of this item.
NamedBeanType	getNamedBeanType()	Get the type of the named beans
String	getRowOrColumnSystemName()	Get name of row or column
String	getRowOrColumnUserName()	Get name of row or column
LogixNG_SelectNamedBean<NamedTable>	getSelectNamedBean()
String	getShortDescription(Locale locale)	Get a short description of this item.
TableRowOrColumn	getTableRowOrColumn()	Get tableRowOrColumn.
void	getUsageDetail(int level, NamedBean bean, List<NamedBeanUsageReport> report, NamedBean cdl)	Add a new NamedBeanUsageReport to the report list if there are any matches in this action or expresssion.
boolean	isIncludeCellsWithoutHeader()	Get whenever to include cells that doesn't have a header.
boolean	isMoveUserName()	Get whenever to move the user name to the new bean.
boolean	isOnlyCreatableTypes()	Get whenever to show only types that can be created with this action.
boolean	isRemoveOldBean()	Get whenever to remove the old bean.
boolean	isUpdateToUserName()	Get whenever to use the user name for beans that already uses the system name.
void	propertyChange(PropertyChangeEvent evt)
void	registerListenersForThisClass()	Register listeners if this object needs that.
void	setIncludeCellsWithoutHeader(boolean includeCellsWithoutHeader)	Set whenever to include cells that doesn't have a header.
void	setMoveUserName(boolean isMoveUserName)	Set whenever to move the user name to the new bean.
void	setNamedBeanType(NamedBeanType namedBeanType)	Set the type of the named beans
void	setOnlyCreatableTypes(boolean onlyCreatableTypes)	Set whenever to show only types that can be created with this action.
void	setRemoveOldBean(boolean removeOldBean)	Set whenever to remove the old bean.
void	setRowOrColumnSystemName(String rowOrColumnName)	Set name of row or column
void	setRowOrColumnUserName(String rowOrColumnName)	Set name of row or column
void	setTableRowOrColumn(TableRowOrColumn tableRowOrColumn)	Set tableRowOrColumn.
void	setup()	Setup this object and its children.
void	setUpdateToUserName(boolean updateToUserName)	Set whenever to use the user name for beans that already uses the system name.
void	unregisterListenersForThisClass()	Unregister listeners if this object needs that.

Methods inherited from class jmri.jmrit.logixng.actions.AbstractDigitalAction

getBeanType, getNewSocketName, getNewSocketName, getParent, getPreferredSocketPrefix, getState, setParent, setState

Methods inherited from class jmri.jmrit.logixng.implementation.AbstractBase

assertListenersAreNotRegistered, compareSystemNameSuffix, deepCopyChildren, dispose, getConditionalNG, getListenerRefsIncludingChildren, getLogixNG, getRoot, getUsageTree, isActive, printTree, printTree, printTree, 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, existsInTree, forEntireTree, forEntireTreeWithException, getComment, getConditionalNG, getListenerRef, getListenerRefs, getListenerRefsIncludingChildren, getLogixNG, getLongDescription, getModule, getNumPropertyChangeListeners, getPropertyChangeListenersByReference, getRoot, getShortDescription, getSystemName, getUsageTree, getUserName, hasChild, isActive, isEnabled, isSocketOperationAllowed, printTree, printTree, printTree, printTree, printTree, registerListeners, setComment, setParentForAllChildren, setUserName, unregisterListeners, updateListenerRef, vetoableChange

Methods inherited from interface jmri.NamedBean

addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, compareTo, describeState, dispose, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListenersByReference, getPropertyKeys, getRecommendedToolTip, getSystemName, getUsageReport, getUserName, removeProperty, setComment, setProperty, setUserName, toString, updateListenerRef, vetoableChange

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface java.beans.VetoableChangeListener

vetoableChange

Constructor Details

ActionCreateBeansFromTable

public ActionCreateBeansFromTable(String sys,
 String user)
                           throws NamedBean.BadUserNameException,
NamedBean.BadSystemNameException

Throws:

NamedBean.BadUserNameException

NamedBean.BadSystemNameException

Method Details

getDeepCopy

public Base getDeepCopy(Map<String,String> systemNames,
 Map<String,String> userNames)
                 throws ParserException

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 interface Base

Parameters:

systemNames - a map of old and new system name

userNames - a map of old system name and new user name

Returns:

a deep copy

Throws:

ParserException

isOnlyCreatableTypes

public boolean isOnlyCreatableTypes()

Get whenever to show only types that can be created with this action.

Returns:

true if show only types that can be created, false otherwise

setOnlyCreatableTypes

public void setOnlyCreatableTypes(boolean onlyCreatableTypes)

Set whenever to show only types that can be created with this action.

Parameters:

onlyCreatableTypes - true show only types that can be created, false otherwise

getNamedBeanType

public NamedBeanType getNamedBeanType()

Get the type of the named beans

Returns:

the type of named beans

setNamedBeanType

public void setNamedBeanType(@Nonnull
 NamedBeanType namedBeanType)

Set the type of the named beans

Parameters:

namedBeanType - the type of the named beans

getSelectNamedBean

public LogixNG_SelectNamedBean<NamedTable> getSelectNamedBean()

getTableRowOrColumn

public TableRowOrColumn getTableRowOrColumn()

Get tableRowOrColumn.

Returns:

tableRowOrColumn

setTableRowOrColumn

public void setTableRowOrColumn(@Nonnull
 TableRowOrColumn tableRowOrColumn)

Set tableRowOrColumn.

Parameters:

tableRowOrColumn - tableRowOrColumn

getRowOrColumnSystemName

public String getRowOrColumnSystemName()

Get name of row or column

Returns:

name of row or column

setRowOrColumnSystemName

public void setRowOrColumnSystemName(@Nonnull
 String rowOrColumnName)

Set name of row or column

Parameters:

rowOrColumnName - name of row or column

getRowOrColumnUserName

public String getRowOrColumnUserName()

Get name of row or column

Returns:

name of row or column

setRowOrColumnUserName

public void setRowOrColumnUserName(@Nonnull
 String rowOrColumnName)

Set name of row or column

Parameters:

rowOrColumnName - name of row or column

isIncludeCellsWithoutHeader

public boolean isIncludeCellsWithoutHeader()

Get whenever to include cells that doesn't have a header. Cells without headers can be used to use some cells in the table as comments.

Returns:

true if include cells that doesn't have a header, false otherwise

setIncludeCellsWithoutHeader

public void setIncludeCellsWithoutHeader(boolean includeCellsWithoutHeader)

Set whenever to include cells that doesn't have a header. Cells without headers can be used to use some cells in the table as comments.

Parameters:

includeCellsWithoutHeader - true if include rows/columns that doesn't have a header, false otherwise

isMoveUserName

public boolean isMoveUserName()

Get whenever to move the user name to the new bean.

Returns:

true if username should be moved, false otherwise

setMoveUserName

public void setMoveUserName(boolean isMoveUserName)

Set whenever to move the user name to the new bean.

Parameters:

isMoveUserName - true if username should be moved, false otherwise

isUpdateToUserName

public boolean isUpdateToUserName()

Get whenever to use the user name for beans that already uses the system name.

Returns:

true if update beans to use user name, false otherwise

setUpdateToUserName

public void setUpdateToUserName(boolean updateToUserName)

Set whenever to use the user name for beans that already uses the system name.

Parameters:

updateToUserName - true if update beans to use user name, false otherwise

isRemoveOldBean

public boolean isRemoveOldBean()

Get whenever to remove the old bean.

Returns:

true if remove old bean, false otherwise

setRemoveOldBean

public void setRemoveOldBean(boolean removeOldBean)

Set whenever to remove the old bean.

Parameters:

removeOldBean - true if remove old bean, false otherwise

getCategory

public LogixNG_Category getCategory()

Get the category.

Specified by:

getCategory in interface Base

Overrides:

getCategory in class AbstractBase

Returns:

the category

execute

public void execute()
             throws JmriException

Execute this DigitalActionBean.

Specified by:

execute in interface DigitalAction

Throws:

JmriException - when an exception occurs

getChild

public FemaleSocket getChild(int index)
                      throws IllegalArgumentException,
UnsupportedOperationException

Description copied from class: AbstractBase

Get a child of this item

Specified by:

getChild in interface Base

Overrides:

getChild in class AbstractBase

Parameters:

index - the index of the child to get

Returns:

the child

Throws:

IllegalArgumentException - if the index is less than 0 or greater or equal with the value returned by getChildCount()

UnsupportedOperationException - when needed

getChildCount

public int getChildCount()

Description copied from class: AbstractBase

Get the number of children.

Specified by:

getChildCount in interface Base

Overrides:

getChildCount in class AbstractBase

Returns:

the number of children

getShortDescription

public String getShortDescription(Locale locale)

Description copied from interface: Base

Get a short description of this item.

Specified by:

getShortDescription in interface Base

Parameters:

locale - The locale to be used

Returns:

a short description

getLongDescription

public String getLongDescription(Locale locale)

Description copied from interface: Base

Get a long description of this item.

Specified by:

getLongDescription in interface Base

Parameters:

locale - The locale to be used

Returns:

a long description

setup

public void setup()

Setup this object and its children. This method is used to lookup system names for child sockets, turnouts, sensors, and so on.

Specified by:

setup in interface Base

registerListenersForThisClass

public void registerListenersForThisClass()

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 class AbstractBase

unregisterListenersForThisClass

public void unregisterListenersForThisClass()

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 class AbstractBase

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Specified by:

propertyChange in interface PropertyChangeListener

disposeMe

public void disposeMe()

Dispose this class. Listeners do not need to be unregistered by this method since they are unregistered by dispose().

Overrides:

disposeMe in class AbstractBase

getUsageDetail

public void getUsageDetail(int level,
 NamedBean bean,
 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 interface Base

Overrides:

getUsageDetail in class AbstractBase

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