com.luciad.format.kml22.xml

LuciadLightspeedClass TLcdKML22ModelEncoder

java.lang.Object

com.luciad.format.kml22.xml.TLcdKML22ModelEncoder

All Implemented Interfaces:

ILcdOutputStreamFactoryCapable, ILcdModelEncoder, Serializable

public final class TLcdKML22ModelEncoder
extends Object
implements ILcdModelEncoder, ILcdOutputStreamFactoryCapable

ILcdModelEncoder implementation to convert a KML 2.2 model to a KML file. The main purpose of this model encoder is to save KML models made programmatically, from a custom conversion process for example.

Limitations

• This model encoder doesn't export other models into KML files.
• This model encoder does not support kmz extension.
• This model encoder was not made for round-trips and KML models don't have a reference to this model encoder.
• Relative network links will not be modified and this model encoder will not copy their target contents.

Since:

2015.1

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TLcdKML22ModelEncoder() Default constructor for TLcdKML22ModelEncoder.

Method Summary

Modifier and Type	Method and Description
boolean	canExport(ILcdModel aModel, String aDestinationName) Returns whether a ILcdModel can be exported to a KML file.
boolean	canSave(ILcdModel aModel) Returns whether a ILcdModel can be saved.
void	export(ILcdModel aModel, String aDestinationName) Exports the specified model to the specified destination.
String	getDisplayName() Returns a short, displayable name for the format this ILcdModelEncoder encodes to.
ILcdOutputStreamFactory	getOutputStreamFactory() Returns the output stream factory that is used.
void	save(ILcdModel aModel) Saves the model to the location where it originally came from.
void	setOutputStreamFactory(ILcdOutputStreamFactory aOutputStreamFactory) Sets the output stream factory to be used.

Methods inherited from class java.lang.Object

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

Constructor Detail

TLcdKML22ModelEncoder

public TLcdKML22ModelEncoder()

Default constructor for TLcdKML22ModelEncoder.

Method Detail

getDisplayName

public String getDisplayName()

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.

canSave

public boolean canSave(ILcdModel aModel)

Returns whether a ILcdModel can be saved.

Specified by:

canSave in interface ILcdModelEncoder

Parameters:

aModel - the model to be verified.

Returns:

true if the model is a KML model.

See Also:

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

save

public void save(ILcdModel aModel)
          throws IllegalArgumentException,
                 IOException

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.

canExport

public boolean canExport(ILcdModel aModel,
                         String aDestinationName)

Returns whether a ILcdModel can be exported to a KML file.

Specified by:

canExport in interface ILcdModelEncoder

Parameters:

aModel - the model to be verified.

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

Returns:

true if the model is a KML model and the destination is valid.

See Also:

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

export

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

Description copied from interface: ILcdModelEncoder

Exports the specified model to the specified destination.

Specified by:

export in interface ILcdModelEncoder

Parameters:

aModel - the model to be exported.

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

setOutputStreamFactory

public void setOutputStreamFactory(ILcdOutputStreamFactory aOutputStreamFactory)

Description copied from interface: ILcdOutputStreamFactoryCapable

Sets the output stream factory to be used.

Specified by:

setOutputStreamFactory in interface ILcdOutputStreamFactoryCapable

Parameters:

aOutputStreamFactory - the output stream factory to be used.

getOutputStreamFactory

public ILcdOutputStreamFactory getOutputStreamFactory()

Description copied from interface: ILcdOutputStreamFactoryCapable

Returns the output stream factory that is used.

Specified by:

getOutputStreamFactory in interface ILcdOutputStreamFactoryCapable

Returns:

the output stream factory that is used.