public class TLcdTrackModel extends ALcdModel implements ILcd2DBoundsIndexedModel, ILcdIntegerIndexedModel
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.ILcdModel.QueryfModelEventSupportFIRE_LATER, FIRE_NOW, NO_EVENT| Constructor and Description |
|---|
TLcdTrackModel(ILcdBounds aBounds)
Constructs a
TLcdTrackModel with a grid of 8 by 8 blocks. |
TLcdTrackModel(ILcdBounds aBounds,
int aNumberRows,
int aNumberColumns)
Constructs a
TLcdTrackModel with a grid of aNumberRows by
aNumberColumns blocks. |
| Modifier and Type | Method and Description |
|---|---|
void |
addElement(Object aObject,
int aEventMode)
Adds the specified element to this model.
|
void |
allElementsChanged(int aFireEventMode)
Notifies this model that all elements have changed.
|
int |
applyOnInteract2DBounds(ILcdBounds aBounds,
boolean aStrictOverlap,
ILcdFunction aFunctionToApply,
double aPrecisionX,
double aPrecisionY)
Applies the specified function to all the model elements of which the 2D bounds overlap with the specified bounds.
|
int |
applyOnInteract2DBounds(ILcdBounds aBounds,
boolean aStrictInteract,
ILcdFunction aFunctionToApply,
double aPrecisionX,
double aPrecisionY,
double aMinSizeX,
double aMinSizeY,
boolean aIncludePoints)
Applies the specified function to all the elements of which the 2D bounds overlap with the specified bounds.
|
boolean |
canAddElement(Object aObject)
This model accepts only
ILcdBounded objects. |
boolean |
canRemoveElement(Object aObject)
Returns
true if the specified element can be removed from this model, false otherwise. |
boolean |
contains(Object aObject)
Returns whether the Object is within this
TLcdTrackModel. |
Object |
elementAt(int aIndex)
Returns the element at the specified index.
|
void |
elementChanged(Object aObject,
int aFireEventMode)
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 aFireEventMode)
Notifies this model that the elements in the specified vector have changed.
|
ILcdBounds |
getBounds()
Returns the
ILcdBounds by which the geometry of this ILcdBounded object
is bounded. |
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 |
paintBounds(Graphics aGraphics,
ILcdGXYContext aGXYContext)
Paints the individual node bounds of this
TLcdTrackModel on a graphics. |
void |
printInfo()
Prints some info about this
TLcdTrackModel. |
void |
removeAllElements(int aEventMode)
Removes all elements from this model.
|
void |
removeElement(Object aObject,
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.
|
int |
size()
Returns the number of elements in this model.
|
addElements, addModelListener, allElementsRemoved, dispose, elementAdded, elementRemoved, elementsAdded, elementsRemoved, fireCollectedModelChanges, getModelDescriptor, getModelEncoder, getModelMetadata, getModelReference, initializeTransientValues, isClassTraceOn, isTraceOn, removeModelListener, setClassTraceOn, setModelDescriptor, setModelDisposer, setModelEncoder, setModelMetadataFunction, setModelReference, setTraceOnclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitqueryaddElements, addModelListener, all, dispose, filter, fireCollectedModelChanges, getModelDescriptor, getModelEncoder, getModelMetadata, getModelReference, removeModelListenerclosepublic TLcdTrackModel(ILcdBounds aBounds)
Constructs a TLcdTrackModel with a grid of 8 by 8 blocks.
aBounds - The bounds of this model. The coordinates and dimensions of these bounds should
be expressed relative to the model reference.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.
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.public Enumeration elements()
ILcdModelpublic void addElement(Object aObject, int aEventMode) throws IllegalArgumentException
ALcdModel
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.
addElement in interface ILcdModeladdElement in class ALcdModelaObject - 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.IllegalArgumentExceptionILcdModel.canAddElement(Object)public boolean canAddElement(Object aObject)
ILcdBounded objects.canAddElement in interface ILcdModelcanAddElement in class ALcdModelaObject - the object to be added.ILcdbounded, false otherwise.ILcd2DBoundsIndexedModelpublic void removeElement(Object aObject, int aEventMode) throws IllegalArgumentException
ALcdModel
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.
removeElement in interface ILcdModelremoveElement in class ALcdModelaObject - 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.IllegalArgumentExceptionILcdModel.canRemoveElement(Object)public void removeElements(Vector aElements, int aFireEventMode)
ALcdModelThe 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.
removeElements in interface ILcdModelremoveElements in class ALcdModelaElements - 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.ILcdModel.canRemoveElement(Object)public boolean canRemoveElement(Object aObject)
ALcdModeltrue 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.
canRemoveElement in interface ILcdModelcanRemoveElement in class ALcdModelaObject - the element to be verified.true if the specified element can be removed from this model, false otherwise.public void elementChanged(Object aObject, int aFireEventMode) throws IllegalArgumentException
ALcdModel
This implementation calls TLcdModelChangedEventSupport#elementChanged(Object, int).
elementChanged in interface ILcdModelelementChanged in class ALcdModelaObject - the element that has changed.aFireEventMode - the mode for sending out the model change event. This can be FIRE_LATER or NO_EVENT.IllegalArgumentExceptionpublic void elementsChanged(Vector aObjects, int aFireEventMode) throws IllegalArgumentException
ALcdModelThis implementation calls TLcdModelChangedEventSupport#elementsChanged(java.util.Vector, int).
elementsChanged in interface ILcdModelelementsChanged in class ALcdModelaObjects - 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.IllegalArgumentExceptionpublic void allElementsChanged(int aFireEventMode)
ALcdModelThis implementation calls TLcdModelChangedEventSupport#allElementsChanged(int).
allElementsChanged in class ALcdModelaFireEventMode - 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.public void removeAllElements(int aEventMode)
ALcdModelIf 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.
removeAllElements in interface ILcdModelremoveAllElements in class ALcdModelaEventMode - the mode for sending out the model change event. This can be FIRE_LATER or NO_EVENT.public int applyOnInteract2DBounds(ILcdBounds aBounds, boolean aStrictOverlap, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY)
ILcd2DBoundsIndexedModelfalse.applyOnInteract2DBounds in interface ILcd2DBoundsIndexedModelaBounds - 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.ILcdFunction has been applied.public int applyOnInteract2DBounds(ILcdBounds aBounds, boolean aStrictInteract, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY, double aMinSizeX, double aMinSizeY, boolean aIncludePoints)
ILcd2DBoundsInteractablefalse for an element it was applied on.applyOnInteract2DBounds in interface ILcd2DBoundsIndexedModelapplyOnInteract2DBounds in interface ILcd2DBoundsInteractableaBounds - 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.ILcdFunction has been applied.public ILcdBounds getBounds()
ILcdBoundedILcdBounds 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.
getBounds in interface ILcdBoundedILcdBounds by which the geometry of this ILcdBounded object
is bounded.public int size()
ILcdIntegerIndexedModelsize in interface ILcdIntegerIndexedModelpublic Object elementAt(int aIndex)
ILcdIntegerIndexedModelelementAt in interface ILcdIntegerIndexedModelaIndex - an index into this ILcdModel.public int indexOf(Object aObject)
ILcdIntegerIndexedModeli for which this.elementAt(i).equals(aElement).indexOf in interface ILcdIntegerIndexedModelaObject - the element to search for.public boolean contains(Object aObject)
TLcdTrackModel.aObject - the Object to be checked.TLcdTrackModel.public void printInfo()
TLcdTrackModel.public void paintBounds(Graphics aGraphics, ILcdGXYContext aGXYContext)
TLcdTrackModel on a graphics.aGraphics - the Graphics on which to paint.aGXYContext - the ILcdGXYContext in which this painting occurs.