public class TLcdAIXM51AbstractAIXMMessage extends TLcdAIXM51AbstractAIXMMessageBase implements ILcd2DBoundsIndexedModel, ILcdIntegerIndexedModel, ILcdDataObjectIndexedModel, ILcdLockDependent
AbstractAIXMMessageType
schema type in the AIXM 5.1 XML Schema.
A message consists of one or more features, which represent real-world
aeronautical objects like an airport, navaid, airspace, etc.
Features are modeled by the class TLcdAIXM51AbstractAIXMFeature
.
The elements referred to by the methods of this class are always of the type
TLcdAIXM51AbstractAIXMFeature
.
TLcdAIXM51AbstractAIXMFeature
,
Serialized FormILcdDataObjectIndexedModel.IndexId
ILcdModel.Query
Modifier and Type | Field and Description |
---|---|
static TLcdDataProperty |
AGGREGATION_TYPE_PROPERTY
Data property that maps to the
aggregationType attribute. |
static TLcdDataProperty |
BOUNDED_BY_PROPERTY
Data property that maps to the
boundedBy element. |
static TLcdDataProperty |
LOCATION_PROPERTY
Data property that maps to the
location element. |
MESSAGE_METADATA_PROPERTY, SEQUENCE_NUMBER_PROPERTY
DATA_SOURCE_PROPERTY, DATA_SOURCE_REFERENCE_PROPERTY, HISTORY_PROPERTY, VALID_TIME_PROPERTY
DESCRIPTION_PROPERTY, DESCRIPTION_REFERENCE_PROPERTY, ID_PROPERTY, IDENTIFIER_PROPERTY, META_DATA_PROPERTY_PROPERTY, NAME_PROPERTY
FIRE_LATER, FIRE_NOW, NO_EVENT
Constructor and Description |
---|
TLcdAIXM51AbstractAIXMMessage(TLcdDataType aType)
Constructs a new
TLcdAIXM51AbstractAIXMMessage for the given
type. |
Modifier and Type | Method and Description |
---|---|
void |
addElement(Object aElement,
int aEventMode)
Adds the specified element to this model.
|
void |
addElements(Vector aElements,
int aEventMode)
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)
Adds an
ILcdModelListener to the event listeners of this model. |
void |
allElementsChanged(int aFireEventMode)
Sends a
TLcdModelChangedEvent to the listeners that all elements in this model
have changed. |
protected void |
allElementsRemoved(int aFireEventMode)
Sends a
TLcdModelChangedEvent to the listeners. |
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. |
TLcdAIXM51AbstractAIXMMessage |
clone()
Returns a deep clone of this object.
|
TLcdDataObject |
clone(Map aObjectDictionary)
Returns a deep clone of this object.
|
void |
dispose()
Disposes of this model and allows it to release any system resources that it is holding.
|
protected void |
elementAdded(Object aObject,
int aFireEventMode)
Sends a
TLcdModelChangedEvent to the listeners. |
Object |
elementAt(int i)
Returns the element at the specified index.
|
void |
elementChanged(Object aObject,
int aFireEventMode)
Sends a
TLcdModelChangedEvent to the listeners. |
protected void |
elementRemoved(Object aObject,
int aFireEventMode)
Sends a
TLcdModelChangedEvent to the listeners. |
Enumeration |
elements()
Returns an enumeration over all elements of this model.
|
protected void |
elementsAdded(Vector aObjects,
int aFireEventMode)
Sends a
TLcdModelChangedEvent to the listeners. |
void |
elementsChanged(Vector aObjects,
int aFireEventMode)
Sends a
TLcdModelChangedEvent to the listeners. |
protected void |
elementsRemoved(Vector aObjects,
int aFireEventMode)
Sends a
TLcdModelChangedEvent to the listeners. |
void |
fireCollectedModelChanges()
Fires a
TLcdModelChangedEvent that contains all the collected selection changes. |
ELcdGML32Aggregation |
getAggregationType()
Returns the value of the property that maps to the
aggregationType attribute. |
TLcdGML32BoundingShape |
getBoundedBy()
Returns the value of the property that maps to the
boundedBy element. |
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.
|
List<Object> |
getDependentObjects()
Returns the objects that must be locked along with this object.
|
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.
|
Object |
getLocation()
Returns the value of the property that maps to the
location element. |
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. |
TLcdModelMetadata |
getModelMetadata()
Collects and returns metadata about the model.
|
ILcdModelReference |
getModelReference()
Returns the
ILcdModelReference describing how the geometry of the elements contained in this
model should be interpreted. |
int |
indexOf(Object o)
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 aEventMode)
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)
Removes an
ILcdModelListener from the model event listeners of 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 |
setAggregationType(ELcdGML32Aggregation aValue)
Sets the value of the property that maps to the
aggregationType attribute. |
void |
setBoundedBy(TLcdGML32BoundingShape aValue)
Sets the value of the property that maps to the
boundedBy element. |
void |
setDataObjectExpressionLanguage(ALcdDataObjectExpressionLanguage aExpressionLanguage)
Sets the expression language to be used for evaluating expressions defined in the indices of
the model.
|
void |
setLocation(Object aValue)
Sets the value of the property that maps to the
location element. |
void |
setModelDescriptor(TLcdAIXM51ModelDescriptor aModelDescriptor)
Sets the model descriptor for this model.
|
void |
setModelReference(ILcdModelReference aModelReference)
Sets the model reference associated with the elements of this class.
|
int |
size()
Returns the number of elements in this model.
|
getMessageMetadata, getSequenceNumber, setMessageMetadata, setSequenceNumber
getDataSource, getDataSourceReference, getHistory, getValidTime, setDataSource, setDataSourceReference, setHistory, setValidTime
collectShapes, contains2D, contains2D, contains3D, contains3D, getFocusPoint, getShape, getShapeCount, invalidateObject, shapesChanged
getDescription, getDescriptionReference, getId, getIdentifier, getMetaDataProperty, getName, setDescription, setDescriptionReference, setId, setIdentifier
getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue, toString
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
query
close
public static final TLcdDataProperty AGGREGATION_TYPE_PROPERTY
aggregationType
attribute.
The possible values for this property are instances of ELcdGML32Aggregation
.public static final TLcdDataProperty BOUNDED_BY_PROPERTY
boundedBy
element.
The possible values for this property are instances of TLcdGML32BoundingShape
.public static final TLcdDataProperty LOCATION_PROPERTY
location
element.
The possible values for this property are instances of TLcdGML32LocationProperty
.public TLcdAIXM51AbstractAIXMMessage(TLcdDataType aType)
TLcdAIXM51AbstractAIXMMessage
for the given
type. The type must be a subtype of AbstractAIXMMessageType
.
The model reference (or srsName) will be set to the default one for AIXM 5,
which is: "urn:ogc:def:crs:EPSG::4326"aType
- the message type for which to create a new instancepublic void fireCollectedModelChanges()
TLcdModelChangedEvent
that contains all the collected selection changes.fireCollectedModelChanges
in interface ILcdModel
ILcdModelListener.modelChanged(TLcdModelChangedEvent)
public void elementsChanged(Vector aObjects, int aFireEventMode)
TLcdModelChangedEvent
to the listeners.elementsChanged
in interface ILcdModel
aObjects
- the vector of elements that have changed.aFireEventMode
- the mode for sending out the model change event. This can be FIRE_LATER
or NO_EVENT
.public void allElementsChanged(int aFireEventMode)
TLcdModelChangedEvent
to the listeners that all elements in this model
have changed.aFireEventMode
- the mode for sending out the model event. This can be
ILcdFireEventMode.FIRE_NOW, ILcdFireEventMode.LATER or
ILcdFireEventMode.NO_EVENT.ILcdFireEventMode
public void elementChanged(Object aObject, int aFireEventMode)
TLcdModelChangedEvent
to the listeners.elementChanged
in interface ILcdModel
aObject
- the element that has changed.aFireEventMode
- the mode for sending out the model change event. This can be FIRE_LATER
or NO_EVENT
.protected void elementsAdded(Vector aObjects, int aFireEventMode)
TLcdModelChangedEvent
to the listeners.aObjects
- the Vector
of Objects that has been added to the model.aFireEventMode
- the mode for sending out the model event. This can be
ILcdFireEventMode.FIRE_NOW, ILcdFireEventMode.LATER or
ILcdFireEventMode.NO_EVENT.ILcdFireEventMode
protected void elementAdded(Object aObject, int aFireEventMode)
TLcdModelChangedEvent
to the listeners.aObject
- the Object
that has been added to the model.aFireEventMode
- the mode for sending out the model event. This can be
ILcdFireEventMode.FIRE_NOW, ILcdFireEventMode.LATER or
ILcdFireEventMode.NO_EVENT.ILcdFireEventMode
protected void elementsRemoved(Vector aObjects, int aFireEventMode)
TLcdModelChangedEvent
to the listeners.aObjects
- the Vector
of Objects that has been removed from the model.aFireEventMode
- the mode for sending out the model event. This can be
ILcdFireEventMode.FIRE_NOW, ILcdFireEventMode.LATER or
ILcdFireEventMode.NO_EVENT.ILcdFireEventMode
protected void elementRemoved(Object aObject, int aFireEventMode)
TLcdModelChangedEvent
to the listeners.aObject
- the Object
that has been removed from the model.aFireEventMode
- the mode for sending out the model event. This can be
ILcdFireEventMode.FIRE_NOW, ILcdFireEventMode.LATER or
ILcdFireEventMode.NO_EVENT.ILcdFireEventMode
protected void allElementsRemoved(int aFireEventMode)
TLcdModelChangedEvent
to the listeners.aFireEventMode
- the mode for sending out the model event. This can be
ILcdFireEventMode.FIRE_NOW, ILcdFireEventMode.LATER or
ILcdFireEventMode.NO_EVENT.ILcdFireEventMode
public void addModelListener(ILcdModelListener aModelListener)
ILcdModelListener
to the event listeners of this model.addModelListener
in interface ILcdModel
aModelListener
- the ILcdModelListener
to add.removeModelListener(com.luciad.model.ILcdModelListener)
public void removeModelListener(ILcdModelListener aModelListener)
ILcdModelListener
from the model event listeners of this model.removeModelListener
in interface ILcdModel
aModelListener
- the ILcdModelListener
to remove.addModelListener(com.luciad.model.ILcdModelListener)
public void setModelReference(ILcdModelReference aModelReference)
aModelReference
- A ILcdModelReference which is valid for all of the elements in this class.public void setModelDescriptor(TLcdAIXM51ModelDescriptor aModelDescriptor)
aModelDescriptor
- A TLcdAIXM51ModelDescriptor
.TLcdAIXM51ModelDescriptor
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
getBounds
in class TLcdGML32AbstractFeature
ILcdBounds
by which the geometry of this ILcdBounded
object
is bounded.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 TLcdModelMetadata getModelMetadata()
ILcdModel
TLcdModelMetadata
instance every time it is called.
The default implementation uses TLcdModelMetadata.Builder.fromModel(com.luciad.model.ILcdModel)
.
Implementations can recreate
or extend
the metadata.
The following example adds a data category and source file mime type:
public TLcdModelMetadata getModelMetadata() {
String source = this.getModelDescriptor().getSourceName();
return this.getModelMetadata().asBuilder()
.entryPoint(new TLcdModelMetadata.Source(source, MIME_XML))
.addDataCategory(TLcdModelMetadata.DataCategory.VECTOR)
.build();
}
getModelMetadata
in interface ILcdModel
public Enumeration elements()
ILcdModel
public void addElement(Object aElement, int aEventMode)
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
.ILcdModel.canAddElement(Object)
public boolean canAddElement(Object aElement)
ILcdModel
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.
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 addElements(Vector aElements, int aEventMode)
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.aEventMode
- 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)
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
.ILcdModel.canRemoveElement(Object)
public boolean canRemoveElement(Object aElement)
ILcdModel
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.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 aEventMode)
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.aEventMode
- 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 Set<ILcdDataObjectIndexedModel.IndexId> getIndexIds()
ILcdDataObjectIndexedModel
ILcdDataObjectIndexedModel.addIndex(java.util.List,
boolean)
.getIndexIds
in interface ILcdDataObjectIndexedModel
ILcdDataObjectIndexedModel.addIndex(java.util.List, boolean)
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 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 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 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 void removeAllIndices()
ILcdDataObjectIndexedModel
removeAllIndices
in interface ILcdDataObjectIndexedModel
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 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 ALcdDataObjectExpressionLanguage getDataObjectExpressionLanguage()
ILcdDataObjectIndexedModel
getDataObjectExpressionLanguage
in interface ILcdDataObjectIndexedModel
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 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 TLcdAIXM51AbstractAIXMMessage clone()
TLcdDataObject
TLcdDataObject.clone(Map)
.clone
in interface ILcdCloneable
clone
in class TLcdGML32AbstractFeature
Object.clone()
public TLcdDataObject clone(Map aObjectDictionary)
TLcdDataObject
ILcdDataObject
, the value is cloned by first creating a new instance via
the value.getDataType().newInstance()
method, and then cloning its properties one by one.ILcdDeepCloneable
or
ILcdCloneable
then this interface is used to clone the value.clone
in interface ILcdDeepCloneable
clone
in class TLcdGML32AbstractFeature
aObjectDictionary
- the Object dictionary that keeps track of the objects for which a clone has already been made,
and their corresponding clone Object.public int size()
ILcdIntegerIndexedModel
size
in interface ILcdIntegerIndexedModel
public int indexOf(Object o)
ILcdIntegerIndexedModel
i
for which this.elementAt(i).equals(aElement)
.indexOf
in interface ILcdIntegerIndexedModel
o
- the element to search for.public Object elementAt(int i)
ILcdIntegerIndexedModel
elementAt
in interface ILcdIntegerIndexedModel
i
- an index into this ILcdModel
.public List<Object> getDependentObjects()
ILcdLockDependent
TLcdLockUtil
first locks all objects
returned by this method before locking this object.getDependentObjects
in interface ILcdLockDependent
public ELcdGML32Aggregation getAggregationType()
aggregationType
attribute.AGGREGATION_TYPE_PROPERTY
property.public void setAggregationType(ELcdGML32Aggregation aValue)
aggregationType
attribute.aValue
- the value to set for the AGGREGATION_TYPE_PROPERTY
property.public TLcdGML32BoundingShape getBoundedBy()
boundedBy
element.
This property describes the minimum bounding box or rectangle that encloses the entire feature.
BOUNDED_BY_PROPERTY
property.public void setBoundedBy(TLcdGML32BoundingShape aValue)
boundedBy
element.
This property describes the minimum bounding box or rectangle that encloses the entire feature.
aValue
- the value to set for the BOUNDED_BY_PROPERTY
property.public Object getLocation()
location
element.LOCATION_PROPERTY
property.TLcdGML32LocationProperty
public void setLocation(Object aValue)
location
element.aValue
- the value to set for the LOCATION_PROPERTY
property.