Package com.luciad.model

Class TLcdModelTreeNode

java.lang.Object

com.luciad.model.ALcdModel

com.luciad.model.TLcdVectorModel

com.luciad.model.TLcdModelTreeNode

All Implemented Interfaces:

ILcdIntegerIndexedModel, ILcdModel, ILcdModelContainer, ILcdModelProducerListener, ILcdModelTreeNode, ILcdDisposable, Serializable, AutoCloseable, EventListener

public class TLcdModelTreeNode
extends TLcdVectorModel
implements ILcdModelTreeNode

An implementation of ILcdModelTreeNode based on a TLcdVectorModel. It is mainly intended for empty model nodes: a model node where only the data in the child nodes is important and the node itself contains no useful data.

The isEmpty() method is used to indicate whether a node is empty or not. By default, this method will check the TLcdVectorModel.size() of the model.

When using this class to create a non-empty node, the model node itself is an instance of TLcdVectorModel with the same features and properties as a regular vector model.

Since:

9.0

See Also:

• TLcd2DBoundsIndexedModelTreeNode
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.luciad.model.ILcdModel

ILcdModel.Query

Field Summary

Fields inherited from class com.luciad.model.TLcdVectorModel

fVector

Fields inherited from class com.luciad.model.ALcdModel

fModelEventSupport

Fields inherited from interface com.luciad.model.ILcdModel

FIRE_LATER, FIRE_NOW, NO_EVENT

Constructor Summary

Constructors

Constructor	Description
TLcdModelTreeNode()	Constructs a new, empty TLcdModelTreeNode, initialized with a default TLcdModelDescriptor.
TLcdModelTreeNode(ILcdModelReference aModelReference)	Constructs a new, empty TLcdModelTreeNode, initialized with the specified model reference and a default TLcdModelDescriptor.
TLcdModelTreeNode(ILcdModelReference aModelReference, ILcdModelDescriptor aModelDescriptor)	Constructs a new, empty TLcdModelTreeNode, initialized with the specified model reference and model descriptor.

Method Summary

Modifier and Type	Method	Description
void	addHierarchyModelContainerListener(ILcdModelContainerListener aModelContainerListener)	Registers the given ILcdModelContainerListener to receive TLcdModelContainerEvents from all the ILcdModelTreeNodes contained in the tree with this node as root node.
void	addHierarchyModelListener(ILcdModelListener aModelListener)	Registers the given ILcdModelListener to receive TLcdModelChangedEvents from all the ILcdModels contained in the tree with this node as root node.
boolean	addModel(ILcdModel aModel)	Adds the ILcdModel aModel as a child model to this ILcdModelTreeNode.
void	addModelContainerListener(ILcdModelContainerListener aModelContainerListener)	Adds an ILcdModelContainerListener to this ILcdModelContainer.
ILcdModel	getModel(int aIndex)	Returns the child model at the given index.
boolean	isEmpty()	Returns true when the model node is only used as a container for other models, and contains no useful data itself, false otherwise.
int	modelCount()	Returns the number of child models of this model node.
void	modelProduced(TLcdModelProducerEvent e)	Notifies this ILcdModelProducerListener of a produced model.
Enumeration	models()	Returns an Enumeration of the child models of this ILcdModelTreeNode.
void	removeHierarchyModelContainerListener(ILcdModelContainerListener aModelContainerListener)	Unregisters the given ILcdModelContainerListener from receiving TLcdModelContainerEvents for the tree with this node as root node.
void	removeHierarchyModelListener(ILcdModelListener aModelListener)	Unregisters the given ILcdModelListener from receiving TLcdModelChangedEvents for the tree with this node as root node.
boolean	removeModel(ILcdModel aModel)	Removes the child model aModel from this ILcdModelTreeNode.
void	removeModelContainerListener(ILcdModelContainerListener aModelContainerListener)	Removes an ILcdModelContainerListener from this ILcdModelContainer.

Methods inherited from class com.luciad.model.TLcdVectorModel

addElement, canAddElement, canRemoveElement, contains, elementAt, elements, getAddElementFilter, getRemoveElementFilter, indexOf, removeAllElements, removeElement, setAddElementFilter, setRemoveElementFilter, size, toString

Methods inherited from class com.luciad.model.ALcdModel

addElements, addModelListener, allElementsChanged, allElementsRemoved, dispose, elementAdded, elementChanged, elementRemoved, elementsAdded, elementsChanged, elementsRemoved, fireCollectedModelChanges, getModelDescriptor, getModelEncoder, getModelMetadata, getModelReference, initializeTransientValues, isClassTraceOn, isTraceOn, removeElements, removeModelListener, setClassTraceOn, setModelDescriptor, setModelDisposer, setModelEncoder, setModelMetadataFunction, setModelReference, setTraceOn

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.luciad.util.ILcdDisposable

close

Methods inherited from interface com.luciad.model.ILcdModel

getModelMetadata, query

Methods inherited from interface com.luciad.model.ILcdModelContainer

getModels

Methods inherited from interface com.luciad.model.ILcdModelTreeNode

addElement, addElements, addModelListener, canAddElement, canRemoveElement, dispose, elementChanged, elements, elementsChanged, fireCollectedModelChanges, getModelDescriptor, getModelEncoder, getModelReference, removeAllElements, removeElement, removeElements, removeModelListener

Constructor Details

TLcdModelTreeNode

public TLcdModelTreeNode()

Constructs a new, empty TLcdModelTreeNode, initialized with a default TLcdModelDescriptor.

TLcdModelTreeNode

public TLcdModelTreeNode(ILcdModelReference aModelReference)

Constructs a new, empty TLcdModelTreeNode, initialized with the specified model reference and a default TLcdModelDescriptor.

Parameters:

aModelReference - the model reference describing the coordinate system used in this model.

TLcdModelTreeNode

public TLcdModelTreeNode(ILcdModelReference aModelReference,
 ILcdModelDescriptor aModelDescriptor)

Constructs a new, empty TLcdModelTreeNode, initialized with the specified model reference and model descriptor.

Parameters:

aModelReference - the model reference describing the coordinate system used in this model.

aModelDescriptor - the model descriptor providing meta information about this model.

Method Details

addModel

public boolean addModel(ILcdModel aModel)

Description copied from interface: ILcdModelTreeNode

Adds the ILcdModel aModel as a child model to this ILcdModelTreeNode.

Specified by:

addModel in interface ILcdModelContainer

Specified by:

addModel in interface ILcdModelTreeNode

Parameters:

aModel - the model to be added.

Returns:

true if this collection of models changed as a result of the call

removeModel

public boolean removeModel(ILcdModel aModel)

Description copied from interface: ILcdModelTreeNode

Removes the child model aModel from this ILcdModelTreeNode.

Specified by:

removeModel in interface ILcdModelContainer

Specified by:

removeModel in interface ILcdModelTreeNode

Parameters:

aModel - the model to be removed.

Returns:

true if a model was removed as a result of this call

addHierarchyModelContainerListener

public void addHierarchyModelContainerListener(ILcdModelContainerListener aModelContainerListener)

Description copied from interface: ILcdModelTreeNode

Registers the given ILcdModelContainerListener to receive TLcdModelContainerEvents from all the ILcdModelTreeNodes contained in the tree with this node as root node. If the listener should only receive events originating from this model node, it should be adedd as a regular model listener (see ILcdModelTreeNode.addModelContainerListener(ILcdModelContainerListener)).

The source ILcdModelContainer of the event can be retrieved by calling TLcdModelContainerEvent.getModelContainer() on the received TLcdModelContainerEvent.

Specified by:

addHierarchyModelContainerListener in interface ILcdModelTreeNode

Parameters:

aModelContainerListener - the listener

See Also:

• ILcdModelTreeNode.removeHierarchyModelContainerListener(ILcdModelContainerListener)

removeHierarchyModelContainerListener

public void removeHierarchyModelContainerListener(ILcdModelContainerListener aModelContainerListener)

Description copied from interface: ILcdModelTreeNode

Unregisters the given ILcdModelContainerListener from receiving TLcdModelContainerEvents for the tree with this node as root node.

Specified by:

removeHierarchyModelContainerListener in interface ILcdModelTreeNode

Parameters:

aModelContainerListener - the listener

See Also:

• ILcdModelTreeNode.addHierarchyModelContainerListener(ILcdModelContainerListener)

addHierarchyModelListener

public void addHierarchyModelListener(ILcdModelListener aModelListener)

Description copied from interface: ILcdModelTreeNode

Registers the given ILcdModelListener to receive TLcdModelChangedEvents from all the ILcdModels contained in the tree with this node as root node. If the listener should only receive events originating from this model node, it should be added as a regular model listener (see ILcdModelTreeNode.addModelListener(ILcdModelListener)).

The source ILcdModel of the event can be retrieved by calling TLcdModelChangedEvent.getModel() on the received TLcdModelChangedEvent.

Specified by:

addHierarchyModelListener in interface ILcdModelTreeNode

Parameters:

aModelListener - the listener

See Also:

• ILcdModelTreeNode.removeHierarchyModelListener(ILcdModelListener)

removeHierarchyModelListener

public void removeHierarchyModelListener(ILcdModelListener aModelListener)

Description copied from interface: ILcdModelTreeNode

Unregisters the given ILcdModelListener from receiving TLcdModelChangedEvents for the tree with this node as root node.

Specified by:

removeHierarchyModelListener in interface ILcdModelTreeNode

Parameters:

aModelListener - the listener

See Also:

• ILcdModelTreeNode.addHierarchyModelListener(ILcdModelListener)

modelCount

public int modelCount()

Description copied from interface: ILcdModelTreeNode

Returns the number of child models of this model node.

Specified by:

modelCount in interface ILcdModelContainer

Specified by:

modelCount in interface ILcdModelTreeNode

Returns:

the number of child models of this model node.

getModel

public ILcdModel getModel(int aIndex)

Description copied from interface: ILcdModelTreeNode

Returns the child model at the given index.

Specified by:

getModel in interface ILcdModelContainer

Specified by:

getModel in interface ILcdModelTreeNode

Parameters:

aIndex - a valid index in this ILcdModelTreeNode

Returns:

the child model at the given index.

models

public Enumeration models()

Description copied from interface: ILcdModelTreeNode

Returns an Enumeration of the child models of this ILcdModelTreeNode.

Specified by:

models in interface ILcdModelContainer

Specified by:

models in interface ILcdModelTreeNode

Returns:

an Enumeration of the child models of this ILcdModelTreeNode.

modelProduced

public void modelProduced(TLcdModelProducerEvent e)

Description copied from interface: ILcdModelProducerListener

Notifies this ILcdModelProducerListener of a produced model.

Specified by:

modelProduced in interface ILcdModelProducerListener

Parameters:

e - the event describing the changes to a ILcdModelProducer.

addModelContainerListener

public void addModelContainerListener(ILcdModelContainerListener aModelContainerListener)

Description copied from interface: ILcdModelTreeNode

Adds an ILcdModelContainerListener to this ILcdModelContainer.

It will only receive notifications of changes in this ILcdModelTreeNode and not of any changes in the state of the child model node(s). If this is required, the listener must be registered as a hierarchy listener (see ILcdModelTreeNode.addHierarchyModelContainerListener(ILcdModelContainerListener)).

.

Specified by:

addModelContainerListener in interface ILcdModelContainer

Specified by:

addModelContainerListener in interface ILcdModelTreeNode

Parameters:

aModelContainerListener - the listener to be added.

See Also:

• ILcdModelContainer.removeModelContainerListener(com.luciad.model.ILcdModelContainerListener)

removeModelContainerListener

public void removeModelContainerListener(ILcdModelContainerListener aModelContainerListener)

Description copied from interface: ILcdModelTreeNode

Removes an ILcdModelContainerListener from this ILcdModelContainer.

It is not possible to remove a hierarchy model container listener. Use ILcdModelTreeNode.removeHierarchyModelContainerListener(ILcdModelContainerListener) for this purpose.

Specified by:

removeModelContainerListener in interface ILcdModelContainer

Specified by:

removeModelContainerListener in interface ILcdModelTreeNode

Parameters:

aModelContainerListener - the listener to be removed.

See Also:

• ILcdModelContainer.addModelContainerListener(com.luciad.model.ILcdModelContainerListener)

isEmpty

public boolean isEmpty()

Returns true when the model node is only used as a container for other models, and contains no useful data itself, false otherwise.

This implementation looks at the TLcdVectorModel.size() of the model to determine whether this model node is empty or not.

Specified by:

isEmpty in interface ILcdModelTreeNode

Returns:

true when the model node contains no useful data, false otherwise