Package com.luciad.model

Class TLcdSoft2DBoundsIndexedModel

java.lang.Object
com.luciad.model.TLcdSoft2DBoundsIndexedModel
All Implemented Interfaces:
ILcd2DBoundsIndexedModel, ILcd2DBoundsInteractable, ILcdModel, ILcdBounded, ILcdDisposable, Serializable, AutoCloseable
public class TLcdSoft2DBoundsIndexedModel extends Object implements ILcd2DBoundsIndexedModel
An implementation of ILcd2DBoundsIndexedModel that lazily loads its contents when they are first queried.

This model requires a source name and a model decoder that can decode the source. The model decoder should return an ILcd2DBoundsIndexedModel. The model will only be loaded into memory when its properties or its elements are requested. It is then cached in a SoftReference.

Some properties of a model are almost immediately queried when the model is added to a view. To postpone the loading of the underlying model as long as possible, one can set these properties on this model, if they are known beforehand:

The model is read-only. It is thread-safe for accessing its contained model.

See Also:

  • Constructor Details

    • TLcdSoft2DBoundsIndexedModel

      public TLcdSoft2DBoundsIndexedModel()
      Constructs a new TLcdSoft2DBoundsIndexedModel. The user has to set a valid source (setSource(String)) and corresponding model decoder setModelDecoder(ILcdModelDecoder)) before using this model.

    • TLcdSoft2DBoundsIndexedModel

      public TLcdSoft2DBoundsIndexedModel(String aSource, ILcdModelDecoder aModelDecoder)
      Constructs a new TLcdSoft2DBoundsIndexedModel with the specified source and corresponding model decoder.

      For optimal performance, one should consider also setting the model reference, model descriptor and model bounds on this model, if they are known without loading the actual model.

      Parameters:
      aSource - the source of the model to be loaded.
      aModelDecoder - the model decoder that can decode the specified source.
      See Also:

    • TLcdSoft2DBoundsIndexedModel

      public TLcdSoft2DBoundsIndexedModel(String aSource, ILcdModelDecoder aModelDecoder, ILcdModelReference aModelReference, ILcdBounds aModelBounds)
      Constructs a new TLcdSoft2DBoundsIndexedModel with the specified source and corresponding model decoder, model reference and model bounds.
      Parameters:
      aSource - the source of the model to be loaded.
      aModelDecoder - the model decoder that can decode the specified source.
      aModelReference - the model reference of this model.
      aModelBounds - the model bounds of this model.

    • TLcdSoft2DBoundsIndexedModel

      public TLcdSoft2DBoundsIndexedModel(String aSource, ILcdModelDecoder aModelDecoder, ILcd2DBoundsIndexedModel aModel)
      Constructs a new TLcdSoft2DBoundsIndexedModel with the specified source and corresponding model decoder, and an already decoded model instance. The decoded instance is cached in a SoftReference. The model reference, model descriptor and model bounds are are also cached in this model.
      Parameters:
      aSource - the source of the model to be loaded.
      aModelDecoder - the model decoder that can decode the specified source.
      aModel - an already decoded model instance.

  • Method Details

    • setClassTraceOn

      public static void setClassTraceOn(boolean aClassTraceOn)
      Deprecated.
      This method has been deprecated. It is recommended to use the standard Java logging framework directly.
      Enables tracing for all instances of this class. If the argument is true then all log messages are recorded, otherwise only the informative, warning and error messages are recorded.
      Parameters:
      aClassTraceOn - if true then all log messages are recorded, otherwise only the informative, warning and error messages are recorded.

    • isClassTraceOn

      public static boolean isClassTraceOn()
      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.

    • setSource

      public void setSource(String aSource)
      Sets the source of this model.
      Parameters:
      aSource - the source of the model.
      See Also:

    • getSource

      public String getSource()
      Gets the source of this model.
      Returns:
      the source of this model.
      See Also:

    • setModelDecoder

      public void setModelDecoder(ILcdModelDecoder aModelDecoder)
      Sets the ILcdModelDecoder for this ILcdModel.
      Parameters:
      aModelDecoder - the model decoder for decoding the source into a model.
      See Also:

    • getModelDecoder

      public ILcdModelDecoder getModelDecoder()
      Gets the ILcdModelDecoder for this ILcdModel.
      Returns:
      the ILcdModelDecoder for this ILcdModel.
      See Also:

    • setAnticipatedModelReference

      public void setAnticipatedModelReference(ILcdModelReference aAnticipatedModelReference)
      Sets the ILcdModelReference of this ILcdModel. Optional property used for optimized usage of this TLcdSoft2DBoundsIndexedModel.
      Parameters:
      aAnticipatedModelReference - the anticipated model reference of the model.

    • setAnticipatedModelBounds

      public void setAnticipatedModelBounds(ILcdBounds aAnticipatedModelBounds)
      Sets the ILcdBounds of this ILcdModel. Optional property used for optimized usage of this TLcdSoft2DBoundsIndexedModel.
      Parameters:
      aAnticipatedModelBounds - the anticipated model bounds of the model.

    • setAnticipatedModelDescriptor

      public void setAnticipatedModelDescriptor(ILcdModelDescriptor aAnticipatedModelDescriptor)
      Sets the ILcdModelDescriptor of this ILcdModel. Optional property used for optimized usage of this TLcdSoft2DBoundsIndexedModel.
      Parameters:
      aAnticipatedModelDescriptor - the anticipated model descriptor of the model.

    • 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.

    • addElement

      public void addElement(Object aObject, int aEventMode)
      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.

      This implementation always throws an IllegalArgumentException (this model is not editable).

      Specified by:
      addElement in interface ILcdModel
      Parameters:
      aObject - 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.
      See Also:

    • canAddElement

      public boolean canAddElement(Object aObject)
      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 always returns false.

      Specified by:
      canAddElement in interface ILcdModel
      Parameters:
      aObject - the element to be verified.
      Returns:
      true if the specified element can be added to this model, false otherwise.

    • addElements

      public void addElements(Vector aObjects, int aEventMode)
      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 always throws an IllegalArgumentException (this model is not editable).

      Specified by:
      addElements in interface ILcdModel
      Parameters:
      aObjects - the vector of elements to be added to this model.
      aEventMode - the mode for sending the model change events This can be FIRE_LATER or NO_EVENT.
      See Also:

    • removeElement

      public void removeElement(Object aObject, int aEventMode)
      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.

      This implementation always throws an IllegalArgumentException (this model is not editable).

      Specified by:
      removeElement in interface ILcdModel
      Parameters:
      aObject - 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.
      See Also:

    • canRemoveElement

      public boolean canRemoveElement(Object aObject)
      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 always returns false.

      Specified by:
      canRemoveElement in interface ILcdModel
      Parameters:
      aObject - the element to be verified.
      Returns:
      true if the specified element can be removed from this model, false otherwise.

    • removeElements

      public void removeElements(Vector aObjects, int aEventMode)
      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 always throws an IllegalArgumentException (this model is not editable).

      Specified by:
      removeElements in interface ILcdModel
      Parameters:
      aObjects - the vector of elements to be removed from this model.
      aEventMode - 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)
      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.

      This implementation always throws an IllegalArgumentException (this model is not editable).

      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)
      Notifies this model that the specified element has changed.

      This implementation always throws an IllegalArgumentException (this model is not editable).

      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)
      Notifies this model that the elements in the specified vector have changed.

      This implementation always throws an IllegalArgumentException (this model is not editable).

      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()
      Notifies all listeners that are registered on this model of all the changes that have been collected between the previous notification and now.

      This implementation does nothing (this model is not editable).

      Specified by:
      fireCollectedModelChanges in interface ILcdModel
      See Also:

    • addModelListener

      public void addModelListener(ILcdModelListener aModelListener)

      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.

      This implementation does nothing (this model is not editable).

      Specified by:
      addModelListener in interface ILcdModel
      Parameters:
      aModelListener - the ILcdModelListener to register on this model.
      See Also:

    • removeModelListener

      public void removeModelListener(ILcdModelListener aModelListener)
      Unregisters the specified model listener so that it no longer receives notifications of model changes on this model.

      This implementation does nothing (this model is not editable).

      Specified by:
      removeModelListener in interface ILcdModel
      Parameters:
      aModelListener - the ILcdModelListener to remove.
      See Also:

    • 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 ILcdDisposable
      Specified by:
      dispose in interface ILcdModel

    • getBounds

      public ILcdBounds getBounds()
      Description copied from interface: ILcdBounded
      Returns the ILcdBounds by which the geometry of this ILcdBounded object is bounded.

      If the geometry does not allow retrieving valid bounds (for example a polyline with 0 points) the return value is unspecified. It is highly recommended to return an undefined bounds. You can create undefined bounds using the default constructors of TLcdLonLatBounds or TLcdXYBounds.

      Specified by:
      getBounds in interface ILcdBounded
      Returns:
      the ILcdBounds by which the geometry of this ILcdBounded object is bounded.

    • applyOnInteract2DBounds

      public int applyOnInteract2DBounds(ILcdBounds aBounds, boolean aStrictInteract, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY)
      Description copied from interface: ILcd2DBoundsIndexedModel
      Applies the specified function to all the model elements of which the 2D bounds overlap with the specified bounds. By default, the order in which the function is applied on the elements is unspecified and depends on the implementation.

      The return value of the specified function is used as a stop criterion: the spatial query is interrupted if the function returns false.

      Specified by:
      applyOnInteract2DBounds in interface ILcd2DBoundsIndexedModel
      Parameters:
      aBounds - the rectangle to test overlap with.
      aStrictInteract - if false, the spatial search may return more elements than the ones strictly overlapping; if true, the search only returns the elements that are overlapping. The latter mode is more precise, but it may be slower.
      aFunctionToApply - the function to apply on each element that overlaps with the given bounds. The return value of the specified function is used as a stop criterion: the spatial query is interrupted if the function returns false.
      aPrecisionX - the precision required in the x dimension, expressed in model units. For example, for a cartesian grid system expressed in meters, the values should be expressed in meters as well, for a geodetic coordinate system the accuracy values should be expressed in degrees.

      The precision is useful in combination with multi-leveled data (multiple representations of the same object, but with varying accuracy), so that the most appropriate accuracy level can be used. 0 means best possible accuracy, but it might trigger lazy-loaded implementations to load lots of data.

      aPrecisionY - the precision required in the y dimension, expressed in model units.
      Returns:
      the number of elements to which the ILcdFunction has been applied.

    • applyOnInteract2DBounds

      public int applyOnInteract2DBounds(ILcdBounds aBounds, boolean aStrictInteract, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY, double aMinSizeX, double aMinSizeY, boolean aIncludePoints)
      Description copied from interface: ILcd2DBoundsInteractable
      Applies the specified function to all the elements of which the 2D bounds overlap with the specified bounds. The order in which the function is applied on the elements is unspecified and depends on the implementation.

      Only elements that have at least the specified minimal size in the x dimension or in the y dimension are considered. This can be useful for quickly eliminating elements that are too small to be visible in a view, for instance. If required, an exception can be made for point elements, which have a size of 0 by 0. They can be forced to be considered, even though they would always be rejected as being too small for any sizes larger than 0.

      The return value of the specified function is used as a stop criterion: the spatial query will be interrupted as soon as the function returns false for an element it was applied on.

      Specified by:
      applyOnInteract2DBounds in interface ILcd2DBoundsIndexedModel
      Specified by:
      applyOnInteract2DBounds in interface ILcd2DBoundsInteractable
      Parameters:
      aBounds - the rectangle to test overlap with.
      aStrictInteract - if false, the spatial search may return more elements than the ones strictly overlapping; if true, the search only returns the elements that are overlapping. The latter mode is more precise, but it may be slower.
      aFunctionToApply - the function to apply on each element that overlaps with the given bounds.
      aPrecisionX - the precision required in the x dimension, expressed in model units. For example, for a cartesian grid system expressed in meters, the values should be expressed in meters as well, for a geodetic coordinate system the accuracy values should be expressed in degrees.

      The precision is useful in combination with multi-leveled data (multiple representations of the same object, but with varying accuracy), so that the most appropriate accuracy level can be used. 0 means best possible accuracy, but it might trigger lazy-loaded implementations to load lots of data.

      aPrecisionY - the precision required in the y dimension, expressed in model units.
      aMinSizeX - the minimal element size in the x dimension (as in ILcdBounds.getWidth()), expressed in model units. Elements that are smaller than this size will be skipped. This may, for example, be useful when improving the efficiency of painting elements by skipping elements that are smaller than some threshold (e.g. one pixel, converted to model units).
      aMinSizeY - the minimal element size in the y dimension (as in ILcdBounds.getHeight()), expressed in model units.
      aIncludePoints - if true, zero-sized elements (points) are considered as well, even though they might be smaller than the minimum size.
      Returns:
      the number of elements to which the ILcdFunction has been applied.