com.luciad.format.gml

LuciadFusionClass TLcdGMLModelDecoder

java.lang.Object

com.luciad.format.gml.TLcdGMLModelDecoder

All Implemented Interfaces:

ILcdInputStreamFactoryCapable, ILcdModelDecoder

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.

@Deprecated
public class TLcdGMLModelDecoder
extends Object
implements ILcdModelDecoder, ILcdInputStreamFactoryCapable

Class to decode a GML file to a ILcdModel. The GML file must follow the "OpenGIS Geography Markup Language (GML) Implementation Specification, version 2.1.2" (https://portal.opengeospatial.org/files/?artifact_id=11339) of 17 september 2002.

The default implementation for decoding the model reference is done by using a second file. The second GML file containing the model reference must follow the specifications recommended by "Recommended Definition Data for Coordinate Reference Systems and Coordinate Transformations" (http://www.opengis.org/techno/specs/01-014r3.pdf) from 25th april 2001. If the GML file name is "name.gml", the file containing the model reference shall have be "name_ref.gml". This decoder can decode:

• MultiGeometry (ILcdShapeList)
• MultiPoint (ILcdShapeList)
• MultiLine (ILcdShapeList)
• MultiPolygon (ILcdComplexPolygon)
• Polygon (ILcdPolygon)
• Box(ILcdBounds)
• LinearRing (ILcdPolygon)
• LineString (ILcdPolyline)

The application schema describing the document is obligatory. This schema is used to decode the features and feature names:

• The first element in the xml-file that has the following attribute is considered to be the collection that contains all the elements: substitutionGroup="gml:_FeatureCollection"
• The first element in the xml-file that has the following attribute is considered to be the element that should be parsed to a domain-object and contains a geometry and features: substitutionGroup="gml:_Feature"
• Then all element-tags are checked to be a substitution for "gml:_geometryProperty". This step searches recursively for other imported schemas. All other element-tags contained by the "_Feature"-extension are considered features of that object.

This class requires a JAXP 1.1 compliant XML parser implementation. JDOM is used to handle the XML Schema definition.

Constructor Summary

Constructors

Constructor and Description
TLcdGMLModelDecoder() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	addGMLModelObjectFactory(String aFeatureName, ILcdGMLModelObjectFactory aGMLModelObjectFactory) Deprecated. Adds a model object factory to the decoder.
boolean	canDecodeSource(String aSource) Deprecated. Checks whether a ILcdModel can be decode from given data.
ILcdModel	decode(InputStream aInput) Deprecated. Creates a new ILcdModel from the given InputStream.
ILcdModel	decode(String aSource) Deprecated. Creates a new ILcdModel from the given data.
String	getDisplayName() Deprecated. Gets the display name of the decoder.
ILcdInputStreamFactory	getInputStreamFactory() Deprecated. Returns the current ILcdInputStreamFactory.
ILcdModelReferenceDecoder	getModelReferenceDecoder() Deprecated. Returns the ILcdModelReferenceDecoder used to load the GML file's model reference.
void	removeGMLModelObjectFactory(String aFeatureName) Deprecated. Removes a model object factory from the decoder.
static void	setClassTraceOn(boolean aClassTraceOn) Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
void	setInputStreamFactory(ILcdInputStreamFactory aInputStreamFactory) Deprecated. Sets aInputStreamFactory as ILcdInputStreamFactory on this TLcdGMLModelDecoder.
void	setModelReferenceDecoder(ILcdModelReferenceDecoder aModelReferenceDecoder) Deprecated. Sets the ILcdModelReferenceDecoder used to load the GML file's model reference.
void	setReadCoordinatesAsXY(boolean aBoolean) Deprecated. Set a boolean to indicate how to read the coordinates: first X and the Y or first Y and then X.

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.ILcdModelDecoder

canDecodeSource, decodeModelMetadata, decodeModelMetadata, decodeSource, discoverDataSources

Constructor Detail

TLcdGMLModelDecoder

public TLcdGMLModelDecoder()

Deprecated.

Method Detail

getDisplayName

public String getDisplayName()

Deprecated.

Gets the display name of the decoder.

Specified by:

getDisplayName in interface ILcdModelDecoder

Returns:

the displayable name of this ILcdModelDecoder.

setClassTraceOn

public static void setClassTraceOn(boolean aClassTraceOn)

Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.

Enables tracing for all instances of this class. If the argument is true then all log messages are recorded, otherwise only the informative, warning and error messages are recorded.

Parameters:

aClassTraceOn - if true then all log messages are recorded, otherwise only the informative, warning and error messages are recorded.

setReadCoordinatesAsXY

public void setReadCoordinatesAsXY(boolean aBoolean)

Deprecated.

Set a boolean to indicate how to read the coordinates: first X and the Y or first Y and then X.

Parameters:

aBoolean - , when true coordinates expected to be x,y else expected to be y,x .

getModelReferenceDecoder

public ILcdModelReferenceDecoder getModelReferenceDecoder()

Deprecated.

Returns the ILcdModelReferenceDecoder used to load the GML file's model reference.

Returns:

an ILcdModelReferenceDecoder

See Also:

setModelReferenceDecoder(com.luciad.model.ILcdModelReferenceDecoder)

setModelReferenceDecoder

public void setModelReferenceDecoder(ILcdModelReferenceDecoder aModelReferenceDecoder)

Deprecated.

Sets the ILcdModelReferenceDecoder used to load the GML file's model reference.

Parameters:

aModelReferenceDecoder - an ILcdModelReferenceDecoder

See Also:

getModelReferenceDecoder()

addGMLModelObjectFactory

public void addGMLModelObjectFactory(String aFeatureName,
                                     ILcdGMLModelObjectFactory aGMLModelObjectFactory)

Deprecated.

Adds a model object factory to the decoder.

Parameters:

aFeatureName - The feature name for which this model object factory is to be used.

aGMLModelObjectFactory - An ILcdGMLModelObjectFactory.

removeGMLModelObjectFactory

public void removeGMLModelObjectFactory(String aFeatureName)

Deprecated.

Removes a model object factory from the decoder.

Parameters:

aFeatureName - The feature name for which the model object factory is to be removed.

canDecodeSource

public boolean canDecodeSource(String aSource)

Deprecated.

Checks whether a ILcdModel can be decode from given data.

Specified by:

canDecodeSource in interface ILcdModelDecoder

Parameters:

aSource - the data source

Returns:

true if this decoder can decode the data specified by the source name, false otherwise.

See Also:

ILcdModelDecoder.decode(String), ILcdModelDecoder.decodeModelMetadata(String)

decode

public ILcdModel decode(InputStream aInput)
                 throws IOException

Deprecated.

Creates a new ILcdModel from the given InputStream. The model reference must be provided externally, before this method is called. Note that when using this method, the location of the source data is unknown. Hence, the GML data should either refer to a schema that can be found in the classpath, or specify a fully-qualified file name or URL for the schema. If the schema cannot be found, no data will be decoded!

Parameters:

aInput - the InputStream from which to read the model data.

Returns:

a model containing the decoded data.

Throws:

IOException - when an I/O error occurs or when the input could not be parsed.

decode

public ILcdModel decode(String aSource)
                 throws IOException

Deprecated.

Creates a new ILcdModel from the given data. The model reference must be provided externally, before this method is called.

Specified by:

decode in interface ILcdModelDecoder

Parameters:

aSource - the data source.

Returns:

a model containing the decoded data.

Throws:

IOException - when an I/O error occurs or when the source file could not be parsed.

InterruptedIOException - When the thread on which this method is called is interrupted: it is recommended to stop the decoding and throw an InterruptedIOException. This same exception can also be used if the decoder shows UI to the user, and the user cancels the decoding through the UI.

See Also:

ILcdModelDecoder.canDecodeSource(String)

setInputStreamFactory

public void setInputStreamFactory(ILcdInputStreamFactory aInputStreamFactory)

Deprecated.

Sets aInputStreamFactory as ILcdInputStreamFactory on this TLcdGMLModelDecoder. aInputStreamFactory is then used for retrieving InputStream objects when decoding a GML document and its associated application schema. To use the default way of creating an InputStream, leave this property unset.

Specified by:

setInputStreamFactory in interface ILcdInputStreamFactoryCapable

Parameters:

aInputStreamFactory - the factory used to retrieve input streams from the sources.

getInputStreamFactory

public ILcdInputStreamFactory getInputStreamFactory()

Deprecated.

Returns the current ILcdInputStreamFactory.

Specified by:

getInputStreamFactory in interface ILcdInputStreamFactoryCapable

Returns:

the current ILcdInputStreamFactory.