com.luciad.lucy.format.lightspeed

LuciadLightspeedClass ALcyLspGeneralFormat

java.lang.Object

com.luciad.lucy.format.lightspeed.ALcyLspFormat

com.luciad.lucy.format.lightspeed.ALcyLspGeneralFormat

Direct Known Subclasses:

ALcyLspStyleFileFormat

public abstract class ALcyLspGeneralFormat
extends ALcyLspFormat

Extension of ALcyLspFormat that works with a properties object holding the configuration of the format. It also adds a short prefix (e.g. to derive keys for the configuration properties), and a long prefix (e.g. to derive UID's for workspace codecs).

Since:

2012.0

Constructor Summary

Constructors

Constructor and Description
ALcyLspGeneralFormat(ILcyLucyEnv aLucyEnv, String aLongPrefix, String aShortPrefix, ALcyProperties aProperties) Creates a ALcyLspGeneralFormat for the specified Lucy backend.

Method Summary

Modifier and Type	Method and Description
String	getLongPrefix() Returns the long prefix of this format that can be used, for instance, to derive UID's.
ILcyLucyEnv	getLucyEnv() Returns the ILcyLucyEnv backend with which this ALcyLspFormat is associated.
ALcyProperties	getProperties() Returns the ALcyProperties holding the configuration of this format.
String	getShortPrefix() Returns the short prefix of this format that can be used, for instance, to derive keys for a ALcyProperties instance.

Methods inherited from class com.luciad.lucy.format.lightspeed.ALcyLspFormat

canHandleModel, checkInitialized, createAll, createBalloonContentProviders, createFormatBarFactory, createLayerContextOfFormatFilter, createLayerCustomizerPanelFactories, createLayerCustomizerPanelWorkspaceCodecs, createLayerFactory, createLayerMeasureProviderFactory, createLayerSelectionTransferHandlers, createLayerStyleCodecFileTypeDescriptors, createLayerStyleCodecs, createLayerStyleProviders, createLayerWorkspaceCodecs, getBalloonContentProviders, getFormatBarFactory, getLayerCustomizerPanelFactories, getLayerCustomizerPanelWorkspaceCodecs, getLayerFactory, getLayerMeasureProviderFactory, getLayerSelectionTransferHandlers, getLayerStyleCodecFileTypeDescriptors, getLayerStyleCodecs, getLayerStyleProviders, getLayerWorkspaceCodecs, isLayerOfFormat, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ALcyLspGeneralFormat

public ALcyLspGeneralFormat(ILcyLucyEnv aLucyEnv,
                            String aLongPrefix,
                            String aShortPrefix,
                            ALcyProperties aProperties)

Creates a ALcyLspGeneralFormat for the specified Lucy backend.

Parameters:

aLucyEnv - The Lucy backend for which to create this format. Must not be null.

aLongPrefix - The long prefix of this format. See getLongPrefix(). Must not be null.

aShortPrefix - The short prefix of this format. See getShortPrefix() Must not be null.

aProperties - The ALcyProperties instance holding the configuration for this format. Must not be null.

Method Detail

getLucyEnv

public ILcyLucyEnv getLucyEnv()

Description copied from class: ALcyLspFormat

Returns the ILcyLucyEnv backend with which this ALcyLspFormat is associated.

Specified by:

getLucyEnv in class ALcyLspFormat

Returns:

The ILcyLucyEnv backend. Must not be null.

getProperties

public ALcyProperties getProperties()

Returns the ALcyProperties holding the configuration of this format.

Returns:

The ALcyProperties of this format. Never null.

getLongPrefix

public String getLongPrefix()

Description copied from class: ALcyLspFormat

Returns the long prefix of this format that can be used, for instance, to derive UID's. Typically this would be the fully qualified name of the add-on.

Specified by:

getLongPrefix in class ALcyLspFormat

Returns:

The long prefix that can be used to generate UID's. Must not be null.

See Also:

ALcyTool.getLongPrefix(Class)

getShortPrefix

public String getShortPrefix()

Description copied from class: ALcyLspFormat

Returns the short prefix of this format that can be used, for instance, to derive keys for a ALcyProperties instance. This would typically be the short class name of the add-on.

Specified by:

getShortPrefix in class ALcyLspFormat

Returns:

The short prefix of this format. Must not be null.

See Also:

ALcyTool.getShortPrefix(Class)