Package com.luciad.model

Class TLcdFeatureIndexedVectorModel

java.lang.Object
com.luciad.model.TLcdFeatureIndexedVectorModel
All Implemented Interfaces:
ILcdFeatureIndexedModel, ILcdIntegerIndexedModel, ILcdModel, ILcdDisposable, Serializable, AutoCloseable
@Deprecated public class TLcdFeatureIndexedVectorModel extends Object implements ILcdFeatureIndexedModel, ILcdIntegerIndexedModel
Deprecated.
The ILcdFeatured interface has been deprecated in favor of ILcdDataObject and TLcdDataModel.
Default implementation of ILcdFeatureIndexedModel that also implements ILcdIntegerIndexedModel.

This class maintains one or more feature-based indices internally, allowing fast access to its elements based on one or more feature values. All elements contained in this model should therefore implement ILcdFeatured. Users should notify this model whenever a feature of an element in the model has changed, to allow the model to update its indices. This can be done by means of the elementChanged(Object, int) method.

All elements are additionally stored in a linear index, allowing fast integer- based queries.

Users may consider using this model if all of the following conditions are met:

  • fast access based on feature properties is required,
  • no spatial queries are involved.
The package documentation provides a detailed overview of all model implementations that are available in this package, and their usage.

To retrieve the model elements by index, one should first call the addIndex(java.util.List, boolean) method to put the right index on the model. If an index is no longer needed, it can be removed using removeIndex(java.util.List) .

If the user intends to make use of indices (adding, removing, retrieving), he should make sure that:

  • a proper model descriptor is set on this model, implementing ILcdFeaturedDescriptor,
  • all elements contained in this model implement the ILcdFeatured interface, and the feature values in the elements correspond to the feature names defined in the model descriptor.
Since:
7.2
See Also:

  • Nested Class Summary

    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
    Description
    TLcdFeatureIndexedVectorModel()
    Deprecated.
    Constructs a new, empty TLcdFeatureIndexedVectorModel.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addElement(Object aElement, int aEventMode)
    Deprecated.
    Adds the specified element to this model.
    void
    addElements(Vector aElements, int aFireEventMode)
    Deprecated.
    Adds all of the elements in the specified vector to this model.
    void
    addIndex(List aFeatureNames, boolean aUniqueIndex)
    Deprecated.
    Creates an index based on a set of feature names.
    void
    addModelListener(ILcdModelListener aModelListener)
    Deprecated.
    Registers the specified model listener to receive notifications of model changes on this model.
    boolean
    canAddElement(Object aElement)
    Deprecated.
    Returns true if the specified element can be added to this model, false otherwise.
    boolean
    canAddIndex(List aFeatureNames, boolean isUniqueIndex)
    Deprecated.
    Checks whether a useful index can be created for the specified set of feature names.
    boolean
    canRemoveElement(Object aElement)
    Deprecated.
    Returns true if the specified element can be removed from this model, false otherwise.
    void
    dispose()
    Deprecated.
    Disposes of this model and allows it to release any system resources that it is holding.
    Object
    elementAt(int aIndex)
    Deprecated.
    Returns the element at the specified index.
    void
    elementChanged(Object aObject, int aEventMode)
    Deprecated.
    Notifies this model that the specified element has changed.
    Enumeration
    elements()
    Deprecated.
    Returns an enumeration over all elements of this model.
    void
    elementsChanged(Vector aObjects, int aEventMode)
    Deprecated.
    Notifies this model that the elements in the specified vector have changed.
    void
    fireCollectedModelChanges()
    Deprecated.
    Notifies all listeners that are registered on this model of all the changes that have been collected between the previous notification and now.
    ILcdModelDescriptor
    getModelDescriptor()
    Deprecated.
    Returns the ILcdModelDescriptor providing meta information about this model and its elements.
    ILcdModelEncoder
    getModelEncoder()
    Deprecated.
    Returns, if available, a model encoder that is capable of encoding this model, (encoder.canEncode(this)), null otherwise.
    ILcdModelReference
    getModelReference()
    Deprecated.
    Returns the ILcdModelReference describing how the geometry of the elements contained in this model should be interpreted.
    boolean
    hasIndex(List aFeatureNames, boolean aUniqueIndex)
    Deprecated.
    Checks whether the given list of feature names is already added as index to this model.
    int
    indexOf(Object aObject)
    Deprecated.
    Returns the index of the first occurrence of the specified element in the model, or -1 if this model does not contain the element.
    boolean
    isTraceOn()
    Deprecated.
    This method has been deprecated.
    void
    removeAllElements(int aEventMode)
    Deprecated.
    Removes all elements from this model.
    void
    removeElement(Object aElement, int aEventMode)
    Deprecated.
    Removes the specified element from this model.
    void
    removeElements(Vector aElements, int aFireEventMode)
    Deprecated.
    Removes all of the elements in the specified vector from this model.
    void
    removeIndex(List aFeatureNames)
    Deprecated.
    Removes an index from the model.
    void
    removeModelListener(ILcdModelListener aModelListener)
    Deprecated.
    Unregisters the specified model listener so that it no longer receives notifications of model changes on this model.
    Vector
    retrieveByIndex(List aFeatureNames, List aFeatureValues)
    Deprecated.
    Returns a Vector containing all the model elements that have aFeatureValues as value for the index defined by aFeatureNames.
    Object
    retrieveByUniqueIndex(List aFeatureNames, List aFeatureValues)
    Deprecated.
    Returns a single model element that has aFeatureValues as values for the index defined by aFeatureNames.
    void
    setModelDescriptor(ILcdModelDescriptor aModelDescriptor)
    Deprecated.
    Sets a model descriptor for this TLcdFeatureIndexedVectorModel.
    void
    setModelEncoder(ILcdModelEncoder aModelEncoder)
    Deprecated.
    Sets the model encoder for this TLcdFeatureIndexedVectorModel.
    void
    setModelReference(ILcdModelReference aModelReference)
    Deprecated.
    Sets the model reference for this TLcdFeatureIndexedVectorModel.
    static void
    setTraceOn(boolean aTraceOn)
    Deprecated.
    This method has been deprecated.
    int
    size()
    Deprecated.
    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.util.ILcdDisposable

    close

    Methods inherited from interface com.luciad.model.ILcdModel

    getModelMetadata, query

  • Constructor Details

    • TLcdFeatureIndexedVectorModel

      public TLcdFeatureIndexedVectorModel()
      Deprecated.
      Constructs a new, empty TLcdFeatureIndexedVectorModel.

  • Method Details

    • size

      public int size()
      Deprecated.
      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)
      Deprecated.
      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)
      Deprecated.
      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()
      Deprecated.
      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()
      Deprecated.
      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()
      Deprecated.
      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()
      Deprecated.
      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.

    • addElement

      public void addElement(Object aElement, int aEventMode) throws IllegalArgumentException
      Deprecated.
      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:

    • canAddElement

      public boolean canAddElement(Object aElement)
      Deprecated.
      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.

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

      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.

    • addElements

      public void addElements(Vector aElements, int aFireEventMode)
      Deprecated.
      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:

    • removeElement

      public void removeElement(Object aElement, int aEventMode) throws IllegalArgumentException
      Deprecated.
      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:

    • canRemoveElement

      public boolean canRemoveElement(Object aElement)
      Deprecated.
      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 ILcdFeatured.

      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.

    • removeElements

      public void removeElements(Vector aElements, int aFireEventMode)
      Deprecated.
      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:

    • removeAllElements

      public void removeAllElements(int aEventMode)
      Deprecated.
      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)
      Deprecated.
      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)
      Deprecated.
      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()
      Deprecated.
      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:

    • addModelListener

      public void addModelListener(ILcdModelListener aModelListener)
      Deprecated.
      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:

    • removeModelListener

      public void removeModelListener(ILcdModelListener aModelListener)
      Deprecated.
      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:

    • dispose

      public void dispose()
      Deprecated.
      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 ILcdDisposable
      Specified by:
      dispose in interface ILcdModel

    • addIndex

      public void addIndex(List aFeatureNames, boolean aUniqueIndex)
      Deprecated.
      Description copied from interface: ILcdFeatureIndexedModel
      Creates an index based on a set of feature names. All elements already contained in the model will be added to the new index; elements which are added after the index has been created, will be added automatically to all indices that have been created already.

      Note that each index consumes memory and it is advisable to keep the number of indices to a minimum. When an index is added that exists already (same names, same order), no new index is created.

      Specified by:
      addIndex in interface ILcdFeatureIndexedModel
      Parameters:
      aFeatureNames - the List of feature names defining the index to be created.
      aUniqueIndex - a boolean indicating whether the features used in this index form a unique key for the model elements (this means that for each element the set of feature values for aFeatureNames is unique in the model). If a unique index is created on a non-unique feature, only one element per feature value is stored in the index.

    • removeIndex

      public void removeIndex(List aFeatureNames)
      Deprecated.
      Description copied from interface: ILcdFeatureIndexedModel
      Removes an index from the model. If the specified index does not exist in this model, this method has no effect.
      Specified by:
      removeIndex in interface ILcdFeatureIndexedModel
      Parameters:
      aFeatureNames - a List of feature names defining the index to be removed.

    • retrieveByIndex

      public Vector retrieveByIndex(List aFeatureNames, List aFeatureValues)
      Deprecated.
      Description copied from interface: ILcdFeatureIndexedModel
      Returns a Vector containing all the model elements that have aFeatureValues as value for the index defined by aFeatureNames.

      Can return null if there is no match.

      Specified by:
      retrieveByIndex in interface ILcdFeatureIndexedModel
      Parameters:
      aFeatureNames - a List of feature names defining the index to be used.
      aFeatureValues - a List of feature values that should match with the values of the elements to be retrieved.
      Returns:
      a Vector with zero or more matching elements, or null if there is no match

    • retrieveByUniqueIndex

      public Object retrieveByUniqueIndex(List aFeatureNames, List aFeatureValues)
      Deprecated.
      Description copied from interface: ILcdFeatureIndexedModel
      Returns a single model element that has aFeatureValues as values for the index defined by aFeatureNames.

      This method should only be used for indices create with aUniqueIndex == true.

      Specified by:
      retrieveByUniqueIndex in interface ILcdFeatureIndexedModel
      Parameters:
      aFeatureNames - a List of feature names defining the index to be used.
      aFeatureValues - a List of feature values that should match with the values of the elements to be retrieved.
      Returns:
      A single model element that has aFeatureValues as values for the index defined by aFeatureNames, or null if no such element exist in this model.

    • canAddIndex

      public boolean canAddIndex(List aFeatureNames, boolean isUniqueIndex)
      Deprecated.
      Checks whether a useful index can be created for the specified set of feature names. A index can be added if
      • it does not exist yet.
      • all feature names are present in the featured model descriptor of this model.
      Specified by:
      canAddIndex in interface ILcdFeatureIndexedModel
      Parameters:
      aFeatureNames - the list of feature names to be checked.
      isUniqueIndex - flag indicating whether the index should be unique or not.
      Returns:
      true if a useful index can be created for the given list of feature names, false otherwise.
      Throws:
      NullPointerException - if aFeatureNames or one of its elements is null.

    • setModelDescriptor

      public void setModelDescriptor(ILcdModelDescriptor aModelDescriptor)
      Deprecated.
      Sets a model descriptor for this TLcdFeatureIndexedVectorModel. The model descriptor must implement ILcdFeaturedDescriptor for the indexing to work.
      Parameters:
      aModelDescriptor - A model descriptor for this TLcdFeatureIndexedVectorModel.
      Throws:
      IllegalArgumentException - if the argument aModelDescriptor does not implement ILcdFeaturedDescriptor.

    • setModelReference

      public void setModelReference(ILcdModelReference aModelReference)
      Deprecated.
      Sets the model reference for this TLcdFeatureIndexedVectorModel.
      Parameters:
      aModelReference - the model reference for this TLcdFeatureIndexedVectorModel.

    • setModelEncoder

      public void setModelEncoder(ILcdModelEncoder aModelEncoder)
      Deprecated.
      Sets the model encoder for this TLcdFeatureIndexedVectorModel.
      Parameters:
      aModelEncoder - a model encoder for this TLcdFeatureIndexedVectorModel.

    • hasIndex

      public boolean hasIndex(List aFeatureNames, boolean aUniqueIndex)
      Deprecated.
      Checks whether the given list of feature names is already added as index to this model.
      Parameters:
      aFeatureNames - A List of strings denoting the feature names
      aUniqueIndex - A boolean indicating whether the features used in this index form a unique key for the model objects (this means that for each object the set of feature values for aFeatureNames is unique in the model).
      Returns:
      True if there is already an index on the given list of feature names.
      Throws:
      NullPointerException - if aFeatureNames or one of its elements is null.

    • isTraceOn

      public boolean isTraceOn()
      Deprecated.
      This method has been deprecated. It is recommended to use the standard Java logging framework directly.
      Returns true if tracing is enabled for this class.
      Returns:
      true if tracing is enabled for this class, false otherwise.

    • setTraceOn

      public static void setTraceOn(boolean aTraceOn)
      Deprecated.
      This method has been deprecated. It is recommended to use the standard Java logging framework directly.
      Enables tracing for this class instance. Calling this method with either true or false as argument automatically turns off tracing for all other class instances for which setTraceOn has not been called. If the argument is false then only the informative, warning and error log messages are recorded.
      Parameters:
      aTraceOn - if true then all log messages are recorded for this instance. If false, then only the informative, warning and error log messages are recorded.