com.luciad.lucy.util.properties.codec

LuciadLightspeedClass ALcyWorkspacePropertyConverter

java.lang.Object

com.luciad.lucy.util.properties.codec.ALcyWorkspacePropertyConverter

All Implemented Interfaces:

ILcyPropertyConverter

Direct Known Subclasses:

ALcyPreferencesPropertyConverter

public abstract class ALcyWorkspacePropertyConverter
extends Object
implements ILcyPropertyConverter

Abstract base class that can use the ALcyWorkspaceCodec to encode paths and reference to Objects. This way these ILcyPropertyConverter converters can convert general Objects to their workspace reference Strings.

Constructor Summary

Constructors

Constructor and Description
ALcyWorkspacePropertyConverter()

Method Summary

Modifier and Type	Method and Description
void	convertAfterDecode(ALcyProperties aPropertiesSFCT) Modifies the given ALcyProperties so that String properties representing Objects are converted to these Objects.
abstract void	convertAfterDecode(ALcyWorkspaceCodec aWSCodec, ALcyProperties aPropertiesSFCT) Serves the same purpose as ILcyPropertyConverter.convertAfterDecode(com.luciad.lucy.util.properties.ALcyProperties), but gives access to the ALcyWorkspaceCodec.
void	convertBeforeEncode(ALcyProperties aPropertiesSFCT) Modifies the given ALcyProperties so that all Object values are converted to one or more String values.
abstract void	convertBeforeEncode(ALcyWorkspaceCodec aWSCodec, ALcyProperties aPropertiesSFCT) Serves the same purpose as ILcyPropertyConverter.convertBeforeEncode(com.luciad.lucy.util.properties.ALcyProperties), but gives access to the ALcyWorkspaceCodec.
protected abstract ALcyWorkspaceCodec	getWorkspaceCodec() Returns the current ALcyWorkspaceCodec.

Methods inherited from class java.lang.Object

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

Constructor Detail

ALcyWorkspacePropertyConverter

public ALcyWorkspacePropertyConverter()

Method Detail

convertAfterDecode

public final void convertAfterDecode(ALcyProperties aPropertiesSFCT)

Description copied from interface: ILcyPropertyConverter

Modifies the given ALcyProperties so that String properties representing Objects are converted to these Objects.

This method should remove the String properties from which it constructs the Object. Only the Object property should remain.

Specified by:

convertAfterDecode in interface ILcyPropertyConverter

Parameters:

aPropertiesSFCT - The properties to modify.

convertBeforeEncode

public final void convertBeforeEncode(ALcyProperties aPropertiesSFCT)

Description copied from interface: ILcyPropertyConverter

Modifies the given ALcyProperties so that all Object values are converted to one or more String values.

This method should remove the original Object that it encodes. Only the String property or properties should remain.

Specified by:

convertBeforeEncode in interface ILcyPropertyConverter

Parameters:

aPropertiesSFCT - The ALcyProperties to modify. Never null.

getWorkspaceCodec

protected abstract ALcyWorkspaceCodec getWorkspaceCodec()

Returns the current ALcyWorkspaceCodec.

Note that implementations are discouraged to retrieve the workspace codec from the workspace manager of the Lucy backend, as it is not guaranteed that the workspace codec given to codec delegates and object codecs is the same as the workspace codec of the workspace manager of the Lucy backend. Instead the ALcyWorkspaceCodec should be the one that is passed to an ALcyWorkspaceObjectCodec or ALcyWorkspaceCodecDelegate.

Returns:

The ALcyWorkspaceCodec to pass to convertBeforeEncode and convertAfterDecode.

convertBeforeEncode

public abstract void convertBeforeEncode(ALcyWorkspaceCodec aWSCodec,
                                         ALcyProperties aPropertiesSFCT)

Serves the same purpose as ILcyPropertyConverter.convertBeforeEncode(com.luciad.lucy.util.properties.ALcyProperties), but gives access to the ALcyWorkspaceCodec.

Parameters:

aWSCodec - The current ALcyWorkspaceCodec. May be null.

aPropertiesSFCT - The ALcyProperties to convert. Never null.

See Also:

convertBeforeEncode(com.luciad.lucy.util.properties.ALcyProperties)

convertAfterDecode

public abstract void convertAfterDecode(ALcyWorkspaceCodec aWSCodec,
                                        ALcyProperties aPropertiesSFCT)

Serves the same purpose as ILcyPropertyConverter.convertAfterDecode(com.luciad.lucy.util.properties.ALcyProperties), but gives access to the ALcyWorkspaceCodec.

Parameters:

aWSCodec - The current ALcyWorkspaceCodec. May be null.

aPropertiesSFCT - The ALcyProperties to convert. Never null.

See Also:

convertAfterDecode(com.luciad.lucy.util.properties.ALcyProperties)