com.luciad.format.gml

LuciadFusionClass TLcdGMLModelEncoder

java.lang.Object

com.luciad.format.gml.TLcdGMLModelEncoder

All Implemented Interfaces:

ILcdOutputStreamFactoryCapable, ILcdModelEncoder, Serializable

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 TLcdGMLModelEncoder
extends Object
implements ILcdModelEncoder, ILcdOutputStreamFactoryCapable

An ILcdModelEncoder that saves the model to GML format. The model descriptor must be an ILcdFeaturedDescriptor.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TLcdGMLModelEncoder() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	addNameSpace(String aPrefix, String aURI) Deprecated. Adds a name space to be included in the GML output.
boolean	canExport(ILcdModel aModel, String aSourceName) Deprecated. Returns whether this encoder can export the specified model to the specified destination.
boolean	canSave(ILcdModel aModel) Deprecated. Returns whether this model encoder can save the specified model to the location it originally came from.
void	export(ILcdModel aModel, String aSourceName) Deprecated. Encodes the given ILcdModel.
String	getDisplayName() Deprecated. Returns a short, displayable name for the format this ILcdModelEncoder encodes to.
ILcdModelReferenceEncoder	getModelReferenceEncoder() Deprecated. Returns the current model reference encoder.
ILcdOutputStreamFactory	getOutputStreamFactory() Deprecated. Returns the ILcdOutputStreamFactory used by the encoder to generate output.
boolean	isWriteModelReference() Deprecated. Returns true if the encoder is set to write the model reference.
boolean	isWriteSchema() Deprecated. Returns true if the encoder is set to write GML application schemas.
void	save(ILcdModel aModel) Deprecated. Saves the model to the location where it originally came from.
void	setDefaultNamespace(org.jdom.Namespace aNamespace) Deprecated.
void	setModelReferenceEncoder(ILcdModelReferenceEncoder aModelReferenceEncoder) Deprecated. Sets the model reference encoder to be used when setWriteModelReference() has been set to true.
void	setOutputStreamFactory(ILcdOutputStreamFactory aOutputStreamFactory) Deprecated. Sets an ILcdOutputStreamFactory for the encoder to use when generating output.
void	setSchemaURI(String aURI) Deprecated. Sets the schema URI to be written to the GML output.
void	setWriteModelReference(boolean aWriteModelReference) Deprecated. Specifies whether or not the encoder should create a model reference file.
void	setWriteSchema(boolean aWriteSchema) Deprecated. Specifies whether or not the encoder should create a GML application schema.
void	setXCoordinatesFirst(boolean aXCoordinatesFirst) Deprecated. Specifies whether the decoder should write coordinates in XY or YX order.

Methods inherited from class java.lang.Object

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

Constructor Detail

TLcdGMLModelEncoder

public TLcdGMLModelEncoder()

Deprecated.

Method Detail

setDefaultNamespace

public void setDefaultNamespace(org.jdom.Namespace aNamespace)

Deprecated.

setWriteSchema

public void setWriteSchema(boolean aWriteSchema)

Deprecated.

Specifies whether or not the encoder should create a GML application schema. If this is set to false, the user MUST specify a valid schema URI using the setSchemaURI() method. Without an application schema, the resulting GML will not be readable! If set to true, the encoder will create a .XSD file with the same name as the .GML file being created.

Parameters:

aWriteSchema - sets the new writeSchema property value.

See Also:

isWriteSchema()

isWriteSchema

public boolean isWriteSchema()

Deprecated.

Returns true if the encoder is set to write GML application schemas.

Returns:

true if the encoder is set to write GML application schemas. If false the user should have provided a valid schema URI.

See Also:

setWriteSchema(boolean)

setWriteModelReference

public void setWriteModelReference(boolean aWriteModelReference)

Deprecated.

Specifies whether or not the encoder should create a model reference file. If true, setModelReferenceEncoder() can be used to specify which encoder should be used to create this file. By default, TLcdModelReferenceEncoder is used.

Parameters:

aWriteModelReference - sets the new writeModelReference property value.

See Also:

isWriteModelReference()

isWriteModelReference

public boolean isWriteModelReference()

Deprecated.

Returns true if the encoder is set to write the model reference.

Returns:

true if the encoder is set to write the model reference, false otherwise.

See Also:

setWriteModelReference(boolean)

setModelReferenceEncoder

public void setModelReferenceEncoder(ILcdModelReferenceEncoder aModelReferenceEncoder)

Deprecated.

Sets the model reference encoder to be used when setWriteModelReference() has been set to true.

Parameters:

aModelReferenceEncoder - An ILcdModelReferenceEncoder.

See Also:

getModelReferenceEncoder()

getModelReferenceEncoder

public ILcdModelReferenceEncoder getModelReferenceEncoder()

Deprecated.

Returns the current model reference encoder.

Returns:

An ILcdModelReferenceEncoder.

See Also:

setModelReferenceEncoder(com.luciad.model.ILcdModelReferenceEncoder)

setOutputStreamFactory

public void setOutputStreamFactory(ILcdOutputStreamFactory aOutputStreamFactory)

Deprecated.

Sets an ILcdOutputStreamFactory for the encoder to use when generating output.

Specified by:

setOutputStreamFactory in interface ILcdOutputStreamFactoryCapable

Parameters:

aOutputStreamFactory - An ILcdOutputStreamFactory.

getOutputStreamFactory

public ILcdOutputStreamFactory getOutputStreamFactory()

Deprecated.

Returns the ILcdOutputStreamFactory used by the encoder to generate output.

Specified by:

getOutputStreamFactory in interface ILcdOutputStreamFactoryCapable

Returns:

the ILcdOutputStreamFactory used by the encoder to generate output.

canExport

public boolean canExport(ILcdModel aModel,
                         String aSourceName)

Deprecated.

Description copied from interface: ILcdModelEncoder

Returns whether this encoder can export the specified model to the specified destination. This method will typically check whether the contents of the specified model are compatible with the format this encoder is written for.

Specified by:

canExport in interface ILcdModelEncoder

Parameters:

aModel - the model to be verified.

aSourceName - the location where the model should be exported to.

Returns:

true if this encoder can export the specified model to the specified location, false otherwise.

See Also:

ILcdModelEncoder.export(com.luciad.model.ILcdModel, java.lang.String)

canSave

public boolean canSave(ILcdModel aModel)

Deprecated.

Description copied from interface: ILcdModelEncoder

Returns whether this model encoder can save the specified model to the location it originally came from. Often this will only be a simple test, for example checking the type of the model's model descriptor.

Specified by:

canSave in interface ILcdModelEncoder

Parameters:

aModel - the model to be verified.

Returns:

true if this encoder can save the model in the location where it originally came from, false otherwise.

See Also:

ILcdModelEncoder.save(com.luciad.model.ILcdModel)

addNameSpace

public void addNameSpace(String aPrefix,
                         String aURI)

Deprecated.

Adds a name space to be included in the GML output.

Parameters:

aPrefix - The prefix of the XML name space.

aURI - The URI of the XML name space.

setSchemaURI

public void setSchemaURI(String aURI)

Deprecated.

Sets the schema URI to be written to the GML output.

Parameters:

aURI - The full contents of the xsi:schemaLocation attribute.

export

public void export(ILcdModel aModel,
                   String aSourceName)
            throws IllegalArgumentException,
                   IOException

Deprecated.

Encodes the given ILcdModel. The model must have an ILcdFeaturedDescriptor unless it is either a TLcdModelList or a TLcdGMLModelList. In these cases, the submodels must have featured descriptors. In the case of a TLcdGMLModelList, the encoder will make use of the feature ID retrievers and the property index subsets associated with each of the submodels.

Specified by:

export in interface ILcdModelEncoder

Parameters:

aModel - the model to be exported.

aSourceName - the location where the model should be saved. Typically, this is a name for the output file, but it can also point to a file containing the required properties to create a set of data files.

Throws:

IllegalArgumentException - if the model cannot be saved by this encoder (!canExport(aModel, aDestinationName)).

IOException - if an I/O error occurs during encoding.

getDisplayName

public String getDisplayName()

Deprecated.

Description copied from interface: ILcdModelEncoder

Returns a short, displayable name for the format this ILcdModelEncoder encodes to.

Specified by:

getDisplayName in interface ILcdModelEncoder

Returns:

the displayable name of this ILcdModelEncoder.

save

public void save(ILcdModel aModel)
          throws IllegalArgumentException,
                 IOException

Deprecated.

Description copied from interface: ILcdModelEncoder

Saves the model to the location where it originally came from.

Specified by:

save in interface ILcdModelEncoder

Parameters:

aModel - the model to be saved.

Throws:

IllegalArgumentException - if the model cannot be saved by this encoder (!canSave(aModel)).

IOException - if an I/O error occurs during encoding.

setXCoordinatesFirst

public void setXCoordinatesFirst(boolean aXCoordinatesFirst)

Deprecated.

Specifies whether the decoder should write coordinates in XY or YX order.

Parameters:

aXCoordinatesFirst - If false, coordinates are written in YX order.