public class TLcdNVG20FilteredModel extends Object implements ILcd2DBoundsIndexedModel, ILcdIntegerIndexedModel, ILcdTimeBounded, ILcdMultiDimensionalModel
getUnfilteredModel()ILcdModel.QueryFIRE_LATER, FIRE_NOW, NO_EVENT| Constructor and Description |
|---|
TLcdNVG20FilteredModel(TLcdNVG20Model aDelegate)
Creates a new model filtering the given NVG 2.0 model.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addElement(Object aElement,
int aEventMode)
Adds the specified element to this model.
|
void |
addElements(Vector aElements,
int aEventMode)
Adds all of the elements in the specified vector to this model.
|
void |
addModelListener(ILcdModelListener aModelListener)
Registers the specified model listener to receive notifications of model changes on this model.
|
void |
applyDimensionFilter(TLcdDimensionFilter aFilter,
int aEventMode)
Applies a given dimensional filter and fires an event accordingly.
|
int |
applyOnInteract2DBounds(ILcdBounds aBounds,
boolean aStrictInteract,
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 aElement)
Returns
true if the specified element can be added to this model, 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 of the filtered objects at the specified index.
|
void |
elementChanged(Object aElement,
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 aElements,
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.
|
ILcdBounds |
getBounds()
Returns the
ILcdBounds by which the geometry of this ILcdBounded object
is bounded. |
Date |
getDate()
Returns the current filtering value of the model.
|
TLcdDimensionFilter |
getDimensionFilter()
Returns the current filtering value of the model.
|
List<TLcdDimension<Date>> |
getDimensions()
Gets a list of dimensions, for example time or height, over which this multi-dimensional object is defined.
|
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. |
TLcdModelMetadata |
getModelMetadata()
Collects and returns metadata about the model.
|
ILcdModelReference |
getModelReference()
Returns the
ILcdModelReference describing how the geometry of the elements contained in this
model should be interpreted. |
List<Date> |
getPossibleDates()
Deprecated.
Use
getDimensions() and ILcdDimension.getValues() instead. |
ILcdTimeBounds |
getTimeBounds()
Returns the
ILcdTimeBounds by which this object is bounded. |
TLcdNVG20Model |
getUnfilteredModel()
Returns the
TLcdNVG20Model model which has all the data regardless of the filter. |
int |
indexOf(Object aElement)
Returns the index of the first occurrence of the specified element in the filter objects, or -1 if this model does not
contain the element.
|
void |
removeAllElements(int aEventMode)
Removes all elements from this model.
|
void |
removeElement(Object aElement,
int aEventMode)
Removes the specified element from this model.
|
void |
removeElements(Vector aElements,
int aEventMode)
Removes all of the elements in the specified vector 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.
|
void |
setDate(Date aCurrentValue,
int aEventMode)
Sets a date value as a filter.
|
int |
size()
Returns the number of elements in this model.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitqueryclosepublic TLcdNVG20FilteredModel(TLcdNVG20Model aDelegate)
aDelegate - the model to filterpublic TLcdNVG20Model getUnfilteredModel()
TLcdNVG20Model model which has all the data regardless of the filter.TLcdNVG20Model.public int size()
ILcdIntegerIndexedModelsize in interface ILcdIntegerIndexedModelpublic Object elementAt(int aIndex)
elementAt in interface ILcdIntegerIndexedModelaIndex - an index into the filtered objects.IndexOutOfBoundsException - if an invalid index was given (aIndex < 0 || aIndex >= size()).public int indexOf(Object aElement)
i for which this.elementAt(i).equals(aElement).indexOf in interface ILcdIntegerIndexedModelaElement - the element to search for.public void setDate(Date aCurrentValue, int aEventMode)
ILcdModel's Changing data for threading and locking policies.aCurrentValue - new filter date valueaEventMode - the mode for sending out the model change event. This can be one of
FIRE_NOW, FIRE_LATER or NO_EVENT.public Date getDate()
null when:
TLcdDimensionFilter.EMPTY_FILTER.applyDimensionFilter(TLcdDimensionFilter, int).null.public ILcdModelReference getModelReference()
ILcdModelILcdModelReference describing how the geometry of the elements contained in this
model should be interpreted.getModelReference in interface ILcdModelILcdModelReference of this ILcdModel.public ILcdModelDescriptor getModelDescriptor()
ILcdModelILcdModelDescriptor providing meta information about this model and
its elements.getModelDescriptor in interface ILcdModelILcdModelDescriptor of this ILcdModel. Should not be null.public ILcdModelEncoder getModelEncoder()
ILcdModelencoder.canEncode(this)), null otherwise.getModelEncoder in interface ILcdModelnull otherwise.public TLcdModelMetadata getModelMetadata()
ILcdModelTLcdModelMetadata instance every time it is called.
The default implementation uses TLcdModelMetadata.Builder.fromModel(com.luciad.model.ILcdModel).
Implementations can recreate or extend the metadata.
The following example adds a data category and source file mime type:
public TLcdModelMetadata getModelMetadata() {
String source = this.getModelDescriptor().getSourceName();
return this.getModelMetadata().asBuilder()
.entryPoint(new TLcdModelMetadata.Source(source, MIME_XML))
.addDataCategory(TLcdModelMetadata.DataCategory.VECTOR)
.build();
}
getModelMetadata in interface ILcdModelpublic Enumeration elements()
ILcdModelpublic void addElement(Object aElement, int aEventMode)
ILcdModel
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.
addElement in interface ILcdModelaElement - 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.ILcdModel.canAddElement(Object)public boolean canAddElement(Object aElement)
ILcdModeltrue 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.
canAddElement in interface ILcdModelaElement - the element to be verified.true if the specified element can be added to this model, false otherwise.public void addElements(Vector aElements, int aEventMode)
ILcdModelILcdBounded. 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.
addElements in interface ILcdModelaElements - 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.ILcdModel.canAddElement(Object)public void removeElement(Object aElement, int aEventMode)
ILcdModel
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.
removeElement in interface ILcdModelaElement - 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.ILcdModel.canRemoveElement(Object)public boolean canRemoveElement(Object aElement)
ILcdModeltrue 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.canRemoveElement in interface ILcdModelaElement - the element to be verified.true if the specified element can be removed from this model, false otherwise.public void removeElements(Vector aElements, int aEventMode)
ILcdModelThe 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.
removeElements in interface ILcdModelaElements - 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.ILcdModel.canRemoveElement(Object)public void removeAllElements(int aEventMode)
ILcdModelIf 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.
removeAllElements in interface ILcdModelaEventMode - the mode for sending out the model change event. This can be FIRE_LATER or NO_EVENT.public void elementChanged(Object aElement, int aEventMode)
ILcdModelelementChanged in interface ILcdModelaElement - the element that has changed.aEventMode - the mode for sending out the model change event. This can be FIRE_LATER or NO_EVENT.public void elementsChanged(Vector aElements, int aEventMode)
ILcdModelelementsChanged in interface ILcdModelaElements - 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.public void fireCollectedModelChanges()
ILcdModelfireCollectedModelChanges in interface ILcdModelILcdModelListener.modelChanged(TLcdModelChangedEvent)public void addModelListener(ILcdModelListener aModelListener)
ILcdModelRegisters 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.
addModelListener in interface ILcdModelaModelListener - the ILcdModelListener to register on this model.ILcdModel.removeModelListener(com.luciad.model.ILcdModelListener),
ILcdModelListenerpublic void removeModelListener(ILcdModelListener aModelListener)
ILcdModelremoveModelListener in interface ILcdModelaModelListener - the ILcdModelListener to remove.ILcdModel.addModelListener(com.luciad.model.ILcdModelListener),
ILcdModelListenerpublic void dispose()
ILcdModelfinalize) on this model subsequent to a call to
this method is undefined.dispose in interface ILcdModeldispose in interface ILcdDisposablepublic int applyOnInteract2DBounds(ILcdBounds aBounds, boolean aStrictInteract, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY)
ILcd2DBoundsIndexedModelfalse.applyOnInteract2DBounds in interface ILcd2DBoundsIndexedModelaBounds - 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.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 List<Date> getPossibleDates()
getDimensions() and ILcdDimension.getValues() instead.public ILcdTimeBounds getTimeBounds()
ILcdTimeBoundedILcdTimeBounds by which this object is bounded.getTimeBounds in interface ILcdTimeBoundedILcdTimeBounds by which this object is bounded.public void applyDimensionFilter(TLcdDimensionFilter aFilter, int aEventMode)
ILcdMultiDimensionalModel
Filtering behavior
In practice, filtering behavior and the default filter depend on the type of the model:
ALcdImage instances, every one of which is valid within a certain interval. An implementation of this
interface needs to make sure that
ALcdImage.fromDomainObject(java.lang.Object).
We advise to use the 'has-an-image' paradigm to expose this image, because it allows for faster updates
in a Lightspeed view.
Filter matching
Matching intervals happens based on TLcdDimensionInterval.overlaps(com.luciad.multidimensional.TLcdDimensionInterval<T>, com.luciad.multidimensional.TLcdDimensionInterval<T>).
The rationale for this is the following:
Locking
This method should typically be called from within a write lock:
try (TLcdLockUtil.Lock lock = TLcdLockUtil.writeLock(model) {
...
model.applyDimensionFilter(filter, ILcdModel.FIRE_LATER);
...
} finally {
model.fireCollectedModelChanges();
}
ILcdModel.NO_EVENT.
No snapping
Implementations should not 'snap' to the intervals defined by the filter in case no elements match.
There shall be no snapping to nearest, previous or next.
Instead, the result must be 'empty' (or 'image is null' in case of raster models).
If you need to snap a filter interval to an actual interval the model has to offer, you should use
TLcdDimensionFilter.createSnappingFilter(com.luciad.multidimensional.ILcdMultiDimensionalModel, com.luciad.multidimensional.TLcdDimensionFilter.SnapMode) to create a snapped filter.
Differences with createSnappingFilter
As its name suggests, the primary purpose of the utility method createSnappingFilter is to create a
filter which 'snaps' to filter intervals so that there is always at least one match.
But the method does more than just that.
Here is a list of differences between using and not using createSnappingFilter:
| Behavior | applyDimensionFilter | createSnappingFilter->applyDimensionFilter |
|---|---|---|
| Snapping | Never, possibly resulting in no matches | Snaps to intervals defined by the model if needed, such that there is always at least one match |
| Supported snap modes | None | Nearest, previous, next, or none (null) |
| Filter has less axes than supported by model | Reset to default for those axes | Keep the last current filter value for those axes, so that there are minimal model changes |
| Empty filter | Reset to default filter | Keep current filter, so that there are no model changes |
ILcdModel which is not ILcdMultiDimensionalModel |
Not supported | Checks instance of ILcdMultiDimensionalModel, leaves others alone |
applyDimensionFilter in interface ILcdMultiDimensionalModelaFilter - The dimensional filter, possibly empty but never null.aEventMode - The mode of the event that should be triggered when the value of the filter parameters changes.TLcdDimensionInterval.overlaps(com.luciad.multidimensional.TLcdDimensionInterval<T>, com.luciad.multidimensional.TLcdDimensionInterval<T>),
TLcdDimensionFilter.createSnappingFilter(com.luciad.multidimensional.ILcdMultiDimensionalModel, com.luciad.multidimensional.TLcdDimensionFilter.SnapMode)public TLcdDimensionFilter getDimensionFilter()
null when:
TLcdDimensionFilter.EMPTY_FILTER.applyDimensionFilter(TLcdDimensionFilter, int).getDimensionFilter in interface ILcdMultiDimensionalModelnull.public List<TLcdDimension<Date>> getDimensions()
ILcdMultiDimensionalgetDimensions in interface ILcdMultiDimensionalnull.ILcdMultiDimensionalModel