com.luciad.model

LuciadLightspeedClass TLcdDataObjectIndexedVectorModel

java.lang.Object

com.luciad.model.TLcdDataObjectIndexedVectorModel

All Implemented Interfaces:

ILcdDataObjectIndexedModel, ILcdIntegerIndexedModel, ILcdModel, ILcdDisposable, Serializable, AutoCloseable

public class TLcdDataObjectIndexedVectorModel
extends Object
implements ILcdDataObjectIndexedModel, ILcdIntegerIndexedModel

Default implementation of ILcdDataObjectIndexedModel.

This implementation uses hashes to store and look up all key-value pairs in its indices.

Users of this model should call the elementChanged(Object, int) method whenever one or more of the evaluated expressions for that element has changed, to keep the indices up-to-date.

Since:

11.0.04

See Also:

Serialized Form

Nested Class Summary

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

ILcdDataObjectIndexedModel.IndexId

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

ILcdModel.Query

Field Summary

Fields inherited from interface com.luciad.model.ILcdModel

FIRE_LATER, FIRE_NOW, NO_EVENT

Constructor Summary

Constructors

Constructor and Description
TLcdDataObjectIndexedVectorModel() Constructs a new, empty TLcdDataObjectIndexedVectorModel.

Method Summary

Modifier and Type	Method and Description
void	addElement(Object aElement, int aEventMode) Adds the specified element to this model.
void	addElements(Vector aElements, int aFireEventMode) Adds all of the elements in the specified vector to this model.
ILcdDataObjectIndexedModel.IndexId	addIndex(List<String> aExpressions, boolean aIsUniqueIndex) Creates a new index for the given list of expressions.
void	addModelListener(ILcdModelListener aModelListener) Registers the specified model listener to receive notifications of model changes on this model.
boolean	canAddElement(Object aElement) Returns true if the specified element can be added to this model, false otherwise.
boolean	canAddIndex(List<String> aExpressions, boolean aIsUniqueIndex) Returns true if an index can be created for the given list of expressions and uniqueness flag, false otherwise.
boolean	canRemoveElement(Object aElement) Returns true if the specified element can be removed from this model, false otherwise.
void	dispose() Disposes of this model and allows it to release any system resources that it is holding.
Object	elementAt(int aIndex) Returns the element at the specified index.
void	elementChanged(Object aObject, int aEventMode) Notifies this model that the specified element has changed.
Enumeration	elements() Returns an enumeration over all elements of this model.
void	elementsChanged(Vector aObjects, int aEventMode) Notifies this model that the elements in the specified vector have changed.
void	fireCollectedModelChanges() Notifies all listeners that are registered on this model of all the changes that have been collected between the previous notification and now.
ALcdDataObjectExpressionLanguage	getDataObjectExpressionLanguage() Returns the expression language used to evaluate expressions defined in the indices of the model.
Set<List<Object>>	getIndexedValues(ILcdDataObjectIndexedModel.IndexId aIndexId) Returns the set of all unique expression value combinations which are present in the specified index.
ILcdDataObjectIndexedModel.IndexId	getIndexId(Set<String> aExpressions) Returns the index id which corresponds to the given set of expressions, or null if no such index is available on this model.
Set<ILcdDataObjectIndexedModel.IndexId>	getIndexIds() Returns the set of all indices which are currently available on this model.
ILcdModelDescriptor	getModelDescriptor() Returns the ILcdModelDescriptor providing meta information about this model and its elements.
ILcdModelEncoder	getModelEncoder() Returns, if available, a model encoder that is capable of encoding this model, (encoder.canEncode(this)), null otherwise.
ILcdModelReference	getModelReference() Returns the ILcdModelReference describing how the geometry of the elements contained in this model should be interpreted.
int	indexOf(Object aObject) Returns the index of the first occurrence of the specified element in the model, or -1 if this model does not contain the element.
void	removeAllElements(int aEventMode) Removes all elements from this model.
void	removeAllIndices() Removes all indices from this model.
void	removeElement(Object aElement, int aEventMode) Removes the specified element from this model.
void	removeElements(Vector aElements, int aFireEventMode) Removes all of the elements in the specified vector from this model.
boolean	removeIndex(ILcdDataObjectIndexedModel.IndexId aIndexId) Removes the specified index from this model.
void	removeModelListener(ILcdModelListener aModelListener) Unregisters the specified model listener so that it no longer receives notifications of model changes on this model.
Collection<ILcdDataObject>	retrieveAllByIndex(ILcdDataObjectIndexedModel.IndexId aIndex, List aExpressionValues) Returns all model elements which match the given list of values for the expressions in the given index.
ILcdDataObject	retrieveFirstByIndex(ILcdDataObjectIndexedModel.IndexId aIndexId, List aExpressionValues) Returns a single model element which matches the given list of values for the expressions in the given index, or null if no such element exists in the model.
void	setDataObjectExpressionLanguage(ALcdDataObjectExpressionLanguage aExpressionLanguage) Sets the expression language to be used for evaluating expressions defined in the indices of the model.
void	setModelDescriptor(ILcdModelDescriptor aModelDescriptor) Sets a model descriptor for this model.
void	setModelEncoder(ILcdModelEncoder aModelEncoder) Sets the model encoder for this model.
void	setModelReference(ILcdModelReference aModelReference) Sets the model reference for this model.
int	size() Returns the number of elements in this model.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.luciad.model.ILcdModel

all, filter, getModelMetadata, query

Methods inherited from interface com.luciad.util.ILcdDisposable

close

Constructor Detail

TLcdDataObjectIndexedVectorModel

public TLcdDataObjectIndexedVectorModel()

Constructs a new, empty TLcdDataObjectIndexedVectorModel.

Method Detail

size

public int size()

Description copied from interface: ILcdIntegerIndexedModel

Returns the number of elements in this model.

Specified by:

size in interface ILcdIntegerIndexedModel

Returns:

the number of elements in this model.

elementAt

public Object elementAt(int aIndex)

Description copied from interface: ILcdIntegerIndexedModel

Returns the element at the specified index.

Specified by:

elementAt in interface ILcdIntegerIndexedModel

Parameters:

aIndex - an index into this ILcdModel.

Returns:

the element at the specified index.

indexOf

public int indexOf(Object aObject)

Description copied from interface: ILcdIntegerIndexedModel

Returns the index of the first occurrence of the specified element in the model, or -1 if this model does not contain the element. More formally: returns the smallest i for which this.elementAt(i).equals(aElement).

Specified by:

indexOf in interface ILcdIntegerIndexedModel

Parameters:

aObject - the element to search for.

Returns:

the index of the first occurrence of the specified element in model vector, or -1 if this model does not contain the element.

getModelReference

public ILcdModelReference getModelReference()

Description copied from interface: ILcdModel

Returns the ILcdModelReference describing how the geometry of the elements contained in this model should be interpreted.

Specified by:

getModelReference in interface ILcdModel

Returns:

the ILcdModelReference of this ILcdModel.

getModelDescriptor

public ILcdModelDescriptor getModelDescriptor()

Description copied from interface: ILcdModel

Returns the ILcdModelDescriptor providing meta information about this model and its elements.

Specified by:

getModelDescriptor in interface ILcdModel

Returns:

the ILcdModelDescriptor of this ILcdModel. Should not be null.

getModelEncoder

public ILcdModelEncoder getModelEncoder()

Description copied from interface: ILcdModel

Returns, if available, a model encoder that is capable of encoding this model, (encoder.canEncode(this)), null otherwise.

Specified by:

getModelEncoder in interface ILcdModel

Returns:

a model encoder that is capable of encoding this model if available, null otherwise.

elements

public Enumeration elements()

Description copied from interface: ILcdModel

Returns an enumeration over all elements of this model. The order in which the elements are enumerated is unspecified by default.

Specified by:

elements in interface ILcdModel

Returns:

an enumeration over all elements of this model.

canAddElement

public boolean canAddElement(Object aElement)

Returns true if the specified element can be added to this model, false otherwise.

Note that this method generally does not validate whether the specified element is expressed in the same model reference as this model. It is the responsibility of the user of this model to make sure this precondition is fulfilled when an element is added to this model.

In addition to any constraints imposed by ILcdModel.canAddElement(Object), this method also verifies whether:

• the element is an instance of ILcdDataObject
• the element does not violate the uniqueness constraints of the indices defined on this model.

This implementation returns true if and only if the specified element implements ILcdDataObject.

Specified by:

canAddElement in interface ILcdDataObjectIndexedModel

Specified by:

canAddElement in interface ILcdModel

Parameters:

aElement - the element to be verified.

Returns:

true if the specified element can be added to this model, false otherwise.

addElement

public void addElement(Object aElement,
                       int aEventMode)
                throws IllegalArgumentException

Description copied from interface: ILcdModel

Adds the specified element to this model.

Models that support this operation may place limitations on what elements may be added to this model. For example, implementations that are based on a spatial indexing structure will require that elements implement ILcdBounded.

When adding an element, the user should make sure that canAddElement(aElement) holds, and that the element's geometry is expressed in the same model reference as this model. It is generally undefined what happens if an invalid element is added.

Implementations of this interface should clearly specify in their documentation any restrictions on what elements may be added. Although it is unspecified what happens if the preconditions are not met, implementations are encouraged to throw meaningful exceptions (for example, NullPointerException, IllegalArgumentException, ClassCastException, UnsupportedOperationException), whenever possible.

Specified by:

addElement in interface ILcdModel

Parameters:

aElement - the element to be added to this model.

aEventMode - the mode for sending out the model change event. This can be FIRE_LATER or NO_EVENT.

Throws:

IllegalArgumentException

See Also:

ILcdModel.canAddElement(Object)

addElements

public void addElements(Vector aElements,
                        int aFireEventMode)

Adds all of the elements in the specified vector to this model. Models that support this operation may place limitations on what elements may be added to this model. For example, implementations that are based on a spatial indexing structure will require that elements implement ILcdBounded. Implementations of this interface should clearly specify in their documentation any restrictions on what elements may be added.

The behavior of this operation is undefined if the specified vector is modified while the operation is in progress.

The specified elements will be added to this model in the order they are specified in the vector. If an element cannot be added, this method will return at the first failure. Succeeding elements won't be added.

Although it is unspecified what happens if the preconditions are not met, implementations are encouraged to throw meaningful exceptions (for example, NullPointerException, IllegalArgumentException, ClassCastException, UnsupportedOperationException), whenever possible.

This implementation iterates over all elements in the specified vector, and calls addElement(Object, int) for each element to be added, using event mode NO_EVENT if the specified event mode is NO_EVENT, FIRE_LATER otherwise. If the specified event mode is FIRE_NOW, fireCollectedModelChanges() is called afterwards.

Specified by:

addElements in interface ILcdModel

Parameters:

aElements - the vector of elements to be added to this model.

aFireEventMode - the mode for sending the model change events This can be FIRE_LATER or NO_EVENT.

See Also:

ILcdModel.canAddElement(Object)

canRemoveElement

public boolean canRemoveElement(Object aElement)

Returns true if the specified element can be removed from this model, false otherwise. Note that this method generally does not check whether the specified element is actually contained in this model.

This implementation returns true if and only if the specified element implements ILcdDataObject.

Specified by:

canRemoveElement in interface ILcdModel

Parameters:

aElement - the element to be verified.

Returns:

true if the specified element can be removed from this model, false otherwise.

removeElement

public void removeElement(Object aElement,
                          int aEventMode)
                   throws IllegalArgumentException

Description copied from interface: ILcdModel

Removes the specified element from this model. If the specified element is not contained in this model, this method has no effect.

Although it is unspecified what happens if the preconditions are not met, implementations are encouraged to throw meaningful exceptions (for example, NullPointerException, IllegalArgumentException, ClassCastException, UnsupportedOperationException), whenever possible.

Specified by:

removeElement in interface ILcdModel

Parameters:

aElement - the element to be removed from this model.

aEventMode - the mode for sending out the model change event. This can be FIRE_LATER or NO_EVENT.

Throws:

IllegalArgumentException

See Also:

ILcdModel.canRemoveElement(Object)

removeElements

public void removeElements(Vector aElements,
                           int aFireEventMode)

Removes all of the elements in the specified vector from this model. If one of the elements in the specified vector is not contained in this model, this element will be ignored.

The behavior of this operation is undefined if the specified vector is modified while the operation is in progress.

The specified elements will be removed from this model in the order they are specified in the vector. If an element cannot be removed, this method will return at the first failure. Succeeding elements won't be removed.

Although it is unspecified what happens if the preconditions are not met, implementations are encouraged to throw meaningful exceptions (for example, NullPointerException, IllegalArgumentException, ClassCastException, UnsupportedOperationException), whenever possible.

This implementation iterates over all elements in the specified vector, and calls removeElement(Object, int) for each element to be removed, using event mode NO_EVENT if the specified event mode is NO_EVENT, FIRE_LATER otherwise. If the specified event mode is FIRE_NOW, fireCollectedModelChanges() is called afterwards.

Specified by:

removeElements in interface ILcdModel

Parameters:

aElements - the vector of elements to be removed from this model.

aFireEventMode - the mode for sending out the model change event. This can be FIRE_LATER or NO_EVENT.

See Also:

ILcdModel.canRemoveElement(Object)

removeAllElements

public void removeAllElements(int aEventMode)

Description copied from interface: ILcdModel

Removes all elements from this model.

If an element cannot be removed, this method will return at the first failure. Succeeding elements won't be removed.

Although it is unspecified what happens if the preconditions are not met, implementations are encouraged to throw meaningful exceptions (for example, NullPointerException, IllegalArgumentException, ClassCastException, UnsupportedOperationException), whenever possible.

Specified by:

removeAllElements in interface ILcdModel

Parameters:

aEventMode - the mode for sending out the model change event. This can be FIRE_LATER or NO_EVENT.

elementChanged

public void elementChanged(Object aObject,
                           int aEventMode)

Description copied from interface: ILcdModel

Notifies this model that the specified element has changed.

Specified by:

elementChanged in interface ILcdModel

Parameters:

aObject - the element that has changed.

aEventMode - the mode for sending out the model change event. This can be FIRE_LATER or NO_EVENT.

elementsChanged

public void elementsChanged(Vector aObjects,
                            int aEventMode)

Description copied from interface: ILcdModel

Notifies this model that the elements in the specified vector have changed.

Specified by:

elementsChanged in interface ILcdModel

Parameters:

aObjects - the vector of elements that have changed.

aEventMode - the mode for sending out the model change event. This can be FIRE_LATER or NO_EVENT.

fireCollectedModelChanges

public void fireCollectedModelChanges()

Description copied from interface: ILcdModel

Notifies all listeners that are registered on this model of all the changes that have been collected between the previous notification and now.

Specified by:

fireCollectedModelChanges in interface ILcdModel

See Also:

ILcdModelListener.modelChanged(TLcdModelChangedEvent)

addModelListener

public void addModelListener(ILcdModelListener aModelListener)

Description copied from interface: ILcdModel

Registers the specified model listener to receive notifications of model changes on this model.

Model changes are sent out when an element has been added, removed or changed. Model changes can be sent out individually, grouped or silently applied without notifications, depending on the ILcdFireEventMode that was specified with the change.

In case you need to register a listener which keeps a reference to an object with a shorter life-time than this model, you can use a ALcdWeakModelListener instance as model listener.

Specified by:

addModelListener in interface ILcdModel

Parameters:

aModelListener - the ILcdModelListener to register on this model.

See Also:

ILcdModel.removeModelListener(com.luciad.model.ILcdModelListener), ILcdModelListener

removeModelListener

public void removeModelListener(ILcdModelListener aModelListener)

Description copied from interface: ILcdModel

Unregisters the specified model listener so that it no longer receives notifications of model changes on this model.

Specified by:

removeModelListener in interface ILcdModel

Parameters:

aModelListener - the ILcdModelListener to remove.

See Also:

ILcdModel.addModelListener(com.luciad.model.ILcdModelListener), ILcdModelListener

dispose

public void dispose()

Description copied from interface: ILcdModel

Disposes of this model and allows it to release any system resources that it is holding. The result of calling any other method (other than finalize) on this model subsequent to a call to this method is undefined.

Specified by:

dispose in interface ILcdModel

Specified by:

dispose in interface ILcdDisposable

getIndexIds

public Set<ILcdDataObjectIndexedModel.IndexId> getIndexIds()

Description copied from interface: ILcdDataObjectIndexedModel

Returns the set of all indices which are currently available on this model. If no indices are available, an empty set is returned.

If a required index is not available, it can be created using ILcdDataObjectIndexedModel.addIndex(java.util.List, boolean).

Specified by:

getIndexIds in interface ILcdDataObjectIndexedModel

Returns:

the set of all indices which are currently available on this model.

See Also:

ILcdDataObjectIndexedModel.addIndex(java.util.List, boolean)

getIndexId

public ILcdDataObjectIndexedModel.IndexId getIndexId(Set<String> aExpressions)

Description copied from interface: ILcdDataObjectIndexedModel

Returns the index id which corresponds to the given set of expressions, or null if no such index is available on this model.

Note that, in case the set would be sorted, the order of expressions in the returned index id may be different from the order in the set. It is the order of expressions in the returned index id which determines the order of expression values to be passed to ILcdDataObjectIndexedModel.retrieveAllByIndex(com.luciad.model.ILcdDataObjectIndexedModel.IndexId, java.util.List) and ILcdDataObjectIndexedModel.retrieveFirstByIndex(com.luciad.model.ILcdDataObjectIndexedModel.IndexId, java.util.List).

Specified by:

getIndexId in interface ILcdDataObjectIndexedModel

Parameters:

aExpressions - the expressions for which an index id should be returned.

Returns:

the index matching the given set of expressions and uniqueness, or null if no such index is available.

canAddIndex

public boolean canAddIndex(List<String> aExpressions,
                           boolean aIsUniqueIndex)

Description copied from interface: ILcdDataObjectIndexedModel

Returns true if an index can be created for the given list of expressions and uniqueness flag, false otherwise.

An index can be created if:

• There are no duplicate expressions in the expression list.
• An index with the same expressions but different uniqueness property doesn't exist yet in this model.
• The specified expressions are valid expressions for the expression language of this model, that is, the expression language is capable of compiling each of the expressions
• If the index is unique, there should at most be one model element matching each unique combination of expression values.

Implementations may add additional constraints, which should be clearly specified in their documentation.

Specified by:

canAddIndex in interface ILcdDataObjectIndexedModel

Parameters:

aExpressions - a set of expressions defining the index.

aIsUniqueIndex - boolean flag indicating whether the index is unique (has at most one element for each unique combination of expression values) or not.

Returns:

true if an index can be created for the given list of expressions and uniqueness flag, false otherwise.

addIndex

public ILcdDataObjectIndexedModel.IndexId addIndex(List<String> aExpressions,
                                                   boolean aIsUniqueIndex)

Description copied from interface: ILcdDataObjectIndexedModel

Creates a new index for the given list of expressions. The uniqueness flag allows to specify whether the index should be created as a unique index or not. If the index already exists on the model, this method has no effect and the index id of the existing index is returned.

It is not allowed to create both a unique and a non-unique index with the same list of expressions.

Specified by:

addIndex in interface ILcdDataObjectIndexedModel

Parameters:

aExpressions - a set of expressions defining the index.

aIsUniqueIndex - boolean flag indicating whether the index is unique (has at most one element for each unique combination of expression values) or not.

Returns:

the index id, uniquely identifying the created index.

removeIndex

public boolean removeIndex(ILcdDataObjectIndexedModel.IndexId aIndexId)

Description copied from interface: ILcdDataObjectIndexedModel

Removes the specified index from this model. All resources allocated for the index will be released. If the index does not exist on this model, this method has no effect.

Specified by:

removeIndex in interface ILcdDataObjectIndexedModel

Parameters:

aIndexId - the index to be removed.

Returns:

true if the specified index was successfully removed from this model, false otherwise.

removeAllIndices

public void removeAllIndices()

Description copied from interface: ILcdDataObjectIndexedModel

Removes all indices from this model.

Specified by:

removeAllIndices in interface ILcdDataObjectIndexedModel

retrieveAllByIndex

public Collection<ILcdDataObject> retrieveAllByIndex(ILcdDataObjectIndexedModel.IndexId aIndex,
                                                     List aExpressionValues)

Description copied from interface: ILcdDataObjectIndexedModel

Returns all model elements which match the given list of values for the expressions in the given index.

The list of values in aExpressionValues should contain a value for each expression in aIndexId.getExpressions(), where the value at position i specifies the value to which the expression at position i, evaluated for each model element, should be compared to.

aExpressionValues may contain null values. A null value will be considered a match if the corresponding expression for the tested model element also evaluates to null.

If no elements match the specified expression values, an empty collection is returned.

Specified by:

retrieveAllByIndex in interface ILcdDataObjectIndexedModel

Parameters:

aIndex - the index describing the expressions to test for.

aExpressionValues - the list of values to be compared with the list of evaluated expressions.

Returns:

a collection containing all model elements which match the given list of values for the expressions in the given index.

See Also:

ILcdDataObjectIndexedModel.IndexId.isUnique()

retrieveFirstByIndex

public ILcdDataObject retrieveFirstByIndex(ILcdDataObjectIndexedModel.IndexId aIndexId,
                                           List aExpressionValues)

Description copied from interface: ILcdDataObjectIndexedModel

Returns a single model element which matches the given list of values for the expressions in the given index, or null if no such element exists in the model.

The list of values in aExpressionValues should contain a value for each expression in aIndexId.getExpressions(), where the value at position i specifies the value to which the expression at position i, evaluated for each model element, should be compared to.

aExpressionValues may contain null values. A null value will be considered a match if the corresponding expression for the tested model element also evaluates to null.

Specified by:

retrieveFirstByIndex in interface ILcdDataObjectIndexedModel

Parameters:

aIndexId - the index describing the expressions to test for.

aExpressionValues - the list of values to be compared with the list of evaluated expressions.

Returns:

a single model element which matches the given list of values for the expressions in the given index, or null if no such element exists in the model.

See Also:

ILcdDataObjectIndexedModel.IndexId.isUnique()

getIndexedValues

public Set<List<Object>> getIndexedValues(ILcdDataObjectIndexedModel.IndexId aIndexId)

Description copied from interface: ILcdDataObjectIndexedModel

Returns the set of all unique expression value combinations which are present in the specified index.

Specified by:

getIndexedValues in interface ILcdDataObjectIndexedModel

Parameters:

aIndexId - the index for which to return the set of expression value combinations.

Returns:

the set of expression value combinations, present in the specified index.

setDataObjectExpressionLanguage

public void setDataObjectExpressionLanguage(ALcdDataObjectExpressionLanguage aExpressionLanguage)

Description copied from interface: ILcdDataObjectIndexedModel

Sets the expression language to be used for evaluating expressions defined in the indices of the model. This operation will trigger a rebuild of all indices which are currently configured on the model.

Specified by:

setDataObjectExpressionLanguage in interface ILcdDataObjectIndexedModel

Parameters:

aExpressionLanguage - the expression language used to evaluate expressions defined in the indices of the model.

getDataObjectExpressionLanguage

public ALcdDataObjectExpressionLanguage getDataObjectExpressionLanguage()

Description copied from interface: ILcdDataObjectIndexedModel

Returns the expression language used to evaluate expressions defined in the indices of the model.

Specified by:

getDataObjectExpressionLanguage in interface ILcdDataObjectIndexedModel

Returns:

the expression language used to evaluate expressions defined in the indices of the model.

setModelDescriptor

public void setModelDescriptor(ILcdModelDescriptor aModelDescriptor)

Sets a model descriptor for this model. The model descriptor must implement ILcdDataModelDescriptor for the indexing to work.

Parameters:

aModelDescriptor - A model descriptor for this model.

Throws:

IllegalArgumentException - if aModelDescriptor does not implement ILcdDataModelDescriptor.

setModelReference

public void setModelReference(ILcdModelReference aModelReference)

Sets the model reference for this model.

Parameters:

aModelReference - the model reference for this model.

setModelEncoder

public void setModelEncoder(ILcdModelEncoder aModelEncoder)

Sets the model encoder for this model.

Parameters:

aModelEncoder - a model encoder for this model.