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.IndexIdNested 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
ConstructorsConstructorDescriptionConstructs a newTLcdDataObjectIndexedAnd2DBoundsIndexedModelobject.Constructs a newTLcdDataObjectIndexedAnd2DBoundsIndexedModelobject. -
Method Summary
Modifier and TypeMethodDescriptionvoidaddElement(Object aElement, int aEventMode) Adds the specified element to this model.voidaddElements(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.voidaddModelListener(ILcdModelListener aModelListener) Registers the specified model listener to receive notifications of model changes on this model.intapplyOnInteract2DBounds(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.intapplyOnInteract2DBounds(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.booleancanAddElement(Object aElement) Returnstrueif the specified element can be added to this model,falseotherwise.booleancanAddIndex(List<String> aExpressions, boolean aIsUniqueIndex) Returnstrueif an index can be created for the given list of expressions and uniqueness flag,falseotherwise.booleancanRemoveElement(Object aElement) Returnstrueif the specified element can be removed from this model,falseotherwise.voiddispose()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.voidelementChanged(Object aObject, int aEventMode) Notifies this model that the specified element has changed.elements()Returns an enumeration over all elements of this model.voidelementsChanged(Vector aObjects, int aEventMode) Notifies this model that the elements in the specified vector have changed.voidNotifies all listeners that are registered on this model of all the changes that have been collected between the previous notification and now.Returns theILcdBoundsby which the geometry of thisILcdBoundedobject 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, ornullif no such index is available on this model.Returns the set of all indices which are currently available on this model.Returns theILcdModelDescriptorproviding meta information about this model and its elements.Returns, if available, a model encoder that is capable of encoding this model, (encoder.canEncode(this)),nullotherwise.Returns theILcdModelReferencedescribing how the geometry of the elements contained in this model should be interpreted.intReturns the index of the first occurrence of the specified element in the model, or -1 if this model does not contain the element.voidremoveAllElements(int aEventMode) Removes all elements from this model.voidRemoves all indices from this model.voidremoveElement(Object aElement, int aEventMode) Removes the specified element from this model.voidremoveElements(Vector aElements, int aFireEventMode) Removes all of the elements in the specified vector from this model.booleanRemoves the specified index from this model.voidremoveModelListener(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, ornullif no such element exists in the model.voidsetDataObjectExpressionLanguage(ALcdDataObjectExpressionLanguage aExpressionLanguage) Sets the expression language to be used for evaluating expressions defined in the indices of the model.voidsetModelDescriptor(ILcdModelDescriptor aModelDescriptor) Sets a model descriptor for this model.voidsetModelEncoder(ILcdModelEncoder aModelEncoder) Sets the model encoder for this model.voidsetModelReference(ILcdModelReference aModelReference) Sets the model reference for this model.intsize()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, waitMethods inherited from interface com.luciad.model.ILcd2DBoundsIndexedModel
queryMethods inherited from interface com.luciad.util.ILcdDisposable
closeMethods inherited from interface com.luciad.model.ILcdModel
getModelMetadata
-
Constructor Details
-
TLcdDataObjectIndexedAnd2DBoundsIndexedModel
public TLcdDataObjectIndexedAnd2DBoundsIndexedModel()Constructs a newTLcdDataObjectIndexedAnd2DBoundsIndexedModelobject. No initial bounds is set. -
TLcdDataObjectIndexedAnd2DBoundsIndexedModel
Constructs a newTLcdDataObjectIndexedAnd2DBoundsIndexedModelobject. The initial bounds is set to the specifiedILcdBoundsobject.- Parameters:
aBounds- The initial bounds.
-
-
Method Details
-
setModelDescriptor
Sets a model descriptor for this model. The model descriptor must implementILcdDataModelDescriptorfor the indexing to work.- Parameters:
aModelDescriptor- A model descriptor for this model.- Throws:
IllegalArgumentException- if the argumentaModelDescriptordoes 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:ILcdModelReturns theILcdModelDescriptorproviding meta information about this model and its elements.- Specified by:
getModelDescriptorin interfaceILcdModel- Returns:
- the
ILcdModelDescriptorof thisILcdModel. Should not benull.
-
getModelEncoder
Description copied from interface:ILcdModelReturns, if available, a model encoder that is capable of encoding this model, (encoder.canEncode(this)),nullotherwise.- Specified by:
getModelEncoderin interfaceILcdModel- Returns:
- a model encoder that is capable of encoding this model if available,
nullotherwise.
-
getModelReference
Description copied from interface:ILcdModelReturns theILcdModelReferencedescribing how the geometry of the elements contained in this model should be interpreted.- Specified by:
getModelReferencein interfaceILcdModel- Returns:
- the
ILcdModelReferenceof thisILcdModel.
-
elements
Description copied from interface:ILcdModelReturns an enumeration over all elements of this model. The order in which the elements are enumerated is unspecified by default. -
canAddElement
Returnstrueif the specified element can be added to this model,falseotherwise. 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
trueif and only if the following criteria are met:- The specified element implements
ILcdBounded. - The specified element implements
ILcdDataObject.
- Specified by:
canAddElementin interfaceILcdDataObjectIndexedModel- Specified by:
canAddElementin interfaceILcdModel- Parameters:
aElement- the element to be verified.- Returns:
trueif the specified element can be added to this model,falseotherwise.
- The specified element implements
-
addElement
Description copied from interface:ILcdModelAdds 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:
addElementin interfaceILcdModel- Parameters:
aElement- the element to be added to this model.aEventMode- the mode for sending out the model change event. This can beFIRE_LATERorNO_EVENT.- Throws:
IllegalArgumentException- See Also:
-
addElements
Description copied from interface:ILcdModelAdds 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:
addElementsin 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_LATERorNO_EVENT.- See Also:
-
canRemoveElement
Returnstrueif the specified element can be removed from this model,falseotherwise. Note that this method generally does not check whether the specified element is actually contained in this model.This implementation returns
trueif and only if the following criteria are met:- The specified element implements
ILcdBounded. - The specified element implements
ILcdDataObject.
- Specified by:
canRemoveElementin interfaceILcdModel- Parameters:
aElement- the element to be verified.- Returns:
trueif the specified element can be removed from this model,falseotherwise.
- The specified element implements
-
removeElement
Description copied from interface:ILcdModelRemoves 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:
removeElementin interfaceILcdModel- Parameters:
aElement- the element to be removed from this model.aEventMode- the mode for sending out the model change event. This can beFIRE_LATERorNO_EVENT.- Throws:
IllegalArgumentException- See Also:
-
removeElements
Description copied from interface:ILcdModelRemoves 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:
removeElementsin 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_LATERorNO_EVENT.- See Also:
-
removeAllElements
public void removeAllElements(int aEventMode) Description copied from interface:ILcdModelRemoves 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:
removeAllElementsin interfaceILcdModel- Parameters:
aEventMode- the mode for sending out the model change event. This can beFIRE_LATERorNO_EVENT.
-
elementChanged
Description copied from interface:ILcdModelNotifies this model that the specified element has changed.- Specified by:
elementChangedin interfaceILcdModel- Parameters:
aObject- the element that has changed.aEventMode- the mode for sending out the model change event. This can beFIRE_LATERorNO_EVENT.
-
elementsChanged
Description copied from interface:ILcdModelNotifies this model that the elements in the specified vector have changed.- Specified by:
elementsChangedin interfaceILcdModel- Parameters:
aObjects- the vector of elements that have changed.aEventMode- the mode for sending out the model change event. This can beFIRE_LATERorNO_EVENT.
-
fireCollectedModelChanges
public void fireCollectedModelChanges()Description copied from interface:ILcdModelNotifies all listeners that are registered on this model of all the changes that have been collected between the previous notification and now.- Specified by:
fireCollectedModelChangesin interfaceILcdModel- See Also:
-
addModelListener
Description copied from interface: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
ILcdFireEventModethat 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
ALcdWeakModelListenerinstance as model listener.- Specified by:
addModelListenerin interfaceILcdModel- Parameters:
aModelListener- theILcdModelListenerto register on this model.- See Also:
-
removeModelListener
Description copied from interface:ILcdModelUnregisters the specified model listener so that it no longer receives notifications of model changes on this model.- Specified by:
removeModelListenerin interfaceILcdModel- Parameters:
aModelListener- theILcdModelListenerto remove.- See Also:
-
dispose
public void dispose()Description copied from interface:ILcdModelDisposes 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:
disposein interfaceILcdDisposable- Specified by:
disposein interfaceILcdModel
-
addIndex
public ILcdDataObjectIndexedModel.IndexId addIndex(List<String> aExpressions, boolean aIsUniqueIndex) Description copied from interface:ILcdDataObjectIndexedModelCreates 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:
addIndexin 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:ILcdDataObjectIndexedModelReturnstrueif an index can be created for the given list of expressions and uniqueness flag,falseotherwise. 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:
canAddIndexin 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:
trueif an index can be created for the given list of expressions and uniqueness flag,falseotherwise.
-
getDataObjectExpressionLanguage
Description copied from interface:ILcdDataObjectIndexedModelReturns the expression language used to evaluate expressions defined in the indices of the model.- Specified by:
getDataObjectExpressionLanguagein interfaceILcdDataObjectIndexedModel- Returns:
- the expression language used to evaluate expressions defined in the indices of the model.
-
getIndexedValues
Description copied from interface:ILcdDataObjectIndexedModelReturns the set of all unique expression value combinations which are present in the specified index.- Specified by:
getIndexedValuesin 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:ILcdDataObjectIndexedModelReturns the index id which corresponds to the given set of expressions, ornullif 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:
getIndexIdin 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
nullif no such index is available.
-
getIndexIds
Description copied from interface:ILcdDataObjectIndexedModelReturns 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:
getIndexIdsin interfaceILcdDataObjectIndexedModel- Returns:
- the set of all indices which are currently available on this model.
- See Also:
-
removeAllIndices
public void removeAllIndices()Description copied from interface:ILcdDataObjectIndexedModelRemoves all indices from this model.- Specified by:
removeAllIndicesin interfaceILcdDataObjectIndexedModel
-
removeIndex
Description copied from interface:ILcdDataObjectIndexedModelRemoves 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:
removeIndexin interfaceILcdDataObjectIndexedModel- Parameters:
aIndexId- the index to be removed.- Returns:
trueif the specified index was successfully removed from this model,falseotherwise.
-
retrieveAllByIndex
public Collection<ILcdDataObject> retrieveAllByIndex(ILcdDataObjectIndexedModel.IndexId aIndexId, List aExpressionValues) Description copied from interface:ILcdDataObjectIndexedModelReturns all model elements which match the given list of values for the expressions in the given index. The list of values inaExpressionValuesshould 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.aExpressionValuesmay containnullvalues. Anullvalue 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:
retrieveAllByIndexin 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:ILcdDataObjectIndexedModelReturns a single model element which matches the given list of values for the expressions in the given index, ornullif no such element exists in the model. The list of values inaExpressionValuesshould 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.aExpressionValuesmay containnullvalues. Anullvalue will be considered a match if the corresponding expression for the tested model element also evaluates tonull.- Specified by:
retrieveFirstByIndexin 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
nullif no such element exists in the model. - See Also:
-
setDataObjectExpressionLanguage
Description copied from interface:ILcdDataObjectIndexedModelSets 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:
setDataObjectExpressionLanguagein interfaceILcdDataObjectIndexedModel- Parameters:
aExpressionLanguage- the expression language used to evaluate expressions defined in the indices of the model.
-
elementAt
Description copied from interface:ILcdIntegerIndexedModelReturns the element at the specified index.- Specified by:
elementAtin interfaceILcdIntegerIndexedModel- Parameters:
aIndex- an index into thisILcdModel.- Returns:
- the element at the specified index.
-
indexOf
Description copied from interface:ILcdIntegerIndexedModelReturns 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 smallestifor whichthis.elementAt(i).equals(aElement).- Specified by:
indexOfin 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:ILcdIntegerIndexedModelReturns the number of elements in this model.- Specified by:
sizein 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:ILcd2DBoundsIndexedModelApplies 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:
applyOnInteract2DBoundsin 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
ILcdFunctionhas 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:ILcd2DBoundsInteractableApplies 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 returnsfalsefor an element it was applied on.- Specified by:
applyOnInteract2DBoundsin interfaceILcd2DBoundsIndexedModel- Specified by:
applyOnInteract2DBoundsin 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
ILcdFunctionhas been applied.
-
getBounds
Description copied from interface:ILcdBoundedReturns theILcdBoundsby which the geometry of thisILcdBoundedobject 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
undefinedbounds. You can create undefined bounds using the default constructors ofTLcdLonLatBoundsorTLcdXYBounds.- Specified by:
getBoundsin interfaceILcdBounded- Returns:
- the
ILcdBoundsby which the geometry of thisILcdBoundedobject is bounded.
-