ILcdFeatured
interface has been deprecated in favor of ILcdDataObject
and TLcdDataModel
.@Deprecated public class TLcdFeatureIndexedVectorModel extends Object implementsILcdFeatureIndexedModel, ILcdIntegerIndexedModel
ILcdFeatureIndexedModel
that also implements ILcdIntegerIndexedModel
.
This class maintains one or more feature-based indices internally, allowing fast access to its elements based on one
or more feature values. All elements contained in this model should therefore implement
ILcdFeatured
. Users should notify this model whenever a feature of an element in the model
has changed, to allow the model to update its indices.
This can be done by means of the elementChanged(Object, int)
method.
All elements are additionally stored in a linear index, allowing fast integer- based queries.
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, and the
feature values in the elements correspond to the feature names defined in the model descriptor.ILcdModel.Query
FIRE_LATER, FIRE_NOW, NO_EVENT
Constructor and Description |
---|
TLcdFeatureIndexedVectorModel()
Deprecated.
Constructs a new, empty
TLcdFeatureIndexedVectorModel . |
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.
|
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.
Checks whether a useful index can be created for the specified set 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.
|
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.
Checks whether the given list of feature names is already added as index to this model.
|
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
TLcdFeatureIndexedVectorModel . |
void |
setModelEncoder(ILcdModelEncoder aModelEncoder)
Deprecated.
Sets the model encoder for this
TLcdFeatureIndexedVectorModel . |
void |
setModelReference(ILcdModelReference aModelReference)
Deprecated.
Sets the model reference for this
TLcdFeatureIndexedVectorModel . |
static 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.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
all, filter, getModelMetadata, query
close
public TLcdFeatureIndexedVectorModel()
TLcdFeatureIndexedVectorModel
.public int size()
ILcdIntegerIndexedModel
size
in interface ILcdIntegerIndexedModel
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 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 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 Enumeration elements()
ILcdModel
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 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 specified element implements ILcdFeatured
.
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 addElements(Vector aElements, int aFireEventMode)
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
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 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 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 specified element implements ILcdFeatured
.
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 removeElements(Vector aElements, int aFireEventMode)
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
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 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 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 boolean canAddIndex(List aFeatureNames, boolean isUniqueIndex)
canAddIndex
in interface ILcdFeatureIndexedModel
aFeatureNames
- the list of feature names to be checked.isUniqueIndex
- flag indicating whether the index should be unique or not.true
if a useful index can be created for the given list of feature names, false
otherwise.NullPointerException
- if aFeatureNames
or one of its elements is null
.public void setModelDescriptor(ILcdModelDescriptor aModelDescriptor)
TLcdFeatureIndexedVectorModel
. The model descriptor
must implement ILcdFeaturedDescriptor
for the indexing to work.aModelDescriptor
- A model descriptor for this TLcdFeatureIndexedVectorModel
.IllegalArgumentException
- if the argument aModelDescriptor
does not implement
ILcdFeaturedDescriptor
.public void setModelReference(ILcdModelReference aModelReference)
TLcdFeatureIndexedVectorModel
.aModelReference
- the model reference for this TLcdFeatureIndexedVectorModel
.public void setModelEncoder(ILcdModelEncoder aModelEncoder)
TLcdFeatureIndexedVectorModel
.aModelEncoder
- a model encoder for this TLcdFeatureIndexedVectorModel
.public boolean hasIndex(List aFeatureNames, boolean aUniqueIndex)
aFeatureNames
- A List
of strings denoting the feature namesaUniqueIndex
- A boolean indicating whether the features used in this index
form a unique key for the model objects (this means that for
each object the set of feature values for aFeatureNames is
unique in the model).NullPointerException
- if aFeatureNames
or one of its elements is null
.public boolean isTraceOn()
true
if tracing is enabled for this class.public static 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.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.