com.luciad.format.gdf

Graph and Routing EngineClass TLcdGDFMultiLevelTiledModelEncoder

java.lang.Object

com.luciad.format.gdf.TLcdGDFMultiLevelTiledModelEncoder

All Implemented Interfaces:

ILcdOutputStreamFactoryCapable, ILcdModelEncoder, Serializable

public class TLcdGDFMultiLevelTiledModelEncoder
extends Object
implements ILcdModelEncoder, ILcdOutputStreamFactoryCapable

This ILcdModelEncoder encodes GDF multilevel, tiled models.

Since:

5.1

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TLcdGDFMultiLevelTiledModelEncoder()

Method Summary

Modifier and Type	Method and Description
boolean	canExport(ILcdModel aModel, String s) Returns whether this encoder can export the specified model to the specified destination.
boolean	canSave(ILcdModel aModel) Returns whether this model encoder can save the specified model to the location it originally came from.
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

TLcdGDFMultiLevelTiledModelEncoder

public TLcdGDFMultiLevelTiledModelEncoder()

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)

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)

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

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.

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

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.

export

public void export(ILcdModel aModel,
                   String aDestinationName)
            throws 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:

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