Package com.luciad.format.aixm51.model.abstractfeature

Class TLcdAIXM51AbstractAIXMMessage

java.lang.Object
com.luciad.datamodel.TLcdDataObject
com.luciad.format.gml32.model.TLcdGML32AbstractGML
com.luciad.format.gml32.model.TLcdGML32AbstractFeature
com.luciad.format.gml32.model.TLcdGML32DynamicFeature
com.luciad.format.aixm51.model.abstractfeature.TLcdAIXM51AbstractAIXMFeatureBase
com.luciad.format.aixm51.model.abstractfeature.TLcdAIXM51AbstractAIXMMessageBase
com.luciad.format.aixm51.model.abstractfeature.TLcdAIXM51AbstractAIXMMessage
All Implemented Interfaces:
ILcdDataObject, ILcd2DBoundsIndexedModel, ILcd2DBoundsInteractable, ILcdDataObjectIndexedModel, ILcdIntegerIndexedModel, ILcdModel, ILcdBounded, ILcdShape, ILcdShapeList, ILcdLockDependent, ILcdCloneable, ILcdDeepCloneable, ILcdDisposable, ILcdInvalidateable, Serializable, AutoCloseable, Cloneable
public class TLcdAIXM51AbstractAIXMMessage extends TLcdAIXM51AbstractAIXMMessageBase implements ILcd2DBoundsIndexedModel, ILcdIntegerIndexedModel, ILcdDataObjectIndexedModel, ILcdLockDependent
Represents an AIXM 5.1 message. This class corresponds to the 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.

Since:
10.0
See Also:

  • Field Details

    • AGGREGATION_TYPE_PROPERTY

      public static final TLcdDataProperty AGGREGATION_TYPE_PROPERTY
      Data property that maps to the aggregationType attribute. The possible values for this property are instances of ELcdGML32Aggregation.

    • BOUNDED_BY_PROPERTY

      public static final TLcdDataProperty BOUNDED_BY_PROPERTY
      Data property that maps to the boundedBy element. The possible values for this property are instances of TLcdGML32BoundingShape.

    • LOCATION_PROPERTY

      public static final TLcdDataProperty LOCATION_PROPERTY
      Data property that maps to the location element. The possible values for this property are instances of TLcdGML32LocationProperty.

  • Constructor Details

    • TLcdAIXM51AbstractAIXMMessage

      public TLcdAIXM51AbstractAIXMMessage(TLcdDataType aType)
      Constructs a new 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"

      Parameters:
      aType - the message type for which to create a new instance

  • Method Details

    • fireCollectedModelChanges

      public void fireCollectedModelChanges()
      Fires a TLcdModelChangedEvent that contains all the collected selection changes.
      Specified by:
      fireCollectedModelChanges in interface ILcdModel
      See Also:

    • elementsChanged

      public void elementsChanged(Vector aObjects, int aFireEventMode)
      Sends a TLcdModelChangedEvent to the listeners.
      Specified by:
      elementsChanged in interface ILcdModel
      Parameters:
      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.

    • allElementsChanged

      public void allElementsChanged(int aFireEventMode)
      Sends a TLcdModelChangedEvent to the listeners that all elements in this model have changed.
      Parameters:
      aFireEventMode - the mode for sending out the model event. This can be ILcdFireEventMode.FIRE_NOW, ILcdFireEventMode.LATER or ILcdFireEventMode.NO_EVENT.
      See Also:

    • elementChanged

      public void elementChanged(Object aObject, int aFireEventMode)
      Sends a TLcdModelChangedEvent to the listeners.
      Specified by:
      elementChanged in interface ILcdModel
      Parameters:
      aObject - the element that has changed.
      aFireEventMode - the mode for sending out the model change event. This can be FIRE_LATER or NO_EVENT.

    • elementsAdded

      protected void elementsAdded(Vector aObjects, int aFireEventMode)
      Sends a TLcdModelChangedEvent to the listeners.
      Parameters:
      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.
      See Also:

    • elementAdded

      protected void elementAdded(Object aObject, int aFireEventMode)
      Sends a TLcdModelChangedEvent to the listeners.
      Parameters:
      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.
      See Also:

    • elementsRemoved

      protected void elementsRemoved(Vector aObjects, int aFireEventMode)
      Sends a TLcdModelChangedEvent to the listeners.
      Parameters:
      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.
      See Also:

    • elementRemoved

      protected void elementRemoved(Object aObject, int aFireEventMode)
      Sends a TLcdModelChangedEvent to the listeners.
      Parameters:
      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.
      See Also:

    • allElementsRemoved

      protected void allElementsRemoved(int aFireEventMode)
      Sends a TLcdModelChangedEvent to the listeners.
      Parameters:
      aFireEventMode - the mode for sending out the model event. This can be ILcdFireEventMode.FIRE_NOW, ILcdFireEventMode.LATER or ILcdFireEventMode.NO_EVENT.
      See Also:

    • addModelListener

      public void addModelListener(ILcdModelListener aModelListener)
      Adds an ILcdModelListener to the event listeners of this model.
      Specified by:
      addModelListener in interface ILcdModel
      Parameters:
      aModelListener - the ILcdModelListener to add.
      See Also:

    • removeModelListener

      public void removeModelListener(ILcdModelListener aModelListener)
      Removes an ILcdModelListener from the model event listeners of this model.
      Specified by:
      removeModelListener in interface ILcdModel
      Parameters:
      aModelListener - the ILcdModelListener to remove.
      See Also:

    • setModelReference

      public void setModelReference(ILcdModelReference aModelReference)
      Sets the model reference associated with the elements of this class.
      Parameters:
      aModelReference - A ILcdModelReference which is valid for all of the elements in this class.

    • setModelDescriptor

      public void setModelDescriptor(TLcdAIXM51ModelDescriptor aModelDescriptor)
      Sets the model descriptor for this model.
      Parameters:
      aModelDescriptor - A TLcdAIXM51ModelDescriptor.
      See Also:

    • applyOnInteract2DBounds

      public int applyOnInteract2DBounds(ILcdBounds aBounds, boolean aStrictOverlap, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY)
      Description copied from interface: ILcd2DBoundsIndexedModel
      Applies the specified function to all the model elements of which the 2D bounds overlap with the specified bounds. By default, the order in which the function is applied on the elements is unspecified and depends on the implementation.

      The return value of the specified function is used as a stop criterion: the spatial query is interrupted if the function returns false.

      Specified by:
      applyOnInteract2DBounds in interface ILcd2DBoundsIndexedModel
      Parameters:
      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.
      Returns:
      the number of elements to which the ILcdFunction has been applied.

    • applyOnInteract2DBounds

      public int applyOnInteract2DBounds(ILcdBounds aBounds, boolean aStrictOverlap, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY, double aMinSizeX, double aMinSizeY, boolean aIncludePoints)
      Description copied from interface: ILcd2DBoundsInteractable
      Applies the specified function to all the elements of which the 2D bounds overlap with the specified bounds. The order in which the function is applied on the elements is unspecified and depends on the implementation.

      Only elements that have at least the specified minimal size in the x dimension or in the y dimension are considered. This can be useful for quickly eliminating elements that are too small to be visible in a view, for instance. If required, an exception can be made for point elements, which have a size of 0 by 0. They can be forced to be considered, even though they would always be rejected as being too small for any sizes larger than 0.

      The return value of the specified function is used as a stop criterion: the spatial query will be interrupted as soon as the function returns false for an element it was applied on.

      Specified by:
      applyOnInteract2DBounds in interface ILcd2DBoundsIndexedModel
      Specified by:
      applyOnInteract2DBounds in interface ILcd2DBoundsInteractable
      Parameters:
      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.
      Returns:
      the number of elements to which the ILcdFunction has been applied.

    • getBounds

      public ILcdBounds getBounds()
      Description copied from interface: ILcdBounded
      Returns the 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.

      Specified by:
      getBounds in interface ILcdBounded
      Overrides:
      getBounds in class TLcdGML32AbstractFeature
      Returns:
      the ILcdBounds by which the geometry of this ILcdBounded object is bounded.

    • getModelReference

      public ILcdModelReference getModelReference()
      Description copied from interface: ILcdModel
      Returns the ILcdModelReference describing how the geometry of the elements contained in this model should be interpreted.
      Specified by:
      getModelReference in interface ILcdModel
      Returns:
      the ILcdModelReference of this ILcdModel.

    • getModelDescriptor

      public ILcdModelDescriptor getModelDescriptor()
      Description copied from interface: ILcdModel
      Returns the ILcdModelDescriptor providing meta information about this model and its elements.
      Specified by:
      getModelDescriptor in interface ILcdModel
      Returns:
      the ILcdModelDescriptor of this ILcdModel. Should not be null.

    • getModelEncoder

      public ILcdModelEncoder getModelEncoder()
      Description copied from interface: ILcdModel
      Returns, if available, a model encoder that is capable of encoding this model, (encoder.canEncode(this)), null otherwise.
      Specified by:
      getModelEncoder in interface ILcdModel
      Returns:
      a model encoder that is capable of encoding this model if available, null otherwise.

    • getModelMetadata

      public TLcdModelMetadata getModelMetadata()
      Description copied from interface: ILcdModel
      Collects and returns metadata about the model. Note that this method does not necessarily return the same 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();
   }
      Specified by:
      getModelMetadata in interface ILcdModel
      Returns:
      Metadata about the model.

    • elements

      public Enumeration elements()
      Description copied from interface: ILcdModel
      Returns an enumeration over all elements of this model. The order in which the elements are enumerated is unspecified by default.
      Specified by:
      elements in interface ILcdModel
      Returns:
      an enumeration over all elements of this model.

    • addElement

      public void addElement(Object aElement, int aEventMode)
      Description copied from interface: ILcdModel
      Adds the specified element to this model.

      Models that support this operation may place limitations on what elements may be added to this model. For example, implementations that are based on a spatial indexing structure will require that elements implement ILcdBounded.

      When adding an element, the user should make sure that canAddElement(aElement) holds, and that the element's geometry is expressed in the same model reference as this model. It is generally undefined what happens if an invalid element is added.

      Implementations of this interface should clearly specify in their documentation any restrictions on what elements may be added. Although it is unspecified what happens if the preconditions are not met, implementations are encouraged to throw meaningful exceptions (for example, NullPointerException, IllegalArgumentException, ClassCastException, UnsupportedOperationException), whenever possible.

      Specified by:
      addElement in interface ILcdModel
      Parameters:
      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.
      See Also:

    • canAddElement

      public boolean canAddElement(Object aElement)
      Description copied from interface: ILcdModel
      Returns 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.

      Specified by:
      canAddElement in interface ILcdDataObjectIndexedModel
      Specified by:
      canAddElement in interface ILcdModel
      Parameters:
      aElement - the element to be verified.
      Returns:
      true if the specified element can be added to this model, false otherwise.

    • addElements

      public void addElements(Vector aElements, int aEventMode)
      Description copied from interface: ILcdModel
      Adds all of the elements in the specified vector to this model. Models that support this operation may place limitations on what elements may be added to this model. For example, implementations that are based on a spatial indexing structure will require that elements implement 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.

      Specified by:
      addElements in interface ILcdModel
      Parameters:
      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.
      See Also:

    • removeElement

      public void removeElement(Object aElement, int aEventMode)
      Description copied from interface: ILcdModel
      Removes the specified element from this model. If the specified element is not contained in this model, this method has no effect.

      Although it is unspecified what happens if the preconditions are not met, implementations are encouraged to throw meaningful exceptions (for example, NullPointerException, IllegalArgumentException, ClassCastException, UnsupportedOperationException), whenever possible.

      Specified by:
      removeElement in interface ILcdModel
      Parameters:
      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.
      See Also:

    • canRemoveElement

      public boolean canRemoveElement(Object aElement)
      Description copied from interface: ILcdModel
      Returns 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.
      Specified by:
      canRemoveElement in interface ILcdModel
      Parameters:
      aElement - the element to be verified.
      Returns:
      true if the specified element can be removed from this model, false otherwise.

    • removeElements

      public void removeElements(Vector aElements, int aEventMode)
      Description copied from interface: ILcdModel
      Removes all of the elements in the specified vector from this model. If one of the elements in the specified vector is not contained in this model, this element will be ignored.

      The behavior of this operation is undefined if the specified vector is modified while the operation is in progress.

      The specified elements will be removed from this model in the order they are specified in the vector. If an element cannot be removed, this method will return at the first failure. Succeeding elements won't be removed.

      Although it is unspecified what happens if the preconditions are not met, implementations are encouraged to throw meaningful exceptions (for example, NullPointerException, IllegalArgumentException, ClassCastException, UnsupportedOperationException), whenever possible.

      Specified by:
      removeElements in interface ILcdModel
      Parameters:
      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.
      See Also:

    • removeAllElements

      public void removeAllElements(int aEventMode)
      Description copied from interface: ILcdModel
      Removes all elements from this model.

      If an element cannot be removed, this method will return at the first failure. Succeeding elements won't be removed.

      Although it is unspecified what happens if the preconditions are not met, implementations are encouraged to throw meaningful exceptions (for example, NullPointerException, IllegalArgumentException, ClassCastException, UnsupportedOperationException), whenever possible.

      Specified by:
      removeAllElements in interface ILcdModel
      Parameters:
      aEventMode - the mode for sending out the model change event. This can be FIRE_LATER or NO_EVENT.

    • getIndexIds

      public Set<ILcdDataObjectIndexedModel.IndexId> getIndexIds()
      Description copied from interface: ILcdDataObjectIndexedModel
      Returns the set of all indices which are currently available on this model. If no indices are available, an empty set is returned.

      If a required index is not available, it can be created using ILcdDataObjectIndexedModel.addIndex(java.util.List, boolean).

      Specified by:
      getIndexIds in interface ILcdDataObjectIndexedModel
      Returns:
      the set of all indices which are currently available on this model.
      See Also:

    • getIndexId

      public ILcdDataObjectIndexedModel.IndexId getIndexId(Set<String> aExpressions)
      Description copied from interface: ILcdDataObjectIndexedModel
      Returns the index id which corresponds to the given set of expressions, or 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).

      Specified by:
      getIndexId in interface ILcdDataObjectIndexedModel
      Parameters:
      aExpressions - the expressions for which an index id should be returned.
      Returns:
      the index matching the given set of expressions and uniqueness, or null if no such index is available.

    • canAddIndex

      public boolean canAddIndex(List<String> aExpressions, boolean aIsUniqueIndex)
      Description copied from interface: ILcdDataObjectIndexedModel
      Returns true if an index can be created for the given list of expressions and uniqueness flag, false otherwise.

      An index can be created if:

      • There are no duplicate expressions in the expression list.
      • An index with the same expressions but different uniqueness property doesn't exist yet in this model.
      • The specified expressions are valid expressions for the expression language of this model, that is, the expression language is capable of compiling each of the expressions
      • If the index is unique, there should at most be one model element matching each unique combination of expression values.
      Implementations may add additional constraints, which should be clearly specified in their documentation.
      Specified by:
      canAddIndex in interface ILcdDataObjectIndexedModel
      Parameters:
      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.
      Returns:
      true if an index can be created for the given list of expressions and uniqueness flag, false otherwise.

    • addIndex

      public ILcdDataObjectIndexedModel.IndexId addIndex(List<String> aExpressions, boolean aIsUniqueIndex)
      Description copied from interface: ILcdDataObjectIndexedModel
      Creates a new index for the given list of expressions. The uniqueness flag allows to specify whether the index should be created as a unique index or not. If the index already exists on the model, this method has no effect and the index id of the existing index is returned.

      It is not allowed to create both a unique and a non-unique index with the same list of expressions.

      Specified by:
      addIndex in interface ILcdDataObjectIndexedModel
      Parameters:
      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.
      Returns:
      the index id, uniquely identifying the created index.

    • removeIndex

      public boolean removeIndex(ILcdDataObjectIndexedModel.IndexId aIndexId)
      Description copied from interface: ILcdDataObjectIndexedModel
      Removes the specified index from this model. All resources allocated for the index will be released. If the index does not exist on this model, this method has no effect.
      Specified by:
      removeIndex in interface ILcdDataObjectIndexedModel
      Parameters:
      aIndexId - the index to be removed.
      Returns:
      true if the specified index was successfully removed from this model, false otherwise.

    • removeAllIndices

      public void removeAllIndices()
      Description copied from interface: ILcdDataObjectIndexedModel
      Removes all indices from this model.
      Specified by:
      removeAllIndices in interface ILcdDataObjectIndexedModel

    • retrieveAllByIndex

      public Collection<ILcdDataObject> retrieveAllByIndex(ILcdDataObjectIndexedModel.IndexId aIndexId, List aExpressionValues)
      Description copied from interface: ILcdDataObjectIndexedModel
      Returns all model elements which match the given list of values for the expressions in the given index.

      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.

      If no elements match the specified expression values, an empty collection is returned.

      Specified by:
      retrieveAllByIndex in interface ILcdDataObjectIndexedModel
      Parameters:
      aIndexId - the index describing the expressions to test for.
      aExpressionValues - the list of values to be compared with the list of evaluated expressions.
      Returns:
      a collection containing all model elements which match the given list of values for the expressions in the given index.
      See Also:

    • retrieveFirstByIndex

      public ILcdDataObject retrieveFirstByIndex(ILcdDataObjectIndexedModel.IndexId aIndexId, List aExpressionValues)
      Description copied from interface: ILcdDataObjectIndexedModel
      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.

      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.

      Specified by:
      retrieveFirstByIndex in interface ILcdDataObjectIndexedModel
      Parameters:
      aIndexId - the index describing the expressions to test for.
      aExpressionValues - the list of values to be compared with the list of evaluated expressions.
      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.
      See Also:

    • getIndexedValues

      public Set<List<Object>> getIndexedValues(ILcdDataObjectIndexedModel.IndexId aIndex)
      Description copied from interface: ILcdDataObjectIndexedModel
      Returns the set of all unique expression value combinations which are present in the specified index.
      Specified by:
      getIndexedValues in interface ILcdDataObjectIndexedModel
      Parameters:
      aIndex - the index for which to return the set of expression value combinations.
      Returns:
      the set of expression value combinations, present in the specified index.

    • getDataObjectExpressionLanguage

      public ALcdDataObjectExpressionLanguage getDataObjectExpressionLanguage()
      Description copied from interface: ILcdDataObjectIndexedModel
      Returns the expression language used to evaluate expressions defined in the indices of the model.
      Specified by:
      getDataObjectExpressionLanguage in interface ILcdDataObjectIndexedModel
      Returns:
      the expression language used to evaluate expressions defined in the indices of the model.

    • setDataObjectExpressionLanguage

      public void setDataObjectExpressionLanguage(ALcdDataObjectExpressionLanguage aExpressionLanguage)
      Description copied from interface: ILcdDataObjectIndexedModel
      Sets the expression language to be used for evaluating expressions defined in the indices of the model. This operation will trigger a rebuild of all indices which are currently configured on the model.
      Specified by:
      setDataObjectExpressionLanguage in interface ILcdDataObjectIndexedModel
      Parameters:
      aExpressionLanguage - the expression language used to evaluate expressions defined in the indices of the model.

    • dispose

      public void dispose()
      Description copied from interface: ILcdModel
      Disposes of this model and allows it to release any system resources that it is holding. The result of calling any other method (other than finalize) on this model subsequent to a call to this method is undefined.
      Specified by:
      dispose in interface ILcdDisposable
      Specified by:
      dispose in interface ILcdModel

    • clone

      public TLcdAIXM51AbstractAIXMMessage clone()
      Description copied from class: TLcdDataObject
      Returns a deep clone of this object. This method delegates to TLcdDataObject.clone(Map).
      Specified by:
      clone in interface ILcdCloneable
      Overrides:
      clone in class TLcdGML32AbstractFeature
      Returns:
      a deep clone of this object
      See Also:

    • clone

      public TLcdDataObject clone(Map aObjectDictionary)
      Description copied from class: TLcdDataObject
      Returns a deep clone of this object. If the clone is not already present in the dictionary, a new instance if created as follows:
      • First, a new instance is created using Java's clone() mechanism.
      • Then, all properties of this object are cloned and set on the newly created instance. A property is cloned as follows:
        • If the property value is an 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.
        • If the value implements ILcdDeepCloneable or ILcdCloneable then this interface is used to clone the value.
        • Otherwise, the property value is copied by reference.
      Specified by:
      clone in interface ILcdDeepCloneable
      Overrides:
      clone in class TLcdGML32AbstractFeature
      Parameters:
      aObjectDictionary - the Object dictionary that keeps track of the objects for which a clone has already been made, and their corresponding clone Object.
      Returns:
      a deep clone of this object

    • size

      public int size()
      Description copied from interface: ILcdIntegerIndexedModel
      Returns the number of elements in this model.
      Specified by:
      size in interface ILcdIntegerIndexedModel
      Returns:
      the number of elements in this model.

    • indexOf

      public int indexOf(Object o)
      Description copied from interface: ILcdIntegerIndexedModel
      Returns the index of the first occurrence of the specified element in the model, or -1 if this model does not contain the element. More formally: returns the smallest i for which this.elementAt(i).equals(aElement).
      Specified by:
      indexOf in interface ILcdIntegerIndexedModel
      Parameters:
      o - the element to search for.
      Returns:
      the index of the first occurrence of the specified element in model vector, or -1 if this model does not contain the element.

    • elementAt

      public Object elementAt(int i)
      Description copied from interface: ILcdIntegerIndexedModel
      Returns the element at the specified index.
      Specified by:
      elementAt in interface ILcdIntegerIndexedModel
      Parameters:
      i - an index into this ILcdModel.
      Returns:
      the element at the specified index.

    • getDependentObjects

      public List<Object> getDependentObjects()
      Description copied from interface: ILcdLockDependent
      Returns the objects that must be locked along with this object. TLcdLockUtilfirst locks all objects returned by this method before locking this object.
      Specified by:
      getDependentObjects in interface ILcdLockDependent
      Returns:
      the objects that must be locked along with this object.

    • getAggregationType

      public ELcdGML32Aggregation getAggregationType()
      Returns the value of the property that maps to the aggregationType attribute.
      Returns:
      the value of the AGGREGATION_TYPE_PROPERTY property.

    • setAggregationType

      public void setAggregationType(ELcdGML32Aggregation aValue)
      Sets the value of the property that maps to the aggregationType attribute.
      Parameters:
      aValue - the value to set for the AGGREGATION_TYPE_PROPERTY property.

    • getBoundedBy

      public TLcdGML32BoundingShape getBoundedBy()
      Returns the value of the property that maps to the boundedBy element.

      This property describes the minimum bounding box or rectangle that encloses the entire feature.

      Returns:
      the value of the BOUNDED_BY_PROPERTY property.

    • setBoundedBy

      public void setBoundedBy(TLcdGML32BoundingShape aValue)
      Sets the value of the property that maps to the boundedBy element.

      This property describes the minimum bounding box or rectangle that encloses the entire feature.

      Parameters:
      aValue - the value to set for the BOUNDED_BY_PROPERTY property.

    • getLocation

      public Object getLocation()
      Returns the value of the property that maps to the location element.
      Returns:
      the value of the LOCATION_PROPERTY property.
      See Also:

    • setLocation

      public void setLocation(Object aValue)
      Sets the value of the property that maps to the location element.
      Parameters:
      aValue - the value to set for the LOCATION_PROPERTY property.