com.luciad.format.gml

LuciadFusionClass TLcdGMLModelList

java.lang.Object

com.luciad.format.gml.TLcdGMLModelList

All Implemented Interfaces:

ILcdModel, ILcdDisposable, java.io.Serializable, java.lang.AutoCloseable

Deprecated.

This class has been deprecated. The GML decoder, encoder and associated classes in this package are replaced by new decoders and encoders in the packages com.luciad.format.gml2.xml, com.luciad.format.gml31.xml and com.luciad.format.gml32.xml.

public class TLcdGMLModelList
extends java.lang.Object
implements ILcdModel

An implementation of ILcdModel used to represent a subset of a complete data set, such that only the selected subset will be exported by the GML model encoder. TLcdGMLModelList contains the following items for each feature type:

• The name of the given feature type;
• An ILcdModel containing all the features of the given type;
• An ILcdGMLFeatureIDRetriever for features of the given type;
• An array with the indices of the properties that need to be retained from the given feature type.

See Also:

Serialized Form

Nested Class Summary

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

ILcdModel.Query

Field Summary

Fields inherited from interface com.luciad.model.ILcdModel

FIRE_LATER, FIRE_NOW, NO_EVENT

Constructor Summary

Constructors

Constructor and Description
TLcdGMLModelList() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	addElement(java.lang.Object o, int i) Deprecated. Adds the specified element to this model.
void	addElements(java.util.Vector vector, int i) Deprecated. Adds all of the elements in the specified vector to this model.
void	addFeatureType(java.lang.String aTypeName, ILcdModel aModel, ILcdGMLFeatureIDRetriever aFeatureIDRetriever, int[] aPropertyIndices) Deprecated. Adds features of a given type to this model list.
void	addModelListener(ILcdModelListener aModelListener) Deprecated. Registers the specified model listener to receive notifications of model changes on this model.
boolean	canAddElement(java.lang.Object o) Deprecated. Returns true if the specified element can be added to this model, false otherwise.
boolean	canRemoveElement(java.lang.Object o) Deprecated. Returns true if the specified element can be removed from this model, false otherwise.
void	dispose() Deprecated. Disposes of this model and allows it to release any system resources that it is holding.
void	elementChanged(java.lang.Object o, int i) Deprecated. Notifies this model that the specified element has changed.
java.util.Enumeration	elements() Deprecated. Returns an enumeration over all elements of this model.
void	elementsChanged(java.util.Vector vector, int i) Deprecated. Notifies this model that the elements in the specified vector have changed.
void	fireCollectedModelChanges() Deprecated. Notifies all listeners that are registered on this model of all the changes that have been collected between the previous notification and now.
ILcdGMLFeatureIDRetriever	getFeatureIDRetriever(int aFeatureTypeIndex) Deprecated. Returns the feature ID retriever of the given submodel.
int	getFeatureTypeCount() Deprecated. Returns the number of feature types described by this TLcdGMLModelList.
java.lang.String	getFeatureTypeName(int aFeatureTypeIndex) Deprecated. Returns the feature type name of the given submodel.
ILcdModel	getModel(int aFeatureTypeIndex) Deprecated. Returns the submodel at the given index.
ILcdModelDescriptor	getModelDescriptor() Deprecated. Returns the ILcdModelDescriptor providing meta information about this model and its elements.
ILcdModelEncoder	getModelEncoder() Deprecated. Returns, if available, a model encoder that is capable of encoding this model, (encoder.canEncode(this)), null otherwise.
ILcdModelReference	getModelReference() Deprecated. Returns the model reference of the first submodel, or null if there are no submodels.
int[]	getSelectedPropertyIndices(int aFeatureTypeIndex) Deprecated. Returns the selected property indices of the given submodel.
void	removeAllElements(int i) Deprecated. Removes all elements from this model.
void	removeElement(java.lang.Object o, int i) Deprecated. Removes the specified element from this model.
void	removeElements(java.util.Vector vector, int i) Deprecated. Removes all of the elements in the specified vector from this model.
void	removeModelListener(ILcdModelListener aModelListener) Deprecated. Unregisters the specified model listener so that it no longer receives notifications of model changes on this model.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.luciad.model.ILcdModel

all, filter, getModelMetadata, query

Methods inherited from interface com.luciad.util.ILcdDisposable

close

Constructor Detail

TLcdGMLModelList

public TLcdGMLModelList()

Deprecated.

Method Detail

getFeatureTypeCount

public int getFeatureTypeCount()

Deprecated.

Returns the number of feature types described by this TLcdGMLModelList.

Returns:

the number of feature types described by this TLcdGMLModelList.

addFeatureType

public void addFeatureType(java.lang.String aTypeName,
                           ILcdModel aModel,
                           ILcdGMLFeatureIDRetriever aFeatureIDRetriever,
                           int[] aPropertyIndices)

Deprecated.

Adds features of a given type to this model list.

Parameters:

aTypeName - The name of the GML feature type being added.

aModel - An ILcdModel containing domain objects of the given feature type.

aFeatureIDRetriever - An ILcdGMLFeatureIDRetriever for the given feature type.

aPropertyIndices - An array specifying the indices of the properties that should be retained for the given feature type.

getFeatureTypeName

public java.lang.String getFeatureTypeName(int aFeatureTypeIndex)
                                    throws java.lang.IndexOutOfBoundsException

Deprecated.

Returns the feature type name of the given submodel.

Parameters:

aFeatureTypeIndex - The index of a submodel.

Returns:

the feature type name of the given submodel.

Throws:

java.lang.IndexOutOfBoundsException

getModel

public ILcdModel getModel(int aFeatureTypeIndex)
                   throws java.lang.IndexOutOfBoundsException

Deprecated.

Returns the submodel at the given index.

Parameters:

aFeatureTypeIndex - The index of a submodel.

Returns:

an ILcdModel.

Throws:

java.lang.IndexOutOfBoundsException

getFeatureIDRetriever

public ILcdGMLFeatureIDRetriever getFeatureIDRetriever(int aFeatureTypeIndex)
                                                throws java.lang.IndexOutOfBoundsException

Deprecated.

Returns the feature ID retriever of the given submodel.

Parameters:

aFeatureTypeIndex - The index of a submodel.

Returns:

an ILcdGMLFeatureIDRetriever.

Throws:

java.lang.IndexOutOfBoundsException

getSelectedPropertyIndices

public int[] getSelectedPropertyIndices(int aFeatureTypeIndex)
                                 throws java.lang.IndexOutOfBoundsException

Deprecated.

Returns the selected property indices of the given submodel.

Parameters:

aFeatureTypeIndex - The index of a submodel.

Returns:

an array of property indices.

Throws:

java.lang.IndexOutOfBoundsException

getModelReference

public ILcdModelReference getModelReference()

Deprecated.

Returns the model reference of the first submodel, or null if there are no submodels.

Specified by:

getModelReference in interface ILcdModel

Returns:

the model reference of the first submodel, or null if there are no submodels.

getModelDescriptor

public ILcdModelDescriptor getModelDescriptor()

Deprecated.

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()

Deprecated.

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.

elements

public java.util.Enumeration elements()

Deprecated.

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(java.lang.Object o,
                       int i)
                throws java.lang.IllegalArgumentException

Deprecated.

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:

o - the element to be added to this model.

i - the mode for sending out the model change event. This can be FIRE_LATER or NO_EVENT.

Throws:

java.lang.IllegalArgumentException

See Also:

ILcdModel.canAddElement(Object)

canAddElement

public boolean canAddElement(java.lang.Object o)

Deprecated.

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

Parameters:

o - the element to be verified.

Returns:

true if the specified element can be added to this model, false otherwise.

addElements

public void addElements(java.util.Vector vector,
                        int i)

Deprecated.

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:

vector - the vector of elements to be added to this model.

i - the mode for sending the model change events This can be FIRE_LATER or NO_EVENT.

See Also:

ILcdModel.canAddElement(Object)

removeElement

public void removeElement(java.lang.Object o,
                          int i)
                   throws java.lang.IllegalArgumentException

Deprecated.

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:

o - the element to be removed from this model.

i - the mode for sending out the model change event. This can be FIRE_LATER or NO_EVENT.

Throws:

java.lang.IllegalArgumentException

See Also:

ILcdModel.canRemoveElement(Object)

canRemoveElement

public boolean canRemoveElement(java.lang.Object o)

Deprecated.

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:

o - the element to be verified.

Returns:

true if the specified element can be removed from this model, false otherwise.

removeElements

public void removeElements(java.util.Vector vector,
                           int i)

Deprecated.

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:

vector - the vector of elements to be removed from this model.

i - 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 i)

Deprecated.

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:

i - the mode for sending out the model change event. This can be FIRE_LATER or NO_EVENT.

elementChanged

public void elementChanged(java.lang.Object o,
                           int i)

Deprecated.

Description copied from interface: ILcdModel

Notifies this model that the specified element has changed.

Specified by:

elementChanged in interface ILcdModel

Parameters:

o - the element that has changed.

i - the mode for sending out the model change event. This can be FIRE_LATER or NO_EVENT.

elementsChanged

public void elementsChanged(java.util.Vector vector,
                            int i)

Deprecated.

Description copied from interface: ILcdModel

Notifies this model that the elements in the specified vector have changed.

Specified by:

elementsChanged in interface ILcdModel

Parameters:

vector - the vector of elements that have changed.

i - the mode for sending out the model change event. This can be FIRE_LATER or NO_EVENT.

fireCollectedModelChanges

public void fireCollectedModelChanges()

Deprecated.

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

See Also:

ILcdModelListener.modelChanged(TLcdModelChangedEvent)

addModelListener

public void addModelListener(ILcdModelListener aModelListener)

Deprecated.

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

Parameters:

aModelListener - the ILcdModelListener to register on this model.

See Also:

ILcdModel.removeModelListener(com.luciad.model.ILcdModelListener), ILcdModelListener

removeModelListener

public void removeModelListener(ILcdModelListener aModelListener)

Deprecated.

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

Parameters:

aModelListener - the ILcdModelListener to remove.

See Also:

ILcdModel.addModelListener(com.luciad.model.ILcdModelListener), ILcdModelListener

dispose

public void dispose()

Deprecated.

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 ILcdDisposable