Package com.luciad.lucy.map

Interface ILcyLayerStyleCodec

All Known Implementing Classes:

TLcyCompositeLayerStyleCodec

public interface ILcyLayerStyleCodec

This interface models a codec (encoder/decoder) for ILcyLayerStyle objects. The codec is responsible for storing ILcyLayerStyle objects to some (persistent) storage, and to restore the ILcyLayerStyle objects later on from that (persistent) storage.

This functionality is currently only supported for Lightspeed layers.

Since:

2012.0

Method Summary

Modifier and Type	Method	Description
boolean	canDecode(ILcdLayer aLayer, ILcyLayerStyle aLayerStyle)	Returns true when this codec is capable of adjusting the state of aLayerStyle to match the settings stored in some (persistent) storage.
boolean	canEncode(ILcdLayer aLayer, ILcyLayerStyle aLayerStyle)	Returns true if the given ILcyLayerStyle, retrieved from aLayer, can be encoded by this codec.
void	decode(ILcdLayer aLayer, ILcyLayerStyle aLayerStyleSFCT, InputStream aInputStream)	Adjusts the settings of aLayerStyleSFCT to match those stored in aInputStream.
void	encode(ILcdLayer aLayer, ILcyLayerStyle aLayerStyle, OutputStream aOutputStream)	Encodes the given ILcyLayerStyle to the given OutputStream.
String	getDisplayName()	Returns the display name of this decoder

Method Details

getDisplayName

String getDisplayName()

Returns the display name of this decoder

Returns:

the display name of this decoder

canDecode

boolean canDecode(ILcdLayer aLayer,
 ILcyLayerStyle aLayerStyle)

Returns true when this codec is capable of adjusting the state of aLayerStyle to match the settings stored in some (persistent) storage.

Parameters:

aLayer - The layer from which aLayerStyle is retrieved

aLayerStyle - The layer style which will be adjusted in the decode(com.luciad.view.ILcdLayer, ILcyLayerStyle, java.io.InputStream) method with the stored settings

Returns:

true when this decoder is capable of adjusting the state of aLayerStyle to match the settings stored in some (persistent) storage

See Also:

• decode(com.luciad.view.ILcdLayer, ILcyLayerStyle, java.io.InputStream)

decode

void decode(ILcdLayer aLayer,
 ILcyLayerStyle aLayerStyleSFCT,
 InputStream aInputStream)
     throws IOException,
UnsupportedOperationException

Adjusts the settings of aLayerStyleSFCT to match those stored in aInputStream.

Parameters:

aLayer - The layer from which aLayerStyleSFCT is retrieved

aLayerStyleSFCT - The layer style of which the settings must be adjusted to match those stored in aInputStream

aInputStream - The input stream from which the settings can be read

Throws:

IOException - in case of IO failure

UnsupportedOperationException - when canDecode returns false for the same layer and layer style

See Also:

• canDecode(com.luciad.view.ILcdLayer, ILcyLayerStyle)

canEncode

boolean canEncode(ILcdLayer aLayer,
 ILcyLayerStyle aLayerStyle)

Returns true if the given ILcyLayerStyle, retrieved from aLayer, can be encoded by this codec.

Parameters:

aLayer - The layer from which aLayerStyle is retrieved

aLayerStyle - The style of the aLayer

Returns:

true if aLayerStyle can be encoded by this codec

See Also:

• encode(com.luciad.view.ILcdLayer, ILcyLayerStyle, java.io.OutputStream)

encode

void encode(ILcdLayer aLayer,
 ILcyLayerStyle aLayerStyle,
 OutputStream aOutputStream)
     throws IOException,
UnsupportedOperationException

Encodes the given ILcyLayerStyle to the given OutputStream.

Parameters:

aLayer - The layer from which aLayerStyle is retrieved

aLayerStyle - The style of the aLayer

aOutputStream - The output stream to which the style must be encoded.

Throws:

IOException - in case of IO failure

UnsupportedOperationException - when canEncode returns false for the same layer and layer style

See Also:

• canEncode(com.luciad.view.ILcdLayer, ILcyLayerStyle)