TLcdGML31AbstractFeatureCollection (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.datamodel.TLcdDataObject
- - com.luciad.datamodel.TLcdFeaturedDataObject
  - - com.luciad.format.gml31.model.TLcdGML31AbstractGML
    - - com.luciad.format.gml31.model.TLcdGML31AbstractFeature
      - com.luciad.format.gml31.model.TLcdGML31AbstractFeatureCollection

All Implemented Interfaces:

ILcdDataObject, ILcd2DBoundsIndexedModel, ILcd2DBoundsInteractable, ILcdIntegerIndexedModel, ILcdModel, ILcdModelContainer, ILcdModelProducerListener, ILcdModelTreeNode, ILcdBounded, ILcdShape, ILcdShapeList, ILcdLockDependent, ILcdCloneable, ILcdDeepCloneable, ILcdDisposable, ~~ILcdFeatured~~ , ILcdInvalidateable, ~~ILcdSelfDescribedFeatured~~ , Serializable, AutoCloseable, Cloneable, EventListener

Direct Known Subclasses:

TLcdGML31FeatureCollection
```
public class TLcdGML31AbstractFeatureCollection
extends TLcdGML31AbstractFeature
implements ILcd2DBoundsIndexedModel, ILcdIntegerIndexedModel, ILcdModelTreeNode, ILcdLockDependent
```
Model class for the AbstractFeatureCollectionType that implements ILcd2DBoundsIndexedModel and ILcdIntegerIndexedModel.
This type is deprecated in GML 3_2, which defines A GML feature collection as any GML feature with a property element in its content model whose content model is derived by extension from AbstractFeatureMember.

Since:

10.0

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface com.luciad.model.ILcdModel
  ILcdModel.Query

Field Summary

Fields
Modifier and Type	Field and Description
`static TLcdDataProperty`	`BOUNDED_BY_PROPERTY` Data property that maps to the `boundedBy` element.
`static TLcdDataProperty`	`FEATURE_MEMBER_PROPERTY` Data property that maps to the `featureMember` element.
`static TLcdDataProperty`	`FEATURE_MEMBERS_PROPERTY` Data property that maps to the `featureMembers` element.
`static TLcdDataProperty`	`LOCATION_PROPERTY` Data property that maps to the `location` element.

Fields inherited from class com.luciad.format.gml31.model.TLcdGML31AbstractGML
DESCRIPTION_PROPERTY, ID_PROPERTY, META_DATA_PROPERTY_PROPERTY, NAME_PROPERTY

Fields inherited from interface com.luciad.model.ILcdModel
FIRE_LATER, FIRE_NOW, NO_EVENT

Constructor Summary

Constructors
Constructor and Description

TLcdGML31AbstractFeatureCollection(TLcdDataType aType)

Constructors
Constructor and Description
`TLcdGML31AbstractFeatureCollection(TLcdDataType aType)`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`void`	`addHierarchyModelContainerListener(ILcdModelContainerListener aModelContainerListener)` Registers the given `ILcdModelContainerListener` to receive `TLcdModelContainerEvent`s from all the `ILcdModelTreeNode`s contained in the tree with this node as root node.
`void`	`addHierarchyModelListener(ILcdModelListener aModelListener)` Registers the given `ILcdModelListener` to receive `TLcdModelChangedEvent`s from all the `ILcdModel`s contained in the tree with this node as root node.
`boolean`	`addModel(ILcdModel aModel)` Adds the `ILcdModel aModel` as a child model to this `ILcdModelTreeNode`.
`void`	`addModelContainerListener(ILcdModelContainerListener aModelContainerListener)` Adds an `ILcdModelContainerListener` to this `ILcdModelContainer`.
`void`	`addModelListener(ILcdModelListener aArg0)` Registers the specified model listener to receive notifications of model changes on this model.
`int`	`applyOnInteract2DBounds(ILcdBounds aArg0, boolean aArg1, ILcdFunction aArg2, double aArg3, double aArg4)` Applies the specified function to all the model elements of which the 2D bounds overlap with the specified bounds.
`int`	`applyOnInteract2DBounds(ILcdBounds aArg0, boolean aArg1, ILcdFunction aArg2, double aArg3, double aArg4, double aArg5, double aArg6, boolean aArg7)` 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`	`canRemoveElement(Object aElement)` Returns `true` if the specified element can be removed from this model, `false` otherwise.
`TLcdGML31AbstractFeatureCollection`	`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.
`Object`	`elementAt(int aIndex)` Returns the element at the specified index.
`void`	`elementChanged(Object aElement, 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 aElements, 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.
`TLcdGML31BoundingShape`	`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.
`List<Object>`	`getDependentObjects()` Returns the objects that must be locked along with this object.
`List<TLcdGML31AbstractFeature>`	`getFeatureMember()` Returns the value of the property that maps to the `featureMember` element.
`List<TLcdGML31AbstractFeature>`	`getFeatureMembers()` Returns the role value contained in the value of the `FEATURE_MEMBERS_PROPERTY` property.
`Object`	`getLocation()` Returns the value of the property that maps to the `location` element.
`ILcdModel`	`getModel(int aIndex)` Returns the child model at the given index.
`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.
`Object`	`getValue(TLcdDataProperty aProperty)` Returns the value of the given property.
`int`	`indexOf(Object aElement)` 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`	`isEmpty()` Returns `true` when the model node is only used as a container for other models, and contains no useful data itself, `false` otherwise.
`int`	`modelCount()` Returns the number of child models of this model node.
`void`	`modelProduced(TLcdModelProducerEvent aModelProducerEvent)` Notifies this ILcdModelProducerListener of a produced model.
`Enumeration`	`models()` Returns an `Enumeration` of the child models of this `ILcdModelTreeNode`.
`void`	`removeAllElements(int aEventMode)` Removes all elements 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.
`void`	`removeHierarchyModelContainerListener(ILcdModelContainerListener aModelContainerListener)` Unregisters the given `ILcdModelContainerListener` from receiving `TLcdModelContainerEvent`s for the tree with this node as root node.
`void`	`removeHierarchyModelListener(ILcdModelListener aModelListener)` Unregisters the given `ILcdModelListener` from receiving `TLcdModelChangedEvent`s for the tree with this node as root node.
`boolean`	`removeModel(ILcdModel aModel)` Removes the child model `aModel` from this `ILcdModelTreeNode`.
`void`	`removeModelContainerListener(ILcdModelContainerListener aModelContainerListener)` Removes an `ILcdModelContainerListener` from this `ILcdModelContainer`.
`void`	`removeModelListener(ILcdModelListener aModelListener)` Unregisters the specified model listener so that it no longer receives notifications of model changes on this model.
`void`	`setBoundedBy(TLcdGML31BoundingShape aValue)` Sets the value of the property that maps to the `boundedBy` element.
`void`	`setFeatureMembers(List<TLcdGML31AbstractFeature> aValue)` Sets the value of the property that maps to the `featureMembers` element.
`void`	`setLocation(Object aValue)` Sets the value of the property that maps to the `location` element.
`void`	`setModelDescriptor(TLcdGML31ModelDescriptor aModelDescriptor)`
`void`	`setModelReference(ILcdModelReference aModelReference)`
`int`	`size()` Returns the number of elements in this model.

Methods inherited from class com.luciad.format.gml31.model.TLcdGML31AbstractFeature
collectShapes, contains2D, contains2D, contains3D, contains3D, getFocusPoint, getShape, getShapeCount, invalidateObject, shapesChanged

Methods inherited from class com.luciad.format.gml31.model.TLcdGML31AbstractGML
getDescription, getId, getMetaDataProperty, getName, setDescription, setId

Methods inherited from class com.luciad.datamodel.TLcdFeaturedDataObject
canSetFeature, getFeature, getFeature, getFeatureCount, getFeaturedDescriptor, setFeature, setFeature

Methods inherited from class com.luciad.datamodel.TLcdDataObject
getDataType, getValue, hasValue, hasValue, setValue, setValue, toString

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.luciad.model.ILcd2DBoundsIndexedModel
query

Methods inherited from interface com.luciad.model.ILcdModel
all, filter

Methods inherited from interface com.luciad.util.ILcdDisposable
close

Methods inherited from interface com.luciad.model.ILcdModelContainer
getModels

- Field Detail
  - FEATURE_MEMBER_PROPERTY
```
public static final TLcdDataProperty FEATURE_MEMBER_PROPERTY
```
    Data property that maps to the featureMember element. The possible values for this property are instances of List<TLcdGML31FeatureProperty>.
  - FEATURE_MEMBERS_PROPERTY
```
public static final TLcdDataProperty FEATURE_MEMBERS_PROPERTY
```
    Data property that maps to the featureMembers element. The possible values for this property are instances of TLcdGML31FeatureArrayProperty.
  - 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 TLcdGML31BoundingShape.
  - 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 TLcdGML31LocationProperty.
- Constructor Detail
  - TLcdGML31AbstractFeatureCollection
```
public TLcdGML31AbstractFeatureCollection(TLcdDataType aType)
```
- Method Detail
  - getValue
```
public Object getValue(TLcdDataProperty aProperty)
```
    Description copied from interface: ILcdDataObject
    
    Returns the value of the given property.
    
    If the property is a collection, the returned value will never be null. If the property has not been set, an empty collection of the appropriate type will be returned (Set, List or Map).
    
    The property must not be null, and must be declared in the data object's type or in one of its super types. Otherwise an IllegalArgumentException is thrown.
    
    Specified by:
    
    getValue in interface ILcdDataObject
    
    Overrides:
    
    getValue in class TLcdDataObject
    
    Parameters:
    
    aProperty - the property for which the value is to be returned
    
    Returns:
    
    the value of the given property for this data object
  - setModelReference
```
public void setModelReference(ILcdModelReference aModelReference)
```
  - setModelDescriptor
```
public void setModelDescriptor(TLcdGML31ModelDescriptor aModelDescriptor)
```
  - addHierarchyModelContainerListener
```
public void addHierarchyModelContainerListener(ILcdModelContainerListener aModelContainerListener)
```
    Description copied from interface: ILcdModelTreeNode
    
    Registers the given ILcdModelContainerListener to receive TLcdModelContainerEvents from all the ILcdModelTreeNodes contained in the tree with this node as root node. If the listener should only receive events originating from this model node, it should be adedd as a regular model listener (see ILcdModelTreeNode.addModelContainerListener(ILcdModelContainerListener)).
    
    The source ILcdModelContainer of the event can be retrieved by calling TLcdModelContainerEvent.getModelContainer() on the received TLcdModelContainerEvent.
    
    Specified by:
    
    addHierarchyModelContainerListener in interface ILcdModelTreeNode
    
    Parameters:
    
    aModelContainerListener - the listener
    
    See Also:
    
    ILcdModelTreeNode.removeHierarchyModelContainerListener(ILcdModelContainerListener)
  - addHierarchyModelListener
```
public void addHierarchyModelListener(ILcdModelListener aModelListener)
```
    Description copied from interface: ILcdModelTreeNode
    
    Registers the given ILcdModelListener to receive TLcdModelChangedEvents from all the ILcdModels contained in the tree with this node as root node. If the listener should only receive events originating from this model node, it should be added as a regular model listener (see ILcdModelTreeNode.addModelListener(ILcdModelListener)).
    
    The source ILcdModel of the event can be retrieved by calling TLcdModelChangedEvent.getModel() on the received TLcdModelChangedEvent.
    
    Specified by:
    
    addHierarchyModelListener in interface ILcdModelTreeNode
    
    Parameters:
    
    aModelListener - the listener
    
    See Also:
    
    ILcdModelTreeNode.removeHierarchyModelListener(ILcdModelListener)
  - removeHierarchyModelContainerListener
```
public void removeHierarchyModelContainerListener(ILcdModelContainerListener aModelContainerListener)
```
    Description copied from interface: ILcdModelTreeNode
    
    Unregisters the given ILcdModelContainerListener from receiving TLcdModelContainerEvents for the tree with this node as root node.
    
    Specified by:
    
    removeHierarchyModelContainerListener in interface ILcdModelTreeNode
    
    Parameters:
    
    aModelContainerListener - the listener
    
    See Also:
    
    ILcdModelTreeNode.addHierarchyModelContainerListener(ILcdModelContainerListener)
  - removeHierarchyModelListener
```
public void removeHierarchyModelListener(ILcdModelListener aModelListener)
```
    Description copied from interface: ILcdModelTreeNode
    
    Unregisters the given ILcdModelListener from receiving TLcdModelChangedEvents for the tree with this node as root node.
    
    Specified by:
    
    removeHierarchyModelListener in interface ILcdModelTreeNode
    
    Parameters:
    
    aModelListener - the listener
    
    See Also:
    
    ILcdModelTreeNode.addHierarchyModelListener(ILcdModelListener)
  - addModel
```
public boolean addModel(ILcdModel aModel)
```
    Description copied from interface: ILcdModelTreeNode
    
    Adds the ILcdModel aModel as a child model to this ILcdModelTreeNode.
    
    Specified by:
    
    addModel in interface ILcdModelContainer
    
    Specified by:
    
    addModel in interface ILcdModelTreeNode
    
    Parameters:
    
    aModel - the model to be added.
    
    Returns:
    
    true if this collection of models changed as a result of the call
  - addModelContainerListener
```
public void addModelContainerListener(ILcdModelContainerListener aModelContainerListener)
```
    Description copied from interface: ILcdModelTreeNode
    
    Adds an ILcdModelContainerListener to this ILcdModelContainer.
    It will only receive notifications of changes in this ILcdModelTreeNode and not of any changes in the state of the child model node(s). If this is required, the listener must be registered as a hierarchy listener (see ILcdModelTreeNode.addHierarchyModelContainerListener(ILcdModelContainerListener)).
    .
    
    Specified by:
    
    addModelContainerListener in interface ILcdModelContainer
    
    Specified by:
    
    addModelContainerListener in interface ILcdModelTreeNode
    
    Parameters:
    
    aModelContainerListener - the listener to be added.
    
    See Also:
    
    ILcdModelContainer.removeModelContainerListener(com.luciad.model.ILcdModelContainerListener)
  - getModel
```
public ILcdModel getModel(int aIndex)
```
    Description copied from interface: ILcdModelTreeNode
    
    Returns the child model at the given index.
    
    Specified by:
    
    getModel in interface ILcdModelContainer
    
    Specified by:
    
    getModel in interface ILcdModelTreeNode
    
    Parameters:
    
    aIndex - a valid index in this ILcdModelTreeNode
    
    Returns:
    
    the child model at the given index.
  - modelCount
```
public int modelCount()
```
    Description copied from interface: ILcdModelTreeNode
    
    Returns the number of child models of this model node.
    
    Specified by:
    
    modelCount in interface ILcdModelContainer
    
    Specified by:
    
    modelCount in interface ILcdModelTreeNode
    
    Returns:
    
    the number of child models of this model node.
  - models
```
public Enumeration models()
```
    Description copied from interface: ILcdModelTreeNode
    
    Returns an Enumeration of the child models of this ILcdModelTreeNode.
    
    Specified by:
    
    models in interface ILcdModelContainer
    
    Specified by:
    
    models in interface ILcdModelTreeNode
    
    Returns:
    
    an Enumeration of the child models of this ILcdModelTreeNode.
  - removeModel
```
public boolean removeModel(ILcdModel aModel)
```
    Description copied from interface: ILcdModelTreeNode
    
    Removes the child model aModel from this ILcdModelTreeNode.
    
    Specified by:
    
    removeModel in interface ILcdModelContainer
    
    Specified by:
    
    removeModel in interface ILcdModelTreeNode
    
    Parameters:
    
    aModel - the model to be removed.
    
    Returns:
    
    true if a model was removed as a result of this call
  - removeModelContainerListener
```
public void removeModelContainerListener(ILcdModelContainerListener aModelContainerListener)
```
    Description copied from interface: ILcdModelTreeNode
    
    Removes an ILcdModelContainerListener from this ILcdModelContainer.
    It is not possible to remove a hierarchy model container listener. Use ILcdModelTreeNode.removeHierarchyModelContainerListener(ILcdModelContainerListener) for this purpose.
    
    Specified by:
    
    removeModelContainerListener in interface ILcdModelContainer
    
    Specified by:
    
    removeModelContainerListener in interface ILcdModelTreeNode
    
    Parameters:
    
    aModelContainerListener - the listener to be removed.
    
    See Also:
    
    ILcdModelContainer.addModelContainerListener(com.luciad.model.ILcdModelContainerListener)
  - modelProduced
```
public void modelProduced(TLcdModelProducerEvent aModelProducerEvent)
```
    Description copied from interface: ILcdModelProducerListener
    
    Notifies this ILcdModelProducerListener of a produced model.
    
    Specified by:
    
    modelProduced in interface ILcdModelProducerListener
    
    Parameters:
    
    aModelProducerEvent - the event describing the changes to a ILcdModelProducer.
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: ILcdModelTreeNode
    
    Returns true when the model node is only used as a container for other models, and contains no useful data itself, false otherwise.
    
    Specified by:
    
    isEmpty in interface ILcdModelTreeNode
    
    Returns:
    
    true when the model node contains no useful data, false otherwise
  - 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
    
    Specified by:
    
    addElement in interface ILcdModelTreeNode
    
    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:
    
    ILcdModel.canAddElement(Object)
  - 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
    
    Specified by:
    
    addElements in interface ILcdModelTreeNode
    
    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:
    
    ILcdModel.canAddElement(Object)
  - addModelListener
```
public void addModelListener(ILcdModelListener aArg0)
```
    Description copied from interface: 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.
    
    Specified by:
    
    addModelListener in interface ILcdModel
    
    Specified by:
    
    addModelListener in interface ILcdModelTreeNode
    
    Parameters:
    
    aArg0 - the ILcdModelListener to register on this model.
    
    See Also:
    
    ILcdModel.removeModelListener(com.luciad.model.ILcdModelListener), ILcdModelListener
  - applyOnInteract2DBounds
```
public int applyOnInteract2DBounds(ILcdBounds aArg0,
                                   boolean aArg1,
                                   ILcdFunction aArg2,
                                   double aArg3,
                                   double aArg4,
                                   double aArg5,
                                   double aArg6,
                                   boolean aArg7)
```
    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:
    
    aArg0 - the rectangle to test overlap with.
    
    aArg1 - 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.
    
    aArg2 - the function to apply on each element that overlaps with the given bounds.
    
    aArg3 - 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.
    
    aArg4 - the precision required in the y dimension, expressed in model units.
    
    aArg5 - 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).
    
    aArg6 - the minimal element size in the y dimension (as in ILcdBounds.getHeight()), expressed in model units.
    
    aArg7 - 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.
  - applyOnInteract2DBounds
```
public int applyOnInteract2DBounds(ILcdBounds aArg0,
                                   boolean aArg1,
                                   ILcdFunction aArg2,
                                   double aArg3,
                                   double aArg4)
```
    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:
    
    aArg0 - the rectangle to test overlap with.
    
    aArg1 - 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.
    
    aArg2 - 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.
    
    aArg3 - 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.
    
    aArg4 - the precision required in the y dimension, expressed in model units.
    
    Returns:
    
    the number of elements to which the ILcdFunction has been applied.
  - elementAt
```
public Object elementAt(int aIndex)
```
    Description copied from interface: ILcdIntegerIndexedModel
    
    Returns the element at the specified index.
    
    Specified by:
    
    elementAt in interface ILcdIntegerIndexedModel
    
    Parameters:
    
    aIndex - an index into this ILcdModel.
    
    Returns:
    
    the element at the specified index.
  - 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 aElement)
```
    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:
    
    aElement - 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.
  - 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 ILcdModel
    
    Specified by:
    
    canAddElement in interface ILcdModelTreeNode
    
    Parameters:
    
    aElement - the element to be verified.
    
    Returns:
    
    true if the specified element can be added to this model, false otherwise.
  - 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
    
    Specified by:
    
    getModelReference in interface ILcdModelTreeNode
    
    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
    
    Specified by:
    
    getModelDescriptor in interface ILcdModelTreeNode
    
    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
    
    Specified by:
    
    getModelEncoder in interface ILcdModelTreeNode
    
    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
    
    Specified by:
    
    elements in interface ILcdModelTreeNode
    
    Returns:
    
    an enumeration over all elements of this model.
  - 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
    
    Specified by:
    
    removeElement in interface ILcdModelTreeNode
    
    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:
    
    ILcdModel.canRemoveElement(Object)
  - 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
    
    Specified by:
    
    canRemoveElement in interface ILcdModelTreeNode
    
    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
    
    Specified by:
    
    removeElements in interface ILcdModelTreeNode
    
    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:
    
    ILcdModel.canRemoveElement(Object)
  - 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
    
    Specified by:
    
    removeAllElements in interface ILcdModelTreeNode
    
    Parameters:
    
    aEventMode - the mode for sending out the model change event. This can be FIRE_LATER or NO_EVENT.
  - elementChanged
```
public void elementChanged(Object aElement,
                           int aEventMode)
```
    Description copied from interface: ILcdModel
    
    Notifies this model that the specified element has changed.
    
    Specified by:
    
    elementChanged in interface ILcdModel
    
    Specified by:
    
    elementChanged in interface ILcdModelTreeNode
    
    Parameters:
    
    aElement - the element that has changed.
    
    aEventMode - the mode for sending out the model change event. This can be FIRE_LATER or NO_EVENT.
  - elementsChanged
```
public void elementsChanged(Vector aElements,
                            int aEventMode)
```
    Description copied from interface: ILcdModel
    
    Notifies this model that the elements in the specified vector have changed.
    
    Specified by:
    
    elementsChanged in interface ILcdModel
    
    Specified by:
    
    elementsChanged in interface ILcdModelTreeNode
    
    Parameters:
    
    aElements - 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.
  - fireCollectedModelChanges
```
public void fireCollectedModelChanges()
```
    Description copied from interface: ILcdModel
    
    Notifies all listeners that are registered on this model of all the changes that have been collected between the previous notification and now.
    
    Specified by:
    
    fireCollectedModelChanges in interface ILcdModel
    
    Specified by:
    
    fireCollectedModelChanges in interface ILcdModelTreeNode
    
    See Also:
    
    ILcdModelListener.modelChanged(TLcdModelChangedEvent)
  - removeModelListener
```
public void removeModelListener(ILcdModelListener aModelListener)
```
    Description copied from interface: ILcdModel
    
    Unregisters the specified model listener so that it no longer receives notifications of model changes on this model.
    
    Specified by:
    
    removeModelListener in interface ILcdModel
    
    Specified by:
    
    removeModelListener in interface ILcdModelTreeNode
    
    Parameters:
    
    aModelListener - the ILcdModelListener to remove.
    
    See Also:
    
    ILcdModel.addModelListener(com.luciad.model.ILcdModelListener), ILcdModelListener
  - 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 ILcdModel
    
    Specified by:
    
    dispose in interface ILcdModelTreeNode
    
    Specified by:
    
    dispose in interface ILcdDisposable
  - 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.
  - clone
```
public TLcdGML31AbstractFeatureCollection 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 TLcdGML31AbstractFeature
    
    Returns:
    
    a deep clone of this object
    
    See Also:
    
    Object.clone()
  - 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 TLcdGML31AbstractFeature
    
    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
  - 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 TLcdGML31AbstractFeature
    
    Returns:
    
    the ILcdBounds by which the geometry of this ILcdBounded object is bounded.
  - getFeatureMember
```
public List<TLcdGML31AbstractFeature> getFeatureMember()
```
    Returns the value of the property that maps to the featureMember element.
    
    Returns:
    
    the value of the FEATURE_MEMBER_PROPERTY property.
    
    See Also:
    
    List
  - getFeatureMembers
```
public List<TLcdGML31AbstractFeature> getFeatureMembers()
```
    Returns the role value contained in the value of the FEATURE_MEMBERS_PROPERTY property. Returns null if the value of the FEATURE_MEMBERS_PROPERTY property is null.
    
    Returns:
    
    the role value of the FEATURE_MEMBERS_PROPERTY property.
    
    See Also:
    
    TLcdGML31FeatureArrayProperty
  - setFeatureMembers
```
public void setFeatureMembers(List<TLcdGML31AbstractFeature> aValue)
```
    Sets the value of the property that maps to the featureMembers element. to a new instance of the association class TLcdGML31FeatureArrayProperty initialized with the given role value. In case the given role value is null, the FEATURE_MEMBERS_PROPERTY property is set to null.
    
    Parameters:
    
    aValue - the role value to set for the FEATURE_MEMBERS_PROPERTY property.
  - getBoundedBy
```
public TLcdGML31BoundingShape getBoundedBy()
```
    Returns the value of the property that maps to the boundedBy element.
    
    Returns:
    
    the value of the BOUNDED_BY_PROPERTY property.
  - setBoundedBy
```
public void setBoundedBy(TLcdGML31BoundingShape aValue)
```
    Sets the value of the property that maps to the boundedBy element.
    
    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.
    Deprecated in GML 3.1.0
    
    Returns:
    
    the value of the LOCATION_PROPERTY property.
    
    See Also:
    
    TLcdGML31LocationProperty
  - setLocation
```
public void setLocation(Object aValue)
```
    Sets the value of the property that maps to the location element.
    Deprecated in GML 3.1.0
    
    Parameters:
    
    aValue - the value to set for the LOCATION_PROPERTY property.

LuciadLightspeedClass TLcdGML31AbstractFeatureCollection

Nested Class Summary

Nested classes/interfaces inherited from interface com.luciad.model.ILcdModel

Field Summary

Fields inherited from class com.luciad.format.gml31.model.TLcdGML31AbstractGML

Fields inherited from interface com.luciad.model.ILcdModel

Constructor Summary

Method Summary

Methods inherited from class com.luciad.format.gml31.model.TLcdGML31AbstractFeature

Methods inherited from class com.luciad.format.gml31.model.TLcdGML31AbstractGML

Methods inherited from class com.luciad.datamodel.TLcdFeaturedDataObject

Methods inherited from class com.luciad.datamodel.TLcdDataObject

Methods inherited from class java.lang.Object

Methods inherited from interface com.luciad.model.ILcd2DBoundsIndexedModel

Methods inherited from interface com.luciad.model.ILcdModel

Methods inherited from interface com.luciad.util.ILcdDisposable

Methods inherited from interface com.luciad.model.ILcdModelContainer

Field Detail

FEATURE_MEMBER_PROPERTY

FEATURE_MEMBERS_PROPERTY

BOUNDED_BY_PROPERTY

LOCATION_PROPERTY

Constructor Detail

TLcdGML31AbstractFeatureCollection

Method Detail

getValue

setModelReference

setModelDescriptor

addHierarchyModelContainerListener

addHierarchyModelListener

removeHierarchyModelContainerListener

removeHierarchyModelListener

addModel

addModelContainerListener

getModel

modelCount

models

removeModel

removeModelContainerListener

modelProduced

isEmpty

addElement

addElements

addModelListener

applyOnInteract2DBounds

applyOnInteract2DBounds

elementAt

size

indexOf

canAddElement

getModelReference

getModelDescriptor

getModelEncoder

getModelMetadata

elements

removeElement

canRemoveElement

removeElements

removeAllElements

elementChanged

elementsChanged

fireCollectedModelChanges

removeModelListener

dispose

getDependentObjects

clone

clone

getBounds

getFeatureMember

getFeatureMembers

setFeatureMembers

getBoundedBy

setBoundedBy

getLocation

setLocation