ILcdFeatured
interface has been deprecated in favor of ILcdDataObject
and TLcdDataModel
.@Deprecated public class TLcdFeatureIndexedAnd2DBoundsIndexedModel extends ALcdModel implementsILcdFeatureIndexedAnd2DBoundsIndexedModel, ILcdIntegerIndexedModel
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:
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:
ILcdFeaturedDescriptor
,ILcdFeatured
interface.ILcdModel.Query
fModelEventSupport
FIRE_LATER, FIRE_NOW, NO_EVENT
Constructor and Description |
---|
TLcdFeatureIndexedAnd2DBoundsIndexedModel()
Deprecated.
Constructs a new
TLcdFeatureIndexedAnd2DBoundsIndexedModel object. |
TLcdFeatureIndexedAnd2DBoundsIndexedModel(ILcdBounds aBounds)
Deprecated.
Constructs a new
TLcdFeatureIndexedAnd2DBoundsIndexedModel object. |
Modifier and Type | Method and Description |
---|---|
void |
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 |
addIndex(List aFeatureNames,
boolean aUniqueIndex)
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.
Returns
true 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.
Returns
true 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.
|
Object |
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.
|
Enumeration |
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 |
fireCollectedModelChanges()
Deprecated.
Notifies all listeners that are registered on this model of all the changes that have been collected between the
previous notification and now.
|
ILcdBounds |
getBounds()
Deprecated.
Returns the
ILcdBounds by which the geometry of this ILcdBounded object
is bounded. |
ILcdModelDescriptor |
getModelDescriptor()
Deprecated.
Returns the
ILcdModelDescriptor providing meta information about this model and
its elements. |
ILcdModelEncoder |
getModelEncoder()
Deprecated.
Returns, if available, a model encoder that is capable of encoding this model,
(
encoder.canEncode(this) ), null otherwise. |
ILcdModelReference |
getModelReference()
Deprecated.
Returns the
ILcdModelReference describing how the geometry of the elements contained in this
model should be interpreted. |
boolean |
hasIndex(List aFeatureNames,
boolean aUniqueIndex)
Deprecated.
|
int |
indexOf(Object aObject)
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 |
isTraceOn()
Deprecated.
This method has been deprecated. It is recommended to use the
standard Java logging framework directly.
|
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.
|
Vector |
retrieveByIndex(List aFeatureNames,
List aFeatureValues)
Deprecated.
Returns a
Vector containing all the model elements that have aFeatureValues as value
for the index defined by aFeatureNames . |
Object |
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. It is recommended to use the
standard Java logging framework directly.
|
int |
size()
Deprecated.
Returns the number of elements in this model.
|
allElementsChanged, allElementsRemoved, elementAdded, elementRemoved, elementsAdded, elementsRemoved, getModelMetadata, initializeTransientValues, isClassTraceOn, setClassTraceOn, setModelDisposer, setModelMetadataFunction
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
query
all, filter, getModelMetadata
close
public TLcdFeatureIndexedAnd2DBoundsIndexedModel()
TLcdFeatureIndexedAnd2DBoundsIndexedModel
object. No initial bounds is set.public TLcdFeatureIndexedAnd2DBoundsIndexedModel(ILcdBounds aBounds)
TLcdFeatureIndexedAnd2DBoundsIndexedModel
object. The initial bounds is set to the
specified ILcdBounds
object.aBounds
- The initial bounds.public void setModelDescriptor(ILcdModelDescriptor aModelDescriptor)
ILcdFeaturedDescriptor
for the indexing to work.setModelDescriptor
in class ALcdModel
aModelDescriptor
- A model descriptor for this model.IllegalArgumentException
- if the argument aModelDescriptor
does not implement ILcdFeaturedDescriptor
.ALcdModel.getModelDescriptor()
public void setModelReference(ILcdModelReference aModelReference)
setModelReference
in class ALcdModel
aModelReference
- the model reference for this model.ALcdModel.getModelReference()
public void setModelEncoder(ILcdModelEncoder aModelEncoder)
setModelEncoder
in class ALcdModel
aModelEncoder
- a model encoder for this model.public ILcdModelDescriptor getModelDescriptor()
ALcdModel
ILcdModelDescriptor
providing meta information about this model and
its elements.getModelDescriptor
in interface ILcdModel
getModelDescriptor
in class ALcdModel
ILcdModelDescriptor
of this ILcdModel
. Should not be null
.ALcdModel.setModelDescriptor(ILcdModelDescriptor)
public ILcdModelEncoder getModelEncoder()
ALcdModel
encoder.canEncode(this)
), null
otherwise.getModelEncoder
in interface ILcdModel
getModelEncoder
in class ALcdModel
null
otherwise.ALcdModel.setModelEncoder(ILcdModelEncoder)
public ILcdModelReference getModelReference()
ALcdModel
ILcdModelReference
describing how the geometry of the elements contained in this
model should be interpreted.getModelReference
in interface ILcdModel
getModelReference
in class ALcdModel
ILcdModelReference
of this ILcdModel
.ALcdModel.setModelReference(ILcdModelReference)
public Enumeration elements()
ILcdModel
public boolean canAddElement(Object aElement)
true
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:
ILcdBounded
.ILcdFeatured
.canAddElement
in interface ILcdModel
canAddElement
in class ALcdModel
aElement
- the element to be verified.true
if the specified element can be added to this model, false
otherwise.public void addElement(Object aElement, int aEventMode) throws IllegalArgumentException
ALcdModel
Models that support this operation may place limitations on what elements may be added to this model. For example,
implementations that are based on a spatial indexing structure will require that elements implement
ILcdBounded
.
When adding an element, the user should make sure that canAddElement(aElement)
holds, and that the
element's geometry is expressed in the same model reference as this model. It is generally undefined what happens
if an invalid element is added.
Implementations of this interface should clearly specify in their documentation any restrictions on what elements
may be added. Although it is unspecified what happens if the preconditions are not met, implementations are
encouraged to throw meaningful exceptions (for example, NullPointerException, IllegalArgumentException,
ClassCastException, UnsupportedOperationException
), whenever possible.
This implementation always throws an UnsupportedOperationException
.
addElement
in interface ILcdModel
addElement
in class ALcdModel
aElement
- the element to be added to this model.aEventMode
- the mode for sending out the model change event. This can be FIRE_LATER
or NO_EVENT
.IllegalArgumentException
ILcdModel.canAddElement(Object)
public void addElements(Vector aElements, int aFireEventMode)
ALcdModel
ILcdBounded
. 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 mode NO_EVENT
if the
specified event mode is NO_EVENT
, FIRE_LATER
otherwise.
If the specified event mode is FIRE_NOW
, fireCollectedModelChanges()
is called afterwards.
addElements
in interface ILcdModel
addElements
in class ALcdModel
aElements
- the vector of elements to be added to this model.aFireEventMode
- the mode for sending the model change events This can be FIRE_LATER
or NO_EVENT
.ILcdModel.canAddElement(Object)
public boolean canRemoveElement(Object aElement)
true
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:
ILcdBounded
.ILcdFeatured
.canRemoveElement
in interface ILcdModel
canRemoveElement
in class ALcdModel
aElement
- the element to be verified.true
if the specified element can be removed from this model, false
otherwise.public void removeElement(Object aElement, int aEventMode) throws IllegalArgumentException
ALcdModel
Although it is unspecified what happens if the preconditions are not met, implementations are encouraged to
throw meaningful exceptions (for example, NullPointerException, IllegalArgumentException, ClassCastException,
UnsupportedOperationException
), whenever possible.
This implementation always throws an UnsupportedOperationException
.
removeElement
in interface ILcdModel
removeElement
in class ALcdModel
aElement
- the element to be removed from this model.aEventMode
- the mode for sending out the model change event. This can be FIRE_LATER
or NO_EVENT
.IllegalArgumentException
ILcdModel.canRemoveElement(Object)
public void removeElements(Vector aElements, int aFireEventMode)
ALcdModel
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 mode NO_EVENT
if the
specified event mode is NO_EVENT
, FIRE_LATER
otherwise.
If the specified event mode is FIRE_NOW
, fireCollectedModelChanges()
is called afterwards.
removeElements
in interface ILcdModel
removeElements
in class ALcdModel
aElements
- the vector of elements to be removed from this model.aFireEventMode
- the mode for sending out the model change event. This can be FIRE_LATER
or NO_EVENT
.ILcdModel.canRemoveElement(Object)
public void removeAllElements(int aEventMode)
ALcdModel
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 mode NO_EVENT
if the
specified event mode is NO_EVENT
, FIRE_LATER
otherwise.
If the specified event mode is FIRE_NOW
, fireCollectedModelChanges()
is called afterwards.
removeAllElements
in interface ILcdModel
removeAllElements
in class ALcdModel
aEventMode
- the mode for sending out the model change event. This can be FIRE_LATER
or NO_EVENT
.public void elementChanged(Object aObject, int aEventMode)
ALcdModel
This implementation calls TLcdModelChangedEventSupport#elementChanged(Object, int)
.
elementChanged
in interface ILcdModel
elementChanged
in class ALcdModel
aObject
- the element that has changed.aEventMode
- the mode for sending out the model change event. This can be FIRE_LATER
or NO_EVENT
.public void elementsChanged(Vector aObjects, int aEventMode)
ALcdModel
This implementation calls TLcdModelChangedEventSupport#elementsChanged(java.util.Vector, int)
.
elementsChanged
in interface ILcdModel
elementsChanged
in class ALcdModel
aObjects
- the vector of elements that have changed.aEventMode
- the mode for sending out the model change event. This can be FIRE_LATER
or NO_EVENT
.public void fireCollectedModelChanges()
ALcdModel
This implementation calls #TLcdModelChangedEventSupport#fireCollectedModelChanges()
.
fireCollectedModelChanges
in interface ILcdModel
fireCollectedModelChanges
in class ALcdModel
ILcdModelListener.modelChanged(TLcdModelChangedEvent)
public void addModelListener(ILcdModelListener aModelListener)
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)
.
addModelListener
in interface ILcdModel
addModelListener
in class ALcdModel
aModelListener
- the ILcdModelListener
to register on this model.ILcdModel.removeModelListener(com.luciad.model.ILcdModelListener)
,
ILcdModelListener
public void removeModelListener(ILcdModelListener aModelListener)
ALcdModel
This implementation calls TLcdModelChangedEventSupport#removeModelListener(ILcdModelListener)
.
removeModelListener
in interface ILcdModel
removeModelListener
in class ALcdModel
aModelListener
- the ILcdModelListener
to remove.ILcdModel.addModelListener(com.luciad.model.ILcdModelListener)
,
ILcdModelListener
public void dispose()
ALcdModel
finalize
) 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()
.
dispose
in interface ILcdModel
dispose
in interface ILcdDisposable
dispose
in class ALcdModel
ALcdModel.setModelDisposer(Consumer)
public boolean canAddIndex(List aFeatureNames, boolean isUniqueIndex)
ILcdFeatureIndexedModel
canAddIndex
in interface ILcdFeatureIndexedModel
aFeatureNames
- a List
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.true
if a useful index can be created for the given list of feature names, false
otherwise.public void addIndex(List aFeatureNames, boolean aUniqueIndex)
ILcdFeatureIndexedModel
addIndex
in interface ILcdFeatureIndexedModel
aFeatureNames
- the List
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 for aFeatureNames
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.public boolean hasIndex(List aFeatureNames, boolean aUniqueIndex)
public void removeIndex(List aFeatureNames)
ILcdFeatureIndexedModel
removeIndex
in interface ILcdFeatureIndexedModel
aFeatureNames
- a List
of feature names defining the index to be removed.public Vector retrieveByIndex(List aFeatureNames, List aFeatureValues)
ILcdFeatureIndexedModel
Vector
containing all the model elements that have aFeatureValues
as value
for the index defined by aFeatureNames
.
Can return null
if there is no match.retrieveByIndex
in interface ILcdFeatureIndexedModel
aFeatureNames
- a List
of feature names defining the index to be used.aFeatureValues
- a List
of feature values that should match with the values of the elements to be
retrieved.null
if there is no matchpublic Object retrieveByUniqueIndex(List aFeatureNames, List aFeatureValues)
ILcdFeatureIndexedModel
aUniqueIndex == true
.retrieveByUniqueIndex
in interface ILcdFeatureIndexedModel
aFeatureNames
- a List
of feature names defining the index to be used.aFeatureValues
- a List
of feature values that should match with the values of the elements to be
retrieved.aFeatureValues
as values for the index defined by
aFeatureNames
, or null
if no such element exist in this model.public Object elementAt(int aIndex)
ILcdIntegerIndexedModel
elementAt
in interface ILcdIntegerIndexedModel
aIndex
- an index into this ILcdModel
.public int indexOf(Object aObject)
ILcdIntegerIndexedModel
i
for which this.elementAt(i).equals(aElement)
.indexOf
in interface ILcdIntegerIndexedModel
aObject
- the element to search for.public int size()
ILcdIntegerIndexedModel
size
in interface ILcdIntegerIndexedModel
public int applyOnInteract2DBounds(ILcdBounds aBounds, boolean aStrictOverlap, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY)
ILcd2DBoundsIndexedModel
false
.applyOnInteract2DBounds
in interface ILcd2DBoundsIndexedModel
aBounds
- the rectangle to test overlap with.aStrictOverlap
- if false
, the spatial search may return more elements than the ones strictly
overlapping; if true
, the search only returns the elements that are
overlapping. The latter mode is more precise, but it may be slower.aFunctionToApply
- the function to apply on each element that overlaps with the given bounds.
The return value of the specified function is used as a stop criterion: the spatial query is interrupted
if the function returns false
.aPrecisionX
- the precision required in the x dimension, expressed in model units.
For example, for a cartesian grid system expressed in meters, the values
should be expressed in meters as well, for a geodetic coordinate system the accuracy
values should be expressed in degrees.
The precision is useful in combination with multi-leveled data (multiple representations of the same object, but with varying accuracy), so that the most appropriate accuracy level can be used. 0 means best possible accuracy, but it might trigger lazy-loaded implementations to load lots of data.
aPrecisionY
- the precision required in the y dimension, expressed in model units.ILcdFunction
has been applied.public int applyOnInteract2DBounds(ILcdBounds aBounds, boolean aStrictOverlap, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY, double aMinSizeX, double aMinSizeY, boolean aIncludePoints)
ILcd2DBoundsInteractable
false
for an element it was applied on.applyOnInteract2DBounds
in interface ILcd2DBoundsIndexedModel
applyOnInteract2DBounds
in interface ILcd2DBoundsInteractable
aBounds
- the rectangle to test overlap with.aStrictOverlap
- if false
, the spatial search may return more elements than the ones strictly
overlapping; if true
, the search only returns the elements that are
overlapping. The latter mode is more precise, but it may be slower.aFunctionToApply
- the function to apply on each element that overlaps with the given bounds.aPrecisionX
- the precision required in the x dimension, expressed in model units.
For example, for a cartesian grid system expressed in meters, the values
should be expressed in meters as well, for a geodetic coordinate system the accuracy
values should be expressed in degrees.
The precision is useful in combination with multi-leveled data (multiple representations of the same object, but with varying accuracy), so that the most appropriate accuracy level can be used. 0 means best possible accuracy, but it might trigger lazy-loaded implementations to load lots of data.
aPrecisionY
- the precision required in the y dimension, expressed in model units.aMinSizeX
- the minimal element size in the x dimension (as in
ILcdBounds.getWidth()
), expressed in model units.
Elements that are smaller than this size will be skipped. This may, for example, be
useful when improving the efficiency of painting elements by skipping elements
that are smaller than some threshold (e.g. one pixel, converted to model units).aMinSizeY
- the minimal element size in the y dimension (as in
ILcdBounds.getHeight()
), expressed in model units.aIncludePoints
- if true
, zero-sized elements (points) are considered as well, even though they
might be smaller than the minimum size.ILcdFunction
has been applied.public ILcdBounds getBounds()
ILcdBounded
ILcdBounds
by which the geometry of this ILcdBounded
object
is bounded.
If the geometry does not allow retrieving valid bounds (for example a polyline with 0 points)
the return value is unspecified.
It is highly recommended to return an undefined
bounds.
You can create undefined bounds using the default constructors
of TLcdLonLatBounds
or TLcdXYBounds
.
getBounds
in interface ILcdBounded
ILcdBounds
by which the geometry of this ILcdBounded
object
is bounded.public boolean isTraceOn()
true
if tracing is enabled for this class.public void setTraceOn(boolean aTraceOn)
true
or false
as argument automatically turns
off tracing for all other class instances for which
setTraceOn
has not been called.
If the argument is false
then only the informative, warning
and error log messages are recorded.setTraceOn
in class ALcdModel
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.