com.luciad.earth.repository.codec

LuciadLightspeedClass TLcdEarthSeparateAlphaImageTileDataCodec

java.lang.Object

com.luciad.earth.repository.codec.TLcdEarthSeparateAlphaImageTileDataCodec

All Implemented Interfaces:

ILcdEarthTileDataCodec

public class TLcdEarthSeparateAlphaImageTileDataCodec
extends Object
implements ILcdEarthTileDataCodec

Tile data codec for BufferedImage objects. The images can be encoded to any format supported by the ImageIO package. This format will only be used to encode the opaque image data. The alpha channel is handled separately by this codec.

Typically the encoded format used with this codec either does not support an alpha channel or does not provide sufficient quality for an alpha channel (ex. jpeg).

Since:

9.1

Constructor Summary

Constructors

Constructor and Description
TLcdEarthSeparateAlphaImageTileDataCodec() Constructs and TLcdEarthSeparateAlphaImageTileDataCodec using the default format for the opaque image data (jpeg) and the default compression quality (0.9).
TLcdEarthSeparateAlphaImageTileDataCodec(String aFormat) Constructs and TLcdEarthSeparateAlphaImageTileDataCodec using the specified format for the opaque image data and the default compression quality.
TLcdEarthSeparateAlphaImageTileDataCodec(String aFormat, float aQuality) Constructs a new TLcdEarthSeparateAlphaImageTileDataCodec using the specified format for the opaque image data and the specified compression quality.

Method Summary

Modifier and Type	Method and Description
Object	decodeTileData(InputStream aSource) Decodes tile data from the given input stream.
void	encodeTileData(Object aTileData, OutputStream aDestination) Encodes tile data to the given output stream.
TLcdEarthTileFormat	getDecodedTileFormat() Returns the tile data format that this codec can encode or decode.
TLcdEarthTileFormat	getEncodedDataFormat() Returns the format in which this codec encodes data.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.luciad.earth.repository.codec.ILcdEarthTileDataCodec

encodeTile

Constructor Detail

TLcdEarthSeparateAlphaImageTileDataCodec

public TLcdEarthSeparateAlphaImageTileDataCodec()

Constructs and TLcdEarthSeparateAlphaImageTileDataCodec using the default format for the opaque image data (jpeg) and the default compression quality (0.9).

TLcdEarthSeparateAlphaImageTileDataCodec

public TLcdEarthSeparateAlphaImageTileDataCodec(String aFormat)

Constructs and TLcdEarthSeparateAlphaImageTileDataCodec using the specified format for the opaque image data and the default compression quality.

Parameters:

aFormat - the format that will be used to encode/decode the opaque image data. This format must be supported by the ImageIO package.

See Also:

ImageIO.getReaderFormatNames(), ImageIO.getWriterFormatNames()

TLcdEarthSeparateAlphaImageTileDataCodec

public TLcdEarthSeparateAlphaImageTileDataCodec(String aFormat,
                                                float aQuality)

Constructs a new TLcdEarthSeparateAlphaImageTileDataCodec using the specified format for the opaque image data and the specified compression quality.

Note that some ImageIO readers or writers may or may not support explicit compression settings.

Parameters:

aFormat - a format name that is supported by the ImageIO package

aQuality - a compression quality in [0,1]

See Also:

ImageIO.getReaderFormatNames(), ImageIO.getWriterFormatNames()

Method Detail

decodeTileData

public Object decodeTileData(InputStream aSource)
                      throws IOException

Description copied from interface: ILcdEarthTileDataCodec

Decodes tile data from the given input stream. The return value of this method must be an object of the type returned by ILcdEarthTileDataCodec.getDecodedTileFormat().

Specified by:

decodeTileData in interface ILcdEarthTileDataCodec

Parameters:

aSource - the input stream from which to read the tile data

Returns:

the decoded tile data

Throws:

IOException - if the tile data cannot be decoded

encodeTileData

public void encodeTileData(Object aTileData,
                           OutputStream aDestination)
                    throws IOException

Description copied from interface: ILcdEarthTileDataCodec

Encodes tile data to the given output stream. The aTileData parameter must be an object of the type returned by ILcdEarthTileDataCodec.getDecodedTileFormat().

Specified by:

encodeTileData in interface ILcdEarthTileDataCodec

Parameters:

aTileData - the tile data to be encoded

aDestination - the output stream to which to encode the tile data

Throws:

IOException - if the tile data cannot be encoded

getDecodedTileFormat

public TLcdEarthTileFormat getDecodedTileFormat()

Description copied from interface: ILcdEarthTileDataCodec

Returns the tile data format that this codec can encode or decode. The aTile parameter of encodeTileData() should always be of this type, as should the return value of decodeTileData().

Specified by:

getDecodedTileFormat in interface ILcdEarthTileDataCodec

Returns:

the format of the tile data type that this codec can encode or decode

getEncodedDataFormat

public TLcdEarthTileFormat getEncodedDataFormat()

Description copied from interface: ILcdEarthTileDataCodec

Returns the format in which this codec encodes data. An example could be "JPEG" or "PNG" for image data. The format is used in conjunction with ILcdEarthTileDataCodec.getDecodedTileFormat() to retrieve an appropriate tile data codec for any particular tile.

Specified by:

getEncodedDataFormat in interface ILcdEarthTileDataCodec

Returns:

a format in which this codec encodes data

toString

public String toString()

Overrides:

toString in class Object