Package jmri.jmrit.catalog

Class AbstractCatalogTree

java.lang.Object

javax.swing.tree.DefaultTreeModel

jmri.jmrit.catalog.AbstractCatalogTree

All Implemented Interfaces:

Serializable, Comparable<NamedBean>, TreeModel, PropertyChangeProvider, CatalogTree, NamedBean

Direct Known Subclasses:

CatalogTreeFS, CatalogTreeIndex

public abstract class AbstractCatalogTree
extends DefaultTreeModel
implements CatalogTree

TreeModel used by CatalogPanel to create a tree of resources.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.NamedBean

NamedBean.BadNameException, NamedBean.BadSystemNameException, NamedBean.BadUserNameException, NamedBean.DisplayOptions, NamedBean.DuplicateSystemNameException

Field Summary

Fields

Modifier and Type	Field	Description
(package private) HashMap<PropertyChangeListener,String>	listenerRefs
protected final String	mSystemName
(package private) PropertyChangeSupport	pcs
(package private) HashMap<PropertyChangeListener,String>	register

Fields inherited from class javax.swing.tree.DefaultTreeModel

asksAllowsChildren, listenerList, root

Fields inherited from interface jmri.CatalogTree

FILESYS, IMAGE, NOFILTER, SCRIPT, SOUND, XML

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
AbstractCatalogTree(String sysname)
AbstractCatalogTree(String sysname, String username)

Method Summary

Modifier and Type	Method	Description
void	addDeleteLock(NamedBean lock)
void	addPropertyChangeListener(PropertyChangeListener l)	Add a PropertyChangeListener to the listener list.
void	addPropertyChangeListener(PropertyChangeListener l, String beanRef, String listenerRef)	Request a call-back when a bound property changes.
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener)	Add a PropertyChangeListener for a specific property.
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener, String beanRef, String listenerRef)	Request a call-back when a bound property changes.
int	compareSystemNameSuffix(String suffix1, String suffix2, NamedBean n)	Compare the suffix of this NamedBean's name with the suffix of the argument NamedBean's name for the NamedBean.compareTo(jmri.NamedBean) operation.
String	describeState(int state)	Provide human-readable, localized version of state value.
void	dispose()	Deactivate this object, so that it releases as many resources as possible and no longer effects others.
protected void	firePropertyChange(String p, Object old, Object n)
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.
String	getComment()	Get associated comment text.
String	getListenerRef(PropertyChangeListener l)	Get the textual reference for the specific listener
ArrayList<String>	getListenerRefs()	Returns a list of all the listeners references
int	getNumPropertyChangeListeners()	Number of current listeners.
PropertyChangeListener[]	getPropertyChangeListeners()	Get all PropertyChangeListeners currently attached to this object.
PropertyChangeListener[]	getPropertyChangeListeners(String propertyName)	Get all PropertyChangeListeners currently listening to changes to the specified property.
PropertyChangeListener[]	getPropertyChangeListenersByReference(String name)	Get a list of all the property change listeners that are registered using a specific name
CatalogTreeNode	getRoot()	Get the root element of the tree as a jmri.CatalogTreeNode object (Instead of Object, as parent swing.TreeModel provides).
int	getState()	Provide generic access to internal state.
String	getSystemName()	Get a system-specific name.
String	getUserName()	User's identification for the item.
void	insertNodes(String pathToRoot)	Starting point to recursively add nodes to the tree by scanning a file directory
abstract void	insertNodes(String pName, String pPath, CatalogTreeNode pParent)	Recursively add nodes to the tree
boolean	isDeleteAllowed()
void	removeDeleteLock(NamedBean lock)
void	removePropertyChangeListener(PropertyChangeListener l)	Remove the specified listener from this object.
void	removePropertyChangeListener(String propertyName, PropertyChangeListener listener)	Remove the specified listener of the specified property from this object.
void	setComment(String comment)	Set associated comment text.
void	setState(int s)	Provide generic access to internal state.
void	setUserName(String s)	Set the user name, normalizing it if needed.
void	updateListenerRef(PropertyChangeListener l, String newName)
void	vetoableChange(PropertyChangeEvent evt)

Methods inherited from class javax.swing.tree.DefaultTreeModel

addTreeModelListener, asksAllowsChildren, fireTreeNodesChanged, fireTreeNodesInserted, fireTreeNodesRemoved, fireTreeStructureChanged, getChild, getChildCount, getIndexOfChild, getListeners, getPathToRoot, getPathToRoot, getTreeModelListeners, insertNodeInto, isLeaf, nodeChanged, nodesChanged, nodeStructureChanged, nodesWereInserted, nodesWereRemoved, reload, reload, removeNodeFromParent, removeTreeModelListener, setAsksAllowsChildren, setRoot, valueForPathChanged

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jmri.NamedBean

compareTo, getDisplayName, getDisplayName, getProperty, getPropertyKeys, getRecommendedToolTip, getUsageReport, removeProperty, setProperty, toString

Methods inherited from interface javax.swing.tree.TreeModel

addTreeModelListener, getChild, getChildCount, getIndexOfChild, isLeaf, removeTreeModelListener, valueForPathChanged

Field Details

mSystemName

protected final String mSystemName

pcs

PropertyChangeSupport pcs

register

HashMap<PropertyChangeListener,String> register

listenerRefs

HashMap<PropertyChangeListener,String> listenerRefs

Constructor Details

AbstractCatalogTree

public AbstractCatalogTree(String sysname,
 String username)

AbstractCatalogTree

public AbstractCatalogTree(String sysname)

Method Details

getBeanType

@CheckReturnValue
public 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 interface NamedBean

Returns:

a string of the bean type, eg Turnout, Sensor etc

insertNodes

public abstract void insertNodes(String pName,
 String pPath,
 CatalogTreeNode pParent)

Recursively add nodes to the tree

Specified by:

insertNodes in interface CatalogTree

Parameters:

pName - Name of the resource to be scanned; this is only used for the human-readable tree

pPath - Path to this resource, including the pName part

pParent - Node for the parent of the resource to be scanned, e.g. where in the tree to insert it.

insertNodes

public void insertNodes(String pathToRoot)

Starting point to recursively add nodes to the tree by scanning a file directory

Specified by:

insertNodes in interface CatalogTree

Parameters:

pathToRoot - Path to Directory to be scanned

getRoot

@CheckReturnValue
public CatalogTreeNode getRoot()

Get the root element of the tree as a jmri.CatalogTreeNode object (Instead of Object, as parent swing.TreeModel provides).

Specified by:

getRoot in interface CatalogTree

Specified by:

getRoot in interface TreeModel

Overrides:

getRoot in class DefaultTreeModel

Returns:

the root element

getComment

@CheckReturnValue
public String getComment()

Get associated comment text.

Specified by:

getComment in interface NamedBean

Returns:

the comment or null

setComment

public void setComment(String comment)

Set associated comment text.

Comments can be any valid text.

Specified by:

setComment in interface NamedBean

Parameters:

comment - Null means no comment associated.

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

Description copied from interface: PropertyChangeProvider

Add a PropertyChangeListener to the listener list.

Specified by:

addPropertyChangeListener in interface PropertyChangeProvider

Parameters:

l - The PropertyChangeListener to be added

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
 PropertyChangeListener listener)

Description copied from interface: PropertyChangeProvider

Add a PropertyChangeListener for a specific property.

Specified by:

addPropertyChangeListener in interface PropertyChangeProvider

Parameters:

propertyName - The name of the property to listen on.

listener - The PropertyChangeListener to be added

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)

Description copied from interface: PropertyChangeProvider

Remove the specified listener from this object.

Specified by:

removePropertyChangeListener in interface PropertyChangeProvider

Parameters:

l - The PropertyChangeListener to remove.

removePropertyChangeListener

public void removePropertyChangeListener(String propertyName,
 PropertyChangeListener listener)

Description copied from interface: PropertyChangeProvider

Remove the specified listener of the specified property from this object.

Specified by:

removePropertyChangeListener in interface PropertyChangeProvider

Parameters:

propertyName - The name of the property to stop listening to.

listener - The PropertyChangeListener to remove.

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners()

Description copied from interface: PropertyChangeProvider

Get all PropertyChangeListeners currently attached to this object.

Specified by:

getPropertyChangeListeners in interface PropertyChangeProvider

Returns:

An array of PropertyChangeListeners.

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners(String propertyName)

Description copied from interface: PropertyChangeProvider

Get all PropertyChangeListeners currently listening to changes to the specified property.

Specified by:

getPropertyChangeListeners in interface PropertyChangeProvider

Parameters:

propertyName - the name of the property of interest

Returns:

an array of PropertyChangeListeners

getNumPropertyChangeListeners

@CheckReturnValue
public int getNumPropertyChangeListeners()

Number of current listeners. May return -1 if the information is not available for some reason.

Specified by:

getNumPropertyChangeListeners in interface NamedBean

Returns:

the number of listeners.

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l,
 String beanRef,
 String listenerRef)

Description copied from interface: NamedBean

Request a call-back when a bound property changes. Bound properties are the known state, commanded state, user and system names.

Specified by:

addPropertyChangeListener in interface NamedBean

Parameters:

l - The listener. This may change in the future to be a subclass of NamedProprtyChangeListener that carries the name and listenerRef values internally

beanRef - The name (either system or user) that the listener uses for this namedBean, this parameter is used to help determine when which listeners should be moved when the username is moved from one bean to another

listenerRef - A textual reference for the listener, that can be presented to the user when a delete is called

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
 PropertyChangeListener listener,
 String beanRef,
 String listenerRef)

Description copied from interface: NamedBean

Request a call-back when a bound property changes. Bound properties are the known state, commanded state, user and system names.

Specified by:

addPropertyChangeListener in interface NamedBean

Parameters:

propertyName - The name of the property to listen to

listener - The listener. This may change in the future to be a subclass of NamedProprtyChangeListener that carries the name and listenerRef values internally

beanRef - The name (either system or user) that the listener uses for this namedBean, this parameter is used to help determine when which listeners should be moved when the username is moved from one bean to another

listenerRef - A textual reference for the listener, that can be presented to the user when a delete is called

getPropertyChangeListenersByReference

@CheckReturnValue
public PropertyChangeListener[] getPropertyChangeListenersByReference(String name)

Description copied from interface: NamedBean

Get a list of all the property change listeners that are registered using a specific name

Specified by:

getPropertyChangeListenersByReference in interface NamedBean

Parameters:

name - The name (either system or user) that the listener has registered as referencing this namedBean

Returns:

empty list if none

getListenerRefs

@CheckReturnValue
public ArrayList<String> getListenerRefs()

Description copied from interface: NamedBean

Returns a list of all the listeners references

Specified by:

getListenerRefs in interface NamedBean

Returns:

a list of textual references

updateListenerRef

public void updateListenerRef(PropertyChangeListener l,
 String newName)

Specified by:

updateListenerRef in interface NamedBean

getListenerRef

@CheckReturnValue
public String getListenerRef(PropertyChangeListener l)

Description copied from interface: NamedBean

Get the textual reference for the specific listener

Specified by:

getListenerRef in interface NamedBean

Parameters:

l - the listener of interest

Returns:

the textual reference

getSystemName

@CheckReturnValue
public String getSystemName()

Description copied from interface: NamedBean

Get a system-specific name. This encodes the hardware addressing information. Any given system name must be unique within the layout.

Specified by:

getSystemName in interface NamedBean

Returns:

the system-specific name

getUserName

@CheckReturnValue
public String getUserName()

Description copied from interface: NamedBean

User's identification for the item. Bound parameter so manager(s) can listen to changes. Any given user name must be unique within the layout. Must not match the system name.

Specified by:

getUserName in interface NamedBean

Returns:

null if not set

setUserName

public void setUserName(String s)

Description copied from interface: NamedBean

Set the user name, normalizing it if needed.

Specified by:

setUserName in interface NamedBean

Parameters:

s - the new user name

firePropertyChange

protected void firePropertyChange(String p,
 Object old,
 Object n)

dispose

public void dispose()

Description copied from interface: NamedBean

Deactivate this object, so that it releases as many resources as possible and no longer effects others.

For example, if this object has listeners, after a call to this method it should no longer notify those listeners. Any native or system-wide resources it maintains should be released, including threads, files, etc.

It is an error to invoke any other methods on this object once dispose() has been called. Note, however, that there is no guarantee about behavior in that case.

Afterwards, references to this object may still exist elsewhere, preventing its garbage collection. But it's formally dead, and shouldn't be keeping any other objects alive. Therefore, this method should null out any references to other objects that this NamedBean contained.

Specified by:

dispose in interface NamedBean

getState

@CheckReturnValue
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.

Specified by:

getState in interface NamedBean

Returns:

the state

describeState

@CheckReturnValue
public String describeState(int state)

Description copied from interface: NamedBean

Provide human-readable, localized version of state value.

This method is intended for use when presenting to a human operator.

Specified by:

describeState in interface NamedBean

Parameters:

state - the state to describe

Returns:

the state in localized form

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

Parameters:

s - the state

Throws:

JmriException - general error when setting the state fails

addDeleteLock

public void addDeleteLock(NamedBean lock)

removeDeleteLock

public void removeDeleteLock(NamedBean lock)

isDeleteAllowed

@CheckReturnValue
public boolean isDeleteAllowed()

vetoableChange

public void vetoableChange(PropertyChangeEvent evt)
                    throws PropertyVetoException

Specified by:

vetoableChange in interface NamedBean

Throws:

PropertyVetoException

compareSystemNameSuffix

@CheckReturnValue
public int compareSystemNameSuffix(@Nonnull
 String suffix1,
 @Nonnull
 String suffix2,
 @Nonnull
 NamedBean n)

Compare the suffix of this NamedBean's name with the suffix of the argument NamedBean's name for the NamedBean.compareTo(jmri.NamedBean) operation. This is intended to be a system-specific comparison that understands the various formats, etc. By default, does an alphanumeric-by-chunks comparison

Specified by:

compareSystemNameSuffix in interface NamedBean

Parameters:

suffix1 - The suffix for the 1st bean in the comparison

suffix2 - The suffix for the 2nd bean in the comparison

n - The other (second) NamedBean in the comparison

Returns:

-1,0,+1 for ordering if the names are well-formed; may not provide proper ordering if the names are not well-formed.