Package com.luciad.realtime

Class TLcdTrackModel

java.lang.Object
com.luciad.model.ALcdModel
com.luciad.realtime.TLcdTrackModel
All Implemented Interfaces:
ILcd2DBoundsIndexedModel, ILcd2DBoundsInteractable, ILcdIntegerIndexedModel, ILcdModel, ILcdBounded, ILcdDisposable, Serializable, AutoCloseable
public class TLcdTrackModel extends ALcdModel implements ILcd2DBoundsIndexedModel, ILcdIntegerIndexedModel
This extension of ALcdModel was designed to store (large) data sets of moving point objects, for example tracks. It is less useful for objects other than points. It provides constant-time performance for adding or changing objects. Removing an object requires time proportional to the size of the model. As it implements ILcd2DBoundsIndexedModel, objects can be spatially queried. Such a query roughly requires time proportional to the amount of elements that match the query. Through the interface ILcdIntegerIndexedModel objects can be queried by index, in constant-time performance.

Compared to TLcdVectorModel, adding, changing and removing objects has a similar cost. But because spatially querying objects from a TLcdVectorModel is not possible, this implementation will outperform a TLcdVectorModel when for example zooming in, as at that point only the visible objects need to be queried. Compared to TLcd2DBoundsIndexedModel, which also supports spatial querying, this model is faster when objects are changed.

The model has to be constructed with initial bounds that will be sub-divided in a grid of rectangular sub-blocks (the number of rows and columns can be specified in the constructor). Objects are added within the sub-block they fit into. If they do not fit in any sub-block, they are added in a separate block that collects all such elements. The initial bounds should be chosen so that the majority of the objects is contained in it. The larger the initial bounds are, the larger the values for the number of rows and columns should be.

Since:
4.0
See Also:

  • Constructor Details

    • TLcdTrackModel

      public TLcdTrackModel(ILcdBounds aBounds)

      Constructs a TLcdTrackModel with a grid of 8 by 8 blocks.

      Parameters:
      aBounds - The bounds of this model. The coordinates and dimensions of these bounds should be expressed relative to the model reference.

    • TLcdTrackModel

      public TLcdTrackModel(ILcdBounds aBounds, int aNumberRows, int aNumberColumns)

      Constructs a TLcdTrackModel with a grid of aNumberRows by aNumberColumns blocks. The number of rows and the number of columns are at least 2.

      Parameters:
      aBounds - The bounds of this model. The coordinates and dimensions of these bounds should be expressed relative to the model reference.
      aNumberRows - the number of sub-divisions along the y-axis. If this number is less than 2 it will be ignored and the number of rows will be set to 2.
      aNumberColumns - the number of sub-divisions along the x-axis. If this number is less than 2 it will be ignored and the number of columns will be set to 2.

  • Method Details

    • 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) throws IllegalArgumentException
      Description copied from class: ALcdModel
      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 UnsupportedOperationException.

      Specified by:
      addElement in interface ILcdModel
      Overrides:
      addElement in class ALcdModel
      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.
      Throws:
      IllegalArgumentException
      See Also:

    • canAddElement

      public boolean canAddElement(Object aObject)
      This model accepts only ILcdBounded objects.
      Specified by:
      canAddElement in interface ILcdModel
      Overrides:
      canAddElement in class ALcdModel
      Parameters:
      aObject - the object to be added.
      Returns:
      true if the object implements ILcdbounded, false otherwise.
      See Also:

    • removeElement

      public void removeElement(Object aObject, int aEventMode) throws IllegalArgumentException
      Description copied from class: ALcdModel
      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 UnsupportedOperationException.

      Specified by:
      removeElement in interface ILcdModel
      Overrides:
      removeElement in class ALcdModel
      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.
      Throws:
      IllegalArgumentException
      See Also:

    • removeElements

      public void removeElements(Vector aElements, int aFireEventMode)
      Description copied from class: ALcdModel
      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
      Overrides:
      removeElements in class ALcdModel
      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:

    • canRemoveElement

      public boolean canRemoveElement(Object aObject)
      Description copied from class: ALcdModel
      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
      Overrides:
      canRemoveElement in class ALcdModel
      Parameters:
      aObject - the element to be verified.
      Returns:
      true if the specified element can be removed from this model, false otherwise.

    • elementChanged

      public void elementChanged(Object aObject, int aFireEventMode) throws IllegalArgumentException
      Description copied from class: ALcdModel
      Notifies this model that the specified element has changed.

      This implementation calls TLcdModelChangedEventSupport#elementChanged(Object, int).

      Specified by:
      elementChanged in interface ILcdModel
      Overrides:
      elementChanged in class ALcdModel
      Parameters:
      aObject - the element that has changed.
      aFireEventMode - the mode for sending out the model change event. This can be FIRE_LATER or NO_EVENT.
      Throws:
      IllegalArgumentException

    • elementsChanged

      public void elementsChanged(Vector aObjects, int aFireEventMode) throws IllegalArgumentException
      Description copied from class: ALcdModel
      Notifies this model that the elements in the specified vector have changed.

      This implementation calls TLcdModelChangedEventSupport#elementsChanged(java.util.Vector, int).

      Specified by:
      elementsChanged in interface ILcdModel
      Overrides:
      elementsChanged in class ALcdModel
      Parameters:
      aObjects - the vector of elements that have changed.
      aFireEventMode - the mode for sending out the model change event. This can be FIRE_LATER or NO_EVENT.
      Throws:
      IllegalArgumentException

    • allElementsChanged

      public void allElementsChanged(int aFireEventMode)
      Description copied from class: ALcdModel
      Notifies this model that all elements have changed.

      This implementation calls TLcdModelChangedEventSupport#allElementsChanged(int).

      Overrides:
      allElementsChanged in class ALcdModel
      Parameters:
      aFireEventMode - the mode for sending out the model change event. This can be one of FIRE_NOW, FIRE_LATER or NO_EVENT. In case of FIRE_NOW mode, only one event will be fired, containing all changes.

    • removeAllElements

      public void removeAllElements(int aEventMode)
      Description copied from class: ALcdModel
      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 iterates over all elements in the model, 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:
      removeAllElements in interface ILcdModel
      Overrides:
      removeAllElements in class ALcdModel
      Parameters:
      aEventMode - the mode for sending out the model change event. This can be FIRE_LATER or NO_EVENT.

    • applyOnInteract2DBounds

      public int applyOnInteract2DBounds(ILcdBounds aBounds, boolean aStrictOverlap, 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.
      aStrictOverlap - 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.

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

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

    • contains

      public boolean contains(Object aObject)
      Returns whether the Object is within this TLcdTrackModel.
      Parameters:
      aObject - the Object to be checked.
      Returns:
      whether the Object is within this TLcdTrackModel.

    • printInfo

      public void printInfo()
      Prints some info about this TLcdTrackModel.

    • paintBounds

      public void paintBounds(Graphics aGraphics, ILcdGXYContext aGXYContext)
      Paints the individual node bounds of this TLcdTrackModel on a graphics.
      Parameters:
      aGraphics - the Graphics on which to paint.
      aGXYContext - the ILcdGXYContext in which this painting occurs.