Class TLcdFeatureIndexedAnd2DBoundsIndexedModel
- All Implemented Interfaces:
ILcd2DBoundsIndexedModel
,ILcd2DBoundsInteractable
,ILcdFeatureIndexedAnd2DBoundsIndexedModel
,ILcdFeatureIndexedModel
,ILcdIntegerIndexedModel
,ILcdModel
,ILcdBounded
,ILcdDisposable
,Serializable
,AutoCloseable
TLcdFeatureIndexedVectorModel
that additionally implements
com.luciad.model.ILcd2DBoundsIndexedModel
.
In addition to the constraints, imposed by TLcdFeatureIndexedVectorModel
, 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 features 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.
To retrieve the model elements by index, one should first call the addIndex(java.util.List, boolean)
method to put the right index on the model. If an index is no longer needed, it can be removed using removeIndex(java.util.List)
.
If the user intends to make use of indices (adding, removing, retrieving), he should make sure that:
- a
proper model descriptor is set on this model, implementing
ILcdFeaturedDescriptor
, - all elements contained in this model implement the
ILcdFeatured
interface.
- Since:
- 6.0
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.luciad.model.ILcdModel
ILcdModel.Query
-
Field Summary
Fields inherited from class com.luciad.model.ALcdModel
fModelEventSupport
Fields inherited from interface com.luciad.model.ILcdModel
FIRE_LATER, FIRE_NOW, NO_EVENT
-
Constructor Summary
ConstructorDescriptionDeprecated.Constructs a newTLcdFeatureIndexedAnd2DBoundsIndexedModel
object.Deprecated.Constructs a newTLcdFeatureIndexedAnd2DBoundsIndexedModel
object. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addElement
(Object aElement, int aEventMode) Deprecated.Adds the specified element to this model.void
addElements
(Vector aElements, int aFireEventMode) Deprecated.Adds all of the elements in the specified vector to this model.void
Deprecated.Creates an index based on a set of feature names.void
addModelListener
(ILcdModelListener aModelListener) Deprecated.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) Deprecated.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) Deprecated.Applies the specified function to all the elements of which the 2D bounds overlap with the specified bounds.boolean
canAddElement
(Object aElement) Deprecated.Returnstrue
if the specified element can be added to this model,false
otherwise.boolean
canAddIndex
(List aFeatureNames, boolean isUniqueIndex) Deprecated.Returns whether a useful index can be created for the given list of feature names.boolean
canRemoveElement
(Object aElement) Deprecated.Returnstrue
if the specified element can be removed from this model,false
otherwise.void
dispose()
Deprecated.Disposes of this model and allows it to release any system resources that it is holding.elementAt
(int aIndex) Deprecated.Returns the element at the specified index.void
elementChanged
(Object aObject, int aEventMode) Deprecated.Notifies this model that the specified element has changed.elements()
Deprecated.Returns an enumeration over all elements of this model.void
elementsChanged
(Vector aObjects, int aEventMode) Deprecated.Notifies this model that the elements in the specified vector have changed.void
Deprecated.Notifies all listeners that are registered on this model of all the changes that have been collected between the previous notification and now.Deprecated.Returns theILcdBounds
by which the geometry of thisILcdBounded
object is bounded.Deprecated.Returns theILcdModelDescriptor
providing meta information about this model and its elements.Deprecated.Returns, if available, a model encoder that is capable of encoding this model, (encoder.canEncode(this)
),null
otherwise.Deprecated.Returns theILcdModelReference
describing how the geometry of the elements contained in this model should be interpreted.boolean
Deprecated.int
Deprecated.Returns the index of the first occurrence of the specified element in the model, or -1 if this model does not contain the element.boolean
Deprecated.This method has been deprecated.void
removeAllElements
(int aEventMode) Deprecated.Removes all elements from this model.void
removeElement
(Object aElement, int aEventMode) Deprecated.Removes the specified element from this model.void
removeElements
(Vector aElements, int aFireEventMode) Deprecated.Removes all of the elements in the specified vector from this model.void
removeIndex
(List aFeatureNames) Deprecated.Removes an index from the model.void
removeModelListener
(ILcdModelListener aModelListener) Deprecated.Unregisters the specified model listener so that it no longer receives notifications of model changes on this model.retrieveByIndex
(List aFeatureNames, List aFeatureValues) Deprecated.Returns aVector
containing all the model elements that haveaFeatureValues
as value for the index defined byaFeatureNames
.retrieveByUniqueIndex
(List aFeatureNames, List aFeatureValues) Deprecated.Returns a single model element that has aFeatureValues as values for the index defined by aFeatureNames.void
setModelDescriptor
(ILcdModelDescriptor aModelDescriptor) Deprecated.Sets a model descriptor for this model.void
setModelEncoder
(ILcdModelEncoder aModelEncoder) Deprecated.Sets the model encoder for this model.void
setModelReference
(ILcdModelReference aModelReference) Deprecated.Sets the model reference for this model.void
setTraceOn
(boolean aTraceOn) Deprecated.This method has been deprecated.int
size()
Deprecated.Returns the number of elements in this model.Methods inherited from class com.luciad.model.ALcdModel
allElementsChanged, allElementsRemoved, elementAdded, elementRemoved, elementsAdded, elementsRemoved, getModelMetadata, initializeTransientValues, isClassTraceOn, setClassTraceOn, setModelDisposer, setModelMetadataFunction
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
-
TLcdFeatureIndexedAnd2DBoundsIndexedModel
public TLcdFeatureIndexedAnd2DBoundsIndexedModel()Deprecated.Constructs a newTLcdFeatureIndexedAnd2DBoundsIndexedModel
object. No initial bounds is set. -
TLcdFeatureIndexedAnd2DBoundsIndexedModel
Deprecated.Constructs a newTLcdFeatureIndexedAnd2DBoundsIndexedModel
object. The initial bounds is set to the specifiedILcdBounds
object.- Parameters:
aBounds
- The initial bounds.
-
-
Method Details
-
setModelDescriptor
Deprecated.Sets a model descriptor for this model. The model descriptor must implementILcdFeaturedDescriptor
for the indexing to work.- Overrides:
setModelDescriptor
in classALcdModel
- Parameters:
aModelDescriptor
- A model descriptor for this model.- Throws:
IllegalArgumentException
- if the argumentaModelDescriptor
does not implementILcdFeaturedDescriptor
.- See Also:
-
setModelReference
Deprecated.Sets the model reference for this model.- Overrides:
setModelReference
in classALcdModel
- Parameters:
aModelReference
- the model reference for this model.- See Also:
-
setModelEncoder
Deprecated.Sets the model encoder for this model.- Overrides:
setModelEncoder
in classALcdModel
- Parameters:
aModelEncoder
- a model encoder for this model.
-
getModelDescriptor
Deprecated.Description copied from class:ALcdModel
Returns theILcdModelDescriptor
providing meta information about this model and its elements.- Specified by:
getModelDescriptor
in interfaceILcdModel
- Overrides:
getModelDescriptor
in classALcdModel
- Returns:
- the
ILcdModelDescriptor
of thisILcdModel
. Should not benull
. - See Also:
-
getModelEncoder
Deprecated.Description copied from class:ALcdModel
Returns, if available, a model encoder that is capable of encoding this model, (encoder.canEncode(this)
),null
otherwise.- Specified by:
getModelEncoder
in interfaceILcdModel
- Overrides:
getModelEncoder
in classALcdModel
- Returns:
- a model encoder that is capable of encoding this model if available,
null
otherwise. - See Also:
-
getModelReference
Deprecated.Description copied from class:ALcdModel
Returns theILcdModelReference
describing how the geometry of the elements contained in this model should be interpreted.- Specified by:
getModelReference
in interfaceILcdModel
- Overrides:
getModelReference
in classALcdModel
- Returns:
- the
ILcdModelReference
of thisILcdModel
. - See Also:
-
elements
Deprecated.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
Deprecated.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 responsability 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
ILcdFeatured
.
- Specified by:
canAddElement
in interfaceILcdModel
- Overrides:
canAddElement
in classALcdModel
- 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
Deprecated.Description copied from class:ALcdModel
Adds the specified element to this model.Models that support this operation may place limitations on what elements may be added to this model. For example, implementations that are based on a spatial indexing structure will require that elements implement
ILcdBounded
.When adding an element, the user should make sure that
canAddElement(aElement)
holds, and that the element's geometry is expressed in the same model reference as this model. It is generally undefined what happens if an invalid element is added.Implementations of this interface should clearly specify in their documentation any restrictions on what elements may be added. Although it is unspecified what happens if the preconditions are not met, implementations are encouraged to throw meaningful exceptions (for example,
NullPointerException, IllegalArgumentException, ClassCastException, UnsupportedOperationException
), whenever possible.This implementation always throws an
UnsupportedOperationException
.- Specified by:
addElement
in interfaceILcdModel
- Overrides:
addElement
in classALcdModel
- 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
Deprecated.Description copied from class:ALcdModel
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.This implementation iterates over all elements in the specified vector, and calls
addElement(Object, int)
for each element to be added, using event modeNO_EVENT
if the specified event mode isNO_EVENT
,FIRE_LATER
otherwise. If the specified event mode isFIRE_NOW
,fireCollectedModelChanges()
is called afterwards.- Specified by:
addElements
in interfaceILcdModel
- Overrides:
addElements
in classALcdModel
- 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
Deprecated.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
ILcdFeatured
.
- Specified by:
canRemoveElement
in interfaceILcdModel
- Overrides:
canRemoveElement
in classALcdModel
- 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
Deprecated.Description copied from class:ALcdModel
Removes the specified element from this model. If the specified element is not contained in this model, this method has no effect.Although it is unspecified what happens if the preconditions are not met, implementations are encouraged to throw meaningful exceptions (for example,
NullPointerException, IllegalArgumentException, ClassCastException, UnsupportedOperationException
), whenever possible.This implementation always throws an
UnsupportedOperationException
.- Specified by:
removeElement
in interfaceILcdModel
- Overrides:
removeElement
in classALcdModel
- 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
Deprecated.Description copied from class:ALcdModel
Removes all of the elements in the specified vector from this model. If one of the elements in the specified vector is not contained in this model, this element will be ignored.The behavior of this operation is undefined if the specified vector is modified while the operation is in progress.
The specified elements will be removed from this model in the order they are specified in the vector. If an element cannot be removed, this method will return at the first failure. Succeeding elements won't be removed.
Although it is unspecified what happens if the preconditions are not met, implementations are encouraged to throw meaningful exceptions (for example,
NullPointerException, IllegalArgumentException, ClassCastException, UnsupportedOperationException
), whenever possible.This implementation iterates over all elements in the specified vector, and calls
removeElement(Object, int)
for each element to be removed, using event modeNO_EVENT
if the specified event mode isNO_EVENT
,FIRE_LATER
otherwise. If the specified event mode isFIRE_NOW
,fireCollectedModelChanges()
is called afterwards.- Specified by:
removeElements
in interfaceILcdModel
- Overrides:
removeElements
in classALcdModel
- 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) Deprecated.Description copied from class:ALcdModel
Removes all elements from this model.If an element cannot be removed, this method will return at the first failure. Succeeding elements won't be removed.
Although it is unspecified what happens if the preconditions are not met, implementations are encouraged to throw meaningful exceptions (for example,
NullPointerException, IllegalArgumentException, ClassCastException, UnsupportedOperationException
), whenever possible.This implementation iterates over all elements in the model, and calls
removeElement(Object, int)
for each element to be removed, using event modeNO_EVENT
if the specified event mode isNO_EVENT
,FIRE_LATER
otherwise. If the specified event mode isFIRE_NOW
,fireCollectedModelChanges()
is called afterwards.- Specified by:
removeAllElements
in interfaceILcdModel
- Overrides:
removeAllElements
in classALcdModel
- Parameters:
aEventMode
- the mode for sending out the model change event. This can beFIRE_LATER
orNO_EVENT
.
-
elementChanged
Deprecated.Description copied from class:ALcdModel
Notifies this model that the specified element has changed.This implementation calls
TLcdModelChangedEventSupport#elementChanged(Object, int)
.- Specified by:
elementChanged
in interfaceILcdModel
- Overrides:
elementChanged
in classALcdModel
- Parameters:
aObject
- the element that has changed.aEventMode
- the mode for sending out the model change event. This can beFIRE_LATER
orNO_EVENT
.
-
elementsChanged
Deprecated.Description copied from class:ALcdModel
Notifies this model that the elements in the specified vector have changed.This implementation calls
TLcdModelChangedEventSupport#elementsChanged(java.util.Vector, int)
.- Specified by:
elementsChanged
in interfaceILcdModel
- Overrides:
elementsChanged
in classALcdModel
- 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()Deprecated.Description copied from class:ALcdModel
Notifies all listeners that are registered on this model of all the changes that have been collected between the previous notification and now.This implementation calls
#TLcdModelChangedEventSupport#fireCollectedModelChanges()
.- Specified by:
fireCollectedModelChanges
in interfaceILcdModel
- Overrides:
fireCollectedModelChanges
in classALcdModel
- See Also:
-
addModelListener
Deprecated.Description copied from class:ALcdModel
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.This implementation calls
TLcdModelChangedEventSupport#addModelListener(ILcdModelListener)
.- Specified by:
addModelListener
in interfaceILcdModel
- Overrides:
addModelListener
in classALcdModel
- Parameters:
aModelListener
- theILcdModelListener
to register on this model.- See Also:
-
removeModelListener
Deprecated.Description copied from class:ALcdModel
Unregisters the specified model listener so that it no longer receives notifications of model changes on this model.This implementation calls
TLcdModelChangedEventSupport#removeModelListener(ILcdModelListener)
.- Specified by:
removeModelListener
in interfaceILcdModel
- Overrides:
removeModelListener
in classALcdModel
- Parameters:
aModelListener
- theILcdModelListener
to remove.- See Also:
-
dispose
public void dispose()Deprecated.Description copied from class:ALcdModel
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.When a model disposer has been provided it is called, otherwise this method does nothing. When overriding this method it is recommended to call
super.dispose()
. -
canAddIndex
Deprecated.Description copied from interface:ILcdFeatureIndexedModel
Returns whether a useful index can be created for the given list of feature names. Implementations should specify in their documentation which restrictions are placed on the indices they accept.- Specified by:
canAddIndex
in interfaceILcdFeatureIndexedModel
- Parameters:
aFeatureNames
- aList
of feature names defining the index to be validated.isUniqueIndex
- a boolean indicating whether the features used in this index form a unique key for the model elements.- Returns:
true
if a useful index can be created for the given list of feature names,false
otherwise.
-
addIndex
Deprecated.Description copied from interface:ILcdFeatureIndexedModel
Creates an index based on a set of feature names. All elements already contained in the model will be added to the new index; elements which are added after the index has been created, will be added automatically to all indices that have been created already. Note that each index consumes memory and it is advisable to keep the number of indices to a minimum. When an index is added that exists already (same names, same order), no new index is created.- Specified by:
addIndex
in interfaceILcdFeatureIndexedModel
- Parameters:
aFeatureNames
- theList
of feature names defining the index to be created.aUniqueIndex
- a boolean indicating whether the features used in this index form a unique key for the model elements (this means that for each element the set of feature values foraFeatureNames
is unique in the model). If a unique index is created on a non-unique feature, only one element per feature value is stored in the index.
-
hasIndex
Deprecated. -
removeIndex
Deprecated.Description copied from interface:ILcdFeatureIndexedModel
Removes an index from the model. If the specified index does not exist in this model, this method has no effect.- Specified by:
removeIndex
in interfaceILcdFeatureIndexedModel
- Parameters:
aFeatureNames
- aList
of feature names defining the index to be removed.
-
retrieveByIndex
Deprecated.Description copied from interface:ILcdFeatureIndexedModel
Returns aVector
containing all the model elements that haveaFeatureValues
as value for the index defined byaFeatureNames
. Can returnnull
if there is no match.- Specified by:
retrieveByIndex
in interfaceILcdFeatureIndexedModel
- Parameters:
aFeatureNames
- aList
of feature names defining the index to be used.aFeatureValues
- aList
of feature values that should match with the values of the elements to be retrieved.- Returns:
- a Vector with zero or more matching elements, or
null
if there is no match
-
retrieveByUniqueIndex
Deprecated.Description copied from interface:ILcdFeatureIndexedModel
Returns a single model element that has aFeatureValues as values for the index defined by aFeatureNames. This method should only be used for indices create withaUniqueIndex == true
.- Specified by:
retrieveByUniqueIndex
in interfaceILcdFeatureIndexedModel
- Parameters:
aFeatureNames
- aList
of feature names defining the index to be used.aFeatureValues
- aList
of feature values that should match with the values of the elements to be retrieved.- Returns:
- A single model element that has
aFeatureValues
as values for the index defined byaFeatureNames
, ornull
if no such element exist in this model.
-
elementAt
Deprecated.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
Deprecated.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()Deprecated.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) Deprecated.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) Deprecated.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
Deprecated.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.
-
isTraceOn
public boolean isTraceOn()Deprecated.This method has been deprecated. It is recommended to use the standard Java logging framework directly.Returnstrue
if tracing is enabled for this class. -
setTraceOn
public void setTraceOn(boolean aTraceOn) Deprecated.This method has been deprecated. It is recommended to use the standard Java logging framework directly.Enables tracing for this class instance. Calling this method with eithertrue
orfalse
as argument automatically turns off tracing for all other class instances for whichsetTraceOn
has not been called. If the argument isfalse
then only the informative, warning and error log messages are recorded.- Overrides:
setTraceOn
in classALcdModel
- Parameters:
aTraceOn
- if true then all log messages are recorded for this instance. If false, then only the informative, warning and error log messages are recorded.
-
ILcdFeatured
interface has been deprecated in favor ofILcdDataObject
andTLcdDataModel
.