Class TLcdDataObjectIndexedAnd2DBoundsIndexedModel
- All Implemented Interfaces:
ILcd2DBoundsIndexedModel
,ILcd2DBoundsInteractable
,ILcdDataObjectIndexedModel
,ILcdIntegerIndexedModel
,ILcdModel
,ILcdBounded
,ILcdDisposable
,Serializable
,AutoCloseable
ILcdDataObjectIndexedModel
which additionally implements
com.luciad.model.ILcd2DBoundsIndexedModel
.
This implementation uses hashes to store and look up all key-value pairs in its non-spatial
indices.
In addition to the constraints, imposed by ILcdDataObjectIndexedModel
, all
elements added to this model should also implement ILcdBounded
to allow storing them in
a spatial index. Users should notify this model whenever the bounds of an element in the model
are changed, to allow the model to update its index. This can be done by means of the
elementChanged(Object, int)
method.
Users may consider using this model if all of the following conditions are met:
- fast access based on expression values is required,
- fast access based on spatial queries is required.
package documentation
provides a detailed overview of all
model
implementations that are available in this package, and their usage.
Users of this model should call the elementChanged(Object, int)
method whenever the
bounds or one or more of the evaluated expressions for that element has changed, to keep all
indices up-to-date.- Since:
- 11.0.04
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.luciad.model.ILcdDataObjectIndexedModel
ILcdDataObjectIndexedModel.IndexId
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
ConstructorDescriptionConstructs a newTLcdDataObjectIndexedAnd2DBoundsIndexedModel
object.Constructs a newTLcdDataObjectIndexedAnd2DBoundsIndexedModel
object. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addElement
(Object aElement, int aEventMode) Adds the specified element to this model.void
addElements
(Vector aElements, int aFireEventMode) Adds all of the elements in the specified vector to this model.Creates a new index for the given list of expressions.void
addModelListener
(ILcdModelListener aModelListener) Registers the specified model listener to receive notifications of model changes on this model.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 aStrictOverlap, 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) Returnstrue
if the specified element can be added to this model,false
otherwise.boolean
canAddIndex
(List<String> aExpressions, boolean aIsUniqueIndex) Returnstrue
if an index can be created for the given list of expressions and uniqueness flag,false
otherwise.boolean
canRemoveElement
(Object aElement) Returnstrue
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.elementAt
(int aIndex) Returns the element at the specified index.void
elementChanged
(Object aObject, int aEventMode) Notifies this model that the specified element has changed.elements()
Returns an enumeration over all elements of this model.void
elementsChanged
(Vector aObjects, int aEventMode) Notifies this model that the elements in the specified vector have changed.void
Notifies all listeners that are registered on this model of all the changes that have been collected between the previous notification and now.Returns theILcdBounds
by which the geometry of thisILcdBounded
object is bounded.Returns the expression language used to evaluate expressions defined in the indices of the model.Returns the set of all unique expression value combinations which are present in the specified index.getIndexId
(Set<String> aExpressions) Returns the index id which corresponds to the given set of expressions, ornull
if no such index is available on this model.Returns the set of all indices which are currently available on this model.Returns theILcdModelDescriptor
providing meta information about this model and its elements.Returns, if available, a model encoder that is capable of encoding this model, (encoder.canEncode(this)
),null
otherwise.Returns theILcdModelReference
describing how the geometry of the elements contained in this model should be interpreted.int
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
removeAllElements
(int aEventMode) Removes all elements from this model.void
Removes all indices from this model.void
removeElement
(Object aElement, 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.boolean
Removes the specified index 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.retrieveAllByIndex
(ILcdDataObjectIndexedModel.IndexId aIndexId, List aExpressionValues) Returns all model elements which match the given list of values for the expressions in the given index.retrieveFirstByIndex
(ILcdDataObjectIndexedModel.IndexId aIndexId, List aExpressionValues) Returns a single model element which matches the given list of values for the expressions in the given index, ornull
if no such element exists in the model.void
setDataObjectExpressionLanguage
(ALcdDataObjectExpressionLanguage aExpressionLanguage) Sets the expression language to be used for evaluating expressions defined in the indices of the model.void
setModelDescriptor
(ILcdModelDescriptor aModelDescriptor) Sets a model descriptor for this model.void
setModelEncoder
(ILcdModelEncoder aModelEncoder) Sets the model encoder for this model.void
setModelReference
(ILcdModelReference aModelReference) Sets the model reference for this model.int
size()
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.model.ILcd2DBoundsIndexedModel
query
Methods inherited from interface com.luciad.util.ILcdDisposable
close
Methods inherited from interface com.luciad.model.ILcdModel
getModelMetadata
-
Constructor Details
-
TLcdDataObjectIndexedAnd2DBoundsIndexedModel
public TLcdDataObjectIndexedAnd2DBoundsIndexedModel()Constructs a newTLcdDataObjectIndexedAnd2DBoundsIndexedModel
object. No initial bounds is set. -
TLcdDataObjectIndexedAnd2DBoundsIndexedModel
Constructs a newTLcdDataObjectIndexedAnd2DBoundsIndexedModel
object. The initial bounds is set to the specifiedILcdBounds
object.- Parameters:
aBounds
- The initial bounds.
-
-
Method Details
-
setModelDescriptor
Sets a model descriptor for this model. The model descriptor must implementILcdDataModelDescriptor
for the indexing to work.- Parameters:
aModelDescriptor
- A model descriptor for this model.- Throws:
IllegalArgumentException
- if the argumentaModelDescriptor
does not implementILcdDataModelDescriptor
.
-
setModelReference
Sets the model reference for this model.- Parameters:
aModelReference
- the model reference for this model.
-
setModelEncoder
Sets the model encoder for this model.- Parameters:
aModelEncoder
- a model encoder for this model.
-
getModelDescriptor
Description copied from interface:ILcdModel
Returns theILcdModelDescriptor
providing meta information about this model and its elements.- Specified by:
getModelDescriptor
in interfaceILcdModel
- Returns:
- the
ILcdModelDescriptor
of thisILcdModel
. Should not benull
.
-
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 interfaceILcdModel
- Returns:
- a model encoder that is capable of encoding this model if available,
null
otherwise.
-
getModelReference
Description copied from interface:ILcdModel
Returns theILcdModelReference
describing how the geometry of the elements contained in this model should be interpreted.- Specified by:
getModelReference
in interfaceILcdModel
- Returns:
- the
ILcdModelReference
of thisILcdModel
.
-
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. -
canAddElement
Returnstrue
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 following criteria are met:- The specified element implements
ILcdBounded
. - The specified element implements
ILcdDataObject
.
- Specified by:
canAddElement
in interfaceILcdDataObjectIndexedModel
- Specified by:
canAddElement
in interfaceILcdModel
- Parameters:
aElement
- the element to be verified.- Returns:
true
if the specified element can be added to this model,false
otherwise.
- The specified element implements
-
addElement
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 interfaceILcdModel
- Parameters:
aElement
- the element to be added to this model.aEventMode
- the mode for sending out the model change event. This can beFIRE_LATER
orNO_EVENT
.- Throws:
IllegalArgumentException
- See Also:
-
addElements
Description copied from interface:ILcdModel
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 implementILcdBounded
. 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.- Specified by:
addElements
in interfaceILcdModel
- Parameters:
aElements
- the vector of elements to be added to this model.aFireEventMode
- the mode for sending the model change events This can beFIRE_LATER
orNO_EVENT
.- See Also:
-
canRemoveElement
Returnstrue
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 following criteria are met:- The specified element implements
ILcdBounded
. - The specified element implements
ILcdDataObject
.
- Specified by:
canRemoveElement
in interfaceILcdModel
- Parameters:
aElement
- the element to be verified.- Returns:
true
if the specified element can be removed from this model,false
otherwise.
- The specified element implements
-
removeElement
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 interfaceILcdModel
- Parameters:
aElement
- the element to be removed from this model.aEventMode
- the mode for sending out the model change event. This can beFIRE_LATER
orNO_EVENT
.- Throws:
IllegalArgumentException
- See Also:
-
removeElements
Description copied from interface:ILcdModel
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.- Specified by:
removeElements
in interfaceILcdModel
- Parameters:
aElements
- the vector of elements to be removed from this model.aFireEventMode
- the mode for sending out the model change event. This can beFIRE_LATER
orNO_EVENT
.- See Also:
-
removeAllElements
public void removeAllElements(int aEventMode) 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 interfaceILcdModel
- Parameters:
aEventMode
- the mode for sending out the model change event. This can beFIRE_LATER
orNO_EVENT
.
-
elementChanged
Description copied from interface:ILcdModel
Notifies this model that the specified element has changed.- Specified by:
elementChanged
in interfaceILcdModel
- Parameters:
aObject
- the element that has changed.aEventMode
- the mode for sending out the model change event. This can beFIRE_LATER
orNO_EVENT
.
-
elementsChanged
Description copied from interface:ILcdModel
Notifies this model that the elements in the specified vector have changed.- Specified by:
elementsChanged
in interfaceILcdModel
- Parameters:
aObjects
- the vector of elements that have changed.aEventMode
- the mode for sending out the model change event. This can beFIRE_LATER
orNO_EVENT
.
-
fireCollectedModelChanges
public void fireCollectedModelChanges()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 interfaceILcdModel
- See Also:
-
addModelListener
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 interfaceILcdModel
- Parameters:
aModelListener
- theILcdModelListener
to register on this model.- See Also:
-
removeModelListener
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 interfaceILcdModel
- Parameters:
aModelListener
- theILcdModelListener
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 thanfinalize
) on this model subsequent to a call to this method is undefined.- Specified by:
dispose
in interfaceILcdDisposable
- Specified by:
dispose
in interfaceILcdModel
-
addIndex
public ILcdDataObjectIndexedModel.IndexId addIndex(List<String> aExpressions, boolean aIsUniqueIndex) Description copied from interface:ILcdDataObjectIndexedModel
Creates a new index for the given list of expressions. The uniqueness flag allows to specify whether the index should be created as a unique index or not. If the index already exists on the model, this method has no effect and the index id of the existing index is returned. It is not allowed to create both a unique and a non-unique index with the same list of expressions.- Specified by:
addIndex
in interfaceILcdDataObjectIndexedModel
- Parameters:
aExpressions
- a set of expressions defining the index.aIsUniqueIndex
- boolean flag indicating whether the index is unique (has at most one element for each unique combination of expression values) or not.- Returns:
- the index id, uniquely identifying the created index.
-
canAddIndex
Description copied from interface:ILcdDataObjectIndexedModel
Returnstrue
if an index can be created for the given list of expressions and uniqueness flag,false
otherwise. An index can be created if:- There are no duplicate expressions in the expression list.
- An index with the same expressions but different uniqueness property doesn't exist yet in this model.
- The specified expressions are valid expressions for the expression language of this model, that is, the expression language is capable of compiling each of the expressions
- If the index is unique, there should at most be one model element matching each unique combination of expression values.
- Specified by:
canAddIndex
in interfaceILcdDataObjectIndexedModel
- Parameters:
aExpressions
- a set of expressions defining the index.aIsUniqueIndex
- boolean flag indicating whether the index is unique (has at most one element for each unique combination of expression values) or not.- Returns:
true
if an index can be created for the given list of expressions and uniqueness flag,false
otherwise.
-
getDataObjectExpressionLanguage
Description copied from interface:ILcdDataObjectIndexedModel
Returns the expression language used to evaluate expressions defined in the indices of the model.- Specified by:
getDataObjectExpressionLanguage
in interfaceILcdDataObjectIndexedModel
- Returns:
- the expression language used to evaluate expressions defined in the indices of the model.
-
getIndexedValues
Description copied from interface:ILcdDataObjectIndexedModel
Returns the set of all unique expression value combinations which are present in the specified index.- Specified by:
getIndexedValues
in interfaceILcdDataObjectIndexedModel
- Parameters:
aIndex
- the index for which to return the set of expression value combinations.- Returns:
- the set of expression value combinations, present in the specified index.
-
getIndexId
Description copied from interface:ILcdDataObjectIndexedModel
Returns the index id which corresponds to the given set of expressions, ornull
if no such index is available on this model. Note that, in case the set would be sorted, the order of expressions in the returned index id may be different from the order in the set. It is the order of expressions in the returned index id which determines the order of expression values to be passed toILcdDataObjectIndexedModel.retrieveAllByIndex(com.luciad.model.ILcdDataObjectIndexedModel.IndexId, java.util.List)
andILcdDataObjectIndexedModel.retrieveFirstByIndex(com.luciad.model.ILcdDataObjectIndexedModel.IndexId, java.util.List)
.- Specified by:
getIndexId
in interfaceILcdDataObjectIndexedModel
- Parameters:
aExpressions
- the expressions for which an index id should be returned.- Returns:
- the index matching the given set of expressions and uniqueness, or
null
if no such index is available.
-
getIndexIds
Description copied from interface:ILcdDataObjectIndexedModel
Returns the set of all indices which are currently available on this model. If no indices are available, an empty set is returned. If a required index is not available, it can be created usingILcdDataObjectIndexedModel.addIndex(java.util.List, boolean)
.- Specified by:
getIndexIds
in interfaceILcdDataObjectIndexedModel
- Returns:
- the set of all indices which are currently available on this model.
- See Also:
-
removeAllIndices
public void removeAllIndices()Description copied from interface:ILcdDataObjectIndexedModel
Removes all indices from this model.- Specified by:
removeAllIndices
in interfaceILcdDataObjectIndexedModel
-
removeIndex
Description copied from interface:ILcdDataObjectIndexedModel
Removes the specified index from this model. All resources allocated for the index will be released. If the index does not exist on this model, this method has no effect.- Specified by:
removeIndex
in interfaceILcdDataObjectIndexedModel
- Parameters:
aIndexId
- the index to be removed.- Returns:
true
if the specified index was successfully removed from this model,false
otherwise.
-
retrieveAllByIndex
public Collection<ILcdDataObject> retrieveAllByIndex(ILcdDataObjectIndexedModel.IndexId aIndexId, List aExpressionValues) Description copied from interface:ILcdDataObjectIndexedModel
Returns all model elements which match the given list of values for the expressions in the given index. The list of values inaExpressionValues
should contain a value for each expression inaIndexId.getExpressions()
, where the value at position i specifies the value to which the expression at position i, evaluated for each model element, should be compared to.aExpressionValues
may containnull
values. Anull
value will be considered a match if the corresponding expression for the tested model element also evaluates tonull
. If no elements match the specified expression values, an empty collection is returned.- Specified by:
retrieveAllByIndex
in interfaceILcdDataObjectIndexedModel
- Parameters:
aIndexId
- the index describing the expressions to test for.aExpressionValues
- the list of values to be compared with the list of evaluated expressions.- Returns:
- a collection containing all model elements which match the given list of values for the expressions in the given index.
- See Also:
-
retrieveFirstByIndex
public ILcdDataObject retrieveFirstByIndex(ILcdDataObjectIndexedModel.IndexId aIndexId, List aExpressionValues) Description copied from interface:ILcdDataObjectIndexedModel
Returns a single model element which matches the given list of values for the expressions in the given index, ornull
if no such element exists in the model. The list of values inaExpressionValues
should contain a value for each expression inaIndexId.getExpressions()
, where the value at position i specifies the value to which the expression at position i, evaluated for each model element, should be compared to.aExpressionValues
may containnull
values. Anull
value will be considered a match if the corresponding expression for the tested model element also evaluates tonull
.- Specified by:
retrieveFirstByIndex
in interfaceILcdDataObjectIndexedModel
- Parameters:
aIndexId
- the index describing the expressions to test for.aExpressionValues
- the list of values to be compared with the list of evaluated expressions.- Returns:
- a single model element which matches the given list of values for the expressions in
the given index, or
null
if no such element exists in the model. - See Also:
-
setDataObjectExpressionLanguage
Description copied from interface:ILcdDataObjectIndexedModel
Sets the expression language to be used for evaluating expressions defined in the indices of the model. This operation will trigger a rebuild of all indices which are currently configured on the model.- Specified by:
setDataObjectExpressionLanguage
in interfaceILcdDataObjectIndexedModel
- Parameters:
aExpressionLanguage
- the expression language used to evaluate expressions defined in the indices of the model.
-
elementAt
Description copied from interface:ILcdIntegerIndexedModel
Returns the element at the specified index.- Specified by:
elementAt
in interfaceILcdIntegerIndexedModel
- Parameters:
aIndex
- an index into thisILcdModel
.- Returns:
- the element at the specified index.
-
indexOf
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 smallesti
for whichthis.elementAt(i).equals(aElement)
.- Specified by:
indexOf
in interfaceILcdIntegerIndexedModel
- 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.
-
size
public int size()Description copied from interface:ILcdIntegerIndexedModel
Returns the number of elements in this model.- Specified by:
size
in interfaceILcdIntegerIndexedModel
- Returns:
- the number of elements in this model.
-
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 returnsfalse
.- Specified by:
applyOnInteract2DBounds
in interfaceILcd2DBoundsIndexedModel
- Parameters:
aBounds
- the rectangle to test overlap with.aStrictOverlap
- iffalse
, the spatial search may return more elements than the ones strictly overlapping; iftrue
, 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 returnsfalse
.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 aStrictOverlap, 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 returnsfalse
for an element it was applied on.- Specified by:
applyOnInteract2DBounds
in interfaceILcd2DBoundsIndexedModel
- Specified by:
applyOnInteract2DBounds
in interfaceILcd2DBoundsInteractable
- Parameters:
aBounds
- the rectangle to test overlap with.aStrictOverlap
- iffalse
, the spatial search may return more elements than the ones strictly overlapping; iftrue
, 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 inILcdBounds.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 inILcdBounds.getHeight()
), expressed in model units.aIncludePoints
- iftrue
, 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
Description copied from interface:ILcdBounded
Returns theILcdBounds
by which the geometry of thisILcdBounded
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 ofTLcdLonLatBounds
orTLcdXYBounds
.- Specified by:
getBounds
in interfaceILcdBounded
- Returns:
- the
ILcdBounds
by which the geometry of thisILcdBounded
object is bounded.
-