public class TLcdDataObjectIndexedAnd2DBoundsIndexedModel extends Object implements ILcdDataObjectIndexedModel, ILcd2DBoundsIndexedModel, ILcdIntegerIndexedModel
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:
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.ILcdDataObjectIndexedModel.IndexId
ILcdModel.Query
FIRE_LATER, FIRE_NOW, NO_EVENT
Constructor and Description |
---|
TLcdDataObjectIndexedAnd2DBoundsIndexedModel()
Constructs a new
TLcdDataObjectIndexedAnd2DBoundsIndexedModel object. |
TLcdDataObjectIndexedAnd2DBoundsIndexedModel(ILcdBounds aBounds)
Constructs a new
TLcdDataObjectIndexedAnd2DBoundsIndexedModel object. |
Modifier and Type | Method and Description |
---|---|
void |
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.
|
ILcdDataObjectIndexedModel.IndexId |
addIndex(List<String> aExpressions,
boolean aIsUniqueIndex)
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)
Returns
true if the specified element can be added to this model, false
otherwise. |
boolean |
canAddIndex(List<String> aExpressions,
boolean aIsUniqueIndex)
Returns
true if an index can be created for the given list of expressions and
uniqueness flag, false otherwise. |
boolean |
canRemoveElement(Object aElement)
Returns
true if the specified element can be removed from this model, false
otherwise. |
void |
dispose()
Disposes of this model and allows it to release any system resources that it is holding.
|
Object |
elementAt(int aIndex)
Returns the element at the specified index.
|
void |
elementChanged(Object aObject,
int aEventMode)
Notifies this model that the specified element has changed.
|
Enumeration |
elements()
Returns an enumeration over all elements of this model.
|
void |
elementsChanged(Vector aObjects,
int aEventMode)
Notifies this model that the elements in the specified vector have changed.
|
void |
fireCollectedModelChanges()
Notifies all listeners that are registered on this model of all the changes that have been collected between the
previous notification and now.
|
ILcdBounds |
getBounds()
Returns the
ILcdBounds by which the geometry of this ILcdBounded object
is bounded. |
ALcdDataObjectExpressionLanguage |
getDataObjectExpressionLanguage()
Returns the expression language used to evaluate expressions defined in the indices of the
model.
|
Set<List<Object>> |
getIndexedValues(ILcdDataObjectIndexedModel.IndexId aIndex)
Returns the set of all unique expression value combinations which are present in the specified
index.
|
ILcdDataObjectIndexedModel.IndexId |
getIndexId(Set<String> aExpressions)
Returns the index id which corresponds to the given set of expressions, or
null
if no such index is available on this model. |
Set<ILcdDataObjectIndexedModel.IndexId> |
getIndexIds()
Returns the set of all indices which are currently available on this model.
|
ILcdModelDescriptor |
getModelDescriptor()
Returns the
ILcdModelDescriptor providing meta information about this model and
its elements. |
ILcdModelEncoder |
getModelEncoder()
Returns, if available, a model encoder that is capable of encoding this model,
(
encoder.canEncode(this) ), null otherwise. |
ILcdModelReference |
getModelReference()
Returns the
ILcdModelReference describing how the geometry of the elements contained in this
model should be interpreted. |
int |
indexOf(Object aObject)
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 |
removeAllIndices()
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 |
removeIndex(ILcdDataObjectIndexedModel.IndexId aIndexId)
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.
|
Collection<ILcdDataObject> |
retrieveAllByIndex(ILcdDataObjectIndexedModel.IndexId aIndexId,
List aExpressionValues)
Returns all model elements which match the given list of values for the expressions in the
given index.
|
ILcdDataObject |
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, or
null 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.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
query
all, filter, getModelMetadata
close
public TLcdDataObjectIndexedAnd2DBoundsIndexedModel()
TLcdDataObjectIndexedAnd2DBoundsIndexedModel
object. No initial
bounds is set.public TLcdDataObjectIndexedAnd2DBoundsIndexedModel(ILcdBounds aBounds)
TLcdDataObjectIndexedAnd2DBoundsIndexedModel
object. The initial
bounds is set to the
specified ILcdBounds
object.aBounds
- The initial bounds.public void setModelDescriptor(ILcdModelDescriptor aModelDescriptor)
ILcdDataModelDescriptor
for the indexing to work.aModelDescriptor
- A model descriptor for this model.IllegalArgumentException
- if the argument aModelDescriptor
does not implement
ILcdDataModelDescriptor
.public void setModelReference(ILcdModelReference aModelReference)
aModelReference
- the model reference for this model.public void setModelEncoder(ILcdModelEncoder aModelEncoder)
aModelEncoder
- a model encoder for this model.public ILcdModelDescriptor getModelDescriptor()
ILcdModel
ILcdModelDescriptor
providing meta information about this model and
its elements.getModelDescriptor
in interface ILcdModel
ILcdModelDescriptor
of this ILcdModel
. Should not be null
.public ILcdModelEncoder getModelEncoder()
ILcdModel
encoder.canEncode(this)
), null
otherwise.getModelEncoder
in interface ILcdModel
null
otherwise.public ILcdModelReference getModelReference()
ILcdModel
ILcdModelReference
describing how the geometry of the elements contained in this
model should be interpreted.getModelReference
in interface ILcdModel
ILcdModelReference
of this ILcdModel
.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 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:
ILcdBounded
.ILcdDataObject
.canAddElement
in interface ILcdDataObjectIndexedModel
canAddElement
in interface ILcdModel
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
ILcdModel
Models that support this operation may place limitations on what elements may be added to this model. For example,
implementations that are based on a spatial indexing structure will require that elements implement
ILcdBounded
.
When adding an element, the user should make sure that canAddElement(aElement)
holds, and that the
element's geometry is expressed in the same model reference as this model. It is generally undefined what happens
if an invalid element is added.
Implementations of this interface should clearly specify in their documentation any restrictions on what elements
may be added. Although it is unspecified what happens if the preconditions are not met, implementations are
encouraged to throw meaningful exceptions (for example, NullPointerException, IllegalArgumentException,
ClassCastException, UnsupportedOperationException
), whenever possible.
addElement
in interface ILcdModel
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)
ILcdModel
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.
addElements
in interface ILcdModel
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
.ILcdDataObject
.canRemoveElement
in interface ILcdModel
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
ILcdModel
Although it is unspecified what happens if the preconditions are not met, implementations are encouraged to
throw meaningful exceptions (for example, NullPointerException, IllegalArgumentException, ClassCastException,
UnsupportedOperationException
), whenever possible.
removeElement
in interface ILcdModel
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)
ILcdModel
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.
removeElements
in interface ILcdModel
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)
ILcdModel
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.
removeAllElements
in interface ILcdModel
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)
ILcdModel
elementChanged
in interface ILcdModel
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)
ILcdModel
elementsChanged
in interface ILcdModel
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()
ILcdModel
fireCollectedModelChanges
in interface ILcdModel
ILcdModelListener.modelChanged(TLcdModelChangedEvent)
public void addModelListener(ILcdModelListener aModelListener)
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.
addModelListener
in interface ILcdModel
aModelListener
- the ILcdModelListener
to register on this model.ILcdModel.removeModelListener(com.luciad.model.ILcdModelListener)
,
ILcdModelListener
public void removeModelListener(ILcdModelListener aModelListener)
ILcdModel
removeModelListener
in interface ILcdModel
aModelListener
- the ILcdModelListener
to remove.ILcdModel.addModelListener(com.luciad.model.ILcdModelListener)
,
ILcdModelListener
public void dispose()
ILcdModel
finalize
) on this model subsequent to a call to
this method is undefined.dispose
in interface ILcdModel
dispose
in interface ILcdDisposable
public ILcdDataObjectIndexedModel.IndexId addIndex(List<String> aExpressions, boolean aIsUniqueIndex)
ILcdDataObjectIndexedModel
addIndex
in interface ILcdDataObjectIndexedModel
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.public boolean canAddIndex(List<String> aExpressions, boolean aIsUniqueIndex)
ILcdDataObjectIndexedModel
true
if an index can be created for the given list of expressions and
uniqueness flag, false
otherwise.
An index can be created if:
canAddIndex
in interface ILcdDataObjectIndexedModel
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.true
if an index can be created for the given list of expressions and
uniqueness flag, false
otherwise.public ALcdDataObjectExpressionLanguage getDataObjectExpressionLanguage()
ILcdDataObjectIndexedModel
getDataObjectExpressionLanguage
in interface ILcdDataObjectIndexedModel
public Set<List<Object>> getIndexedValues(ILcdDataObjectIndexedModel.IndexId aIndex)
ILcdDataObjectIndexedModel
getIndexedValues
in interface ILcdDataObjectIndexedModel
aIndex
- the index for which to return the set of expression value combinations.public ILcdDataObjectIndexedModel.IndexId getIndexId(Set<String> aExpressions)
ILcdDataObjectIndexedModel
null
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 to ILcdDataObjectIndexedModel.retrieveAllByIndex(com.luciad.model.ILcdDataObjectIndexedModel.IndexId, java.util.List)
and ILcdDataObjectIndexedModel.retrieveFirstByIndex(com.luciad.model.ILcdDataObjectIndexedModel.IndexId,
java.util.List)
.getIndexId
in interface ILcdDataObjectIndexedModel
aExpressions
- the expressions for which an index id should be returned.null
if no
such index is available.public Set<ILcdDataObjectIndexedModel.IndexId> getIndexIds()
ILcdDataObjectIndexedModel
ILcdDataObjectIndexedModel.addIndex(java.util.List,
boolean)
.getIndexIds
in interface ILcdDataObjectIndexedModel
ILcdDataObjectIndexedModel.addIndex(java.util.List, boolean)
public void removeAllIndices()
ILcdDataObjectIndexedModel
removeAllIndices
in interface ILcdDataObjectIndexedModel
public boolean removeIndex(ILcdDataObjectIndexedModel.IndexId aIndexId)
ILcdDataObjectIndexedModel
removeIndex
in interface ILcdDataObjectIndexedModel
aIndexId
- the index to be removed.true
if the specified index was successfully removed from this model, false
otherwise.public Collection<ILcdDataObject> retrieveAllByIndex(ILcdDataObjectIndexedModel.IndexId aIndexId, List aExpressionValues)
ILcdDataObjectIndexedModel
aExpressionValues
should contain a value for each expression in
aIndexId.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 contain null
values. A null
value will be
considered a match if the corresponding expression for the tested model element also evaluates
to null
.
If no elements match the specified expression values, an empty collection is returned.retrieveAllByIndex
in interface ILcdDataObjectIndexedModel
aIndexId
- the index describing the expressions to test for.aExpressionValues
- the list of values to be compared with the list of evaluated
expressions.ILcdDataObjectIndexedModel.IndexId.isUnique()
public ILcdDataObject retrieveFirstByIndex(ILcdDataObjectIndexedModel.IndexId aIndexId, List aExpressionValues)
ILcdDataObjectIndexedModel
null
if no such element exists in the model.
The list of values in aExpressionValues
should contain a value for each expression in
aIndexId.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 contain null
values. A null
value will be
considered a match if the corresponding expression for the tested model element also evaluates
to null
.retrieveFirstByIndex
in interface ILcdDataObjectIndexedModel
aIndexId
- the index describing the expressions to test for.aExpressionValues
- the list of values to be compared with the list of evaluated
expressions.null
if no such element exists in the model.ILcdDataObjectIndexedModel.IndexId.isUnique()
public void setDataObjectExpressionLanguage(ALcdDataObjectExpressionLanguage aExpressionLanguage)
ILcdDataObjectIndexedModel
setDataObjectExpressionLanguage
in interface ILcdDataObjectIndexedModel
aExpressionLanguage
- the expression language used to evaluate expressions defined in the
indices of the 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.