Package com.luciad.lucy.map

Class TLcyCompositeLayerStyleCodec

java.lang.Object

com.luciad.lucy.util.TLcyGenericComposite<TLcyLayerStyleCodecHolder>

com.luciad.lucy.map.TLcyCompositeLayerStyleCodec

All Implemented Interfaces:

ILcyLayerStyleCodec, Iterable<TLcyLayerStyleCodecHolder>

public class TLcyCompositeLayerStyleCodec
extends TLcyGenericComposite<TLcyLayerStyleCodecHolder>
implements ILcyLayerStyleCodec

Composite implementation of ILcyLayerStyleCodec.

Note: the ILcyLayerStyleCodecs are not directly registered as service to Lucy, but wrapped with a holder object. This holder object allows to register the ILcyLayerStyleCodec with some extra information like e.g. an ALcyFileTypeDescriptor. Using a back-end based TLcyCompositeLayerStyleCodec will only use the registered TLcyLayerStyleCodecHolder objects, and not for example an ILcyLayerStyleCodec which was directly (=not wrapped) registered as a service.

Since:

2012.0

See Also:

• TLcyGenericComposite

Field Summary

Fields inherited from class com.luciad.lucy.util.TLcyGenericComposite

PRIORITY_DEFAULT, PRIORITY_FALLBACK

Constructor Summary

Constructors

Constructor	Description
TLcyCompositeLayerStyleCodec()	Default constructor.
TLcyCompositeLayerStyleCodec(ILcyLucyEnv aLucyEnv)	Construct a TLcyCompositeLayerStyleCodec working on the Lucy back-end.

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

Methods inherited from class com.luciad.lucy.util.TLcyGenericComposite

add, add, getList, getPriority, iterator, remove

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

TLcyCompositeLayerStyleCodec

public TLcyCompositeLayerStyleCodec()

Default constructor. No ILcyLayerStyleCodecs are associated.

The created instance will only work on the ILcyLayerStyleCodec instances registered to it. If you want to use all registered ILcyLayerStyleCodec instances of the Lucy back-end, use TLcyCompositeLayerStyleCodec(com.luciad.lucy.ILcyLucyEnv) instead.

See Also:

• TLcyGenericComposite()
• TLcyCompositeLayerStyleCodec(com.luciad.lucy.ILcyLucyEnv)

TLcyCompositeLayerStyleCodec

public TLcyCompositeLayerStyleCodec(ILcyLucyEnv aLucyEnv)

Construct a TLcyCompositeLayerStyleCodec working on the Lucy back-end.

If you want to create a TLcyCompositeLayerStyleCodec which does not use the back-end, use TLcyCompositeLayerStyleCodec() instead.

Parameters:

aLucyEnv - The Lucy back-end

See Also:

• TLcyGenericComposite(com.luciad.lucy.ILcyLucyEnv, Class)
• TLcyCompositeLayerStyleCodec()

Method Details

getDisplayName

public String getDisplayName()

Description copied from interface: ILcyLayerStyleCodec

Returns the display name of this decoder

Specified by:

getDisplayName in interface ILcyLayerStyleCodec

Returns:

the display name of this decoder

canDecode

public boolean canDecode(ILcdLayer aLayer,
 ILcyLayerStyle aLayerStyle)

Description copied from interface: ILcyLayerStyleCodec

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

Specified by:

canDecode in interface ILcyLayerStyleCodec

Parameters:

aLayer - The layer from which aLayerStyle is retrieved

aLayerStyle - The layer style which will be adjusted in the ILcyLayerStyleCodec.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:

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

decode

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

Description copied from interface: ILcyLayerStyleCodec

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

Specified by:

decode in interface ILcyLayerStyleCodec

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

See Also:

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

canEncode

public boolean canEncode(ILcdLayer aLayer,
 ILcyLayerStyle aLayerStyle)

Description copied from interface: ILcyLayerStyleCodec

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

Specified by:

canEncode in interface ILcyLayerStyleCodec

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:

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

encode

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

Description copied from interface: ILcyLayerStyleCodec

Encodes the given ILcyLayerStyle to the given OutputStream.

Specified by:

encode in interface ILcyLayerStyleCodec

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

See Also:

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