Package com.luciad.lucy.format

Class ALcyGeneralFormat

java.lang.Object

com.luciad.lucy.format.ALcyFormat

com.luciad.lucy.format.ALcyGeneralFormat

Direct Known Subclasses:

ALcyFileFormat

public abstract class ALcyGeneralFormat
extends ALcyFormat

Extension of ALcyFormat that works on general data formats (not necessarily files on disk), but provides some nice extras:

• it adds workspace support for models and domain objects.
• it adds an asynchronous hint paint provider. The behavior of this paint hint provider is based on the contents of the ALcyProperties instance passed in the constructor through the following key-value pairs:

     # Properties to configure the asynchronous paint hint provider (see ALcyFormat.getAsynchronousPaintHintProvider()).
     # Note that configuring the paint hint provider is not sufficient to enable asynchronous painting.
     # the format still needs to be wrapped with a TLcyAsynchronousFormatWrapper for asynchronous painting.
  
     # When true, it indicates that an async paint hint provider must be created
     propertyPrefix.asynchronous = true
     # String value for the TLcyAsynchronousPaintHint.getMergeGroup()
     propertyPrefix.asynchronous.mergeGroup = myMergeGroup
     # Boolean: when true, only the bodies are asynchronous. See TLcyAsynchronousPaintHint.isBodiesOnly()
     propertyPrefix.asynchronous.bodiesOnly = false
     # Integer: see TLcyAsynchronousPaintHint.getMinimumThreadPriority()
     propertyPrefix.asynchronous.minimumThreadPriority = 0
   

• it adds a label placement hint provider. The behavior of this label placement hint provider is based on the contents of the ALcyProperties instance passed in the constructor through the following key-value pairs:

     # Properties to configure the label placement hint provider (see ALcyFormat.getLabelPlacementHintProvider()).
  
     # String value for the TLcyGXYLabelPlacementHint.getLabelPlacementGroup()
     propertyPrefix.labelPlacementGroup = myLabelPlacementGroup
   

The format makes the following assumptions:

• There is an ILcdModelDecoder.
• The source name of the ILcdModelDescriptor of a decoded ILcdModel can again be provided to the ILcdModelDecoder to get the model back.
• If an ILcdModelEncoder is available, and when saving an ILcdModel under a different name using ILcdModel.getModelEncoder().export, the source name of the ILcdModelDescriptor of the ILcdModel is updated. This is usually only applicable for files, but not necessarily restricted to it.
• The order in which the domain objects are decoded in an ILcdModel is deterministic. It uses this information to for example remember the selected objects. If the order does change, it will not throw exceptions, but side effects such as incorrectly restoring the selection and warning messages could appear. Replacing the codecs created by createDomainObjectWorkspaceCodecs can remove this assumption.
• If the ILcdModelDecoder returns a TLcdModelList, that the sub-models are always in the same order for the same data source.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ALcyGeneralFormat(ILcyLucyEnv aLucyEnv, Class aClass, ALcyProperties aProperties)	Deprecated. Better use the constructor with explicit long and short prefix, to avoid any confusion.
protected	ALcyGeneralFormat(ILcyLucyEnv aLucyEnv, String aLongPrefix, String aShortPrefix, ALcyProperties aProperties)	Creates a ALcyGeneralFormat for the specified Lucy backend.
protected	ALcyGeneralFormat(ILcyLucyEnv aLucyEnv, String aLongPrefix, String aShortPrefix, ALcyProperties aProperties, String aPropertyPrefix)	Creates a ALcyGeneralFormat for the specified Lucy backend.

Method Summary

Modifier and Type	Method	Description
protected ILcyAsynchronousPaintHintProvider	createAsynchronousPaintHintProvider()	Creates a ILcyAsynchronousPaintHintProvider for this format.
protected ALcyWorkspaceObjectCodec[]	createDomainObjectWorkspaceCodecs()	Creates the ALcyWorkspaceObjectCodec that can encode and decode the ILcyCustomizerPanel instances for the domain objects produced by the model decoders of this format.
protected ILcyGXYLabelPlacementHintProvider	createLabelPlacementHintProvider()	Creates the ILcyLabelPlacementHintProvider that can create a TLcyGXYLabelPlacementHint for layers of this format.
protected ALcyWorkspaceObjectCodec[]	createModelWorkspaceCodecs()	Creates the ALcyWorkspaceObjectCodec codecs that can encode and decode the ILcdModel instances produces by the model decoders of this format.
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 ALcyFormat is associated.
ALcyProperties	getProperties()	Returns the ALcyProperties holding the configuration of this format.
String	getPropertyPrefix()	Returns the prefix that is used when deriving keys to retrieve configuration properties.
String	getShortPrefix()	Returns the short prefix of this format that can be used, for example, by the workspace codecs when writing information to the workspace.

Methods inherited from class com.luciad.lucy.format.ALcyFormat

createAll, createBalloonContentProviders, createDataPropertyValueCustomizerPanelFactories, createDataSourceHandlerFileTypeDescriptorGroups, createDataSourceHandlerFileTypeDescriptors, createDataSourceHandlers, createDefaultModelDescriptorFactories, createDomainObjectCustomizerPanelFactories, createDomainObjectCustomizerPanelWorkspaceCodecs, createFormatBarFactory, createGXYLayerCustomizerPanelFactories, createGXYLayerCustomizerPanelWorkspaceCodecs, createGXYLayerDecoderFileTypeDescriptors, createGXYLayerDecoders, createGXYLayerEncoderFileTypeDescriptors, createGXYLayerEncoders, createGXYLayerFactory, createGXYLayerOfFormatFilter, createGXYLayerSelectionTransferHandlers, createGXYLayerStyleProvider, createGXYLayerTypeProvider, createGXYLayerWorkspaceCodecs, createLayerContextOfFormatFilter, createLayerHeightProviderFactory, createLayerMeasureProviderFactory, createModelContentTypeProvider, createModelContextOfFormatFilter, createModelCustomizerPanelFactories, createModelCustomizerPanelWorkspaceCodecs, createModelDecoderFileTypeDescriptorGroups, createModelDecoderFileTypeDescriptors, createModelDecoders, createModelEncoderCustomizerPanelFactories, createModelEncoderCustomizerPanelWorkspaceCodecs, createModelEncoderFileTypeDescriptors, createModelEncoders, createModelFactory, createModelHeightProviderFactory, createModelMeasureProviderFactory, createModelMetaDataCustomizerPanelFactories, createModelMetaDataCustomizerPanelWorkspaceCodecs, createModelOfFormatFilter, getAsynchronousPaintHintProvider, getBalloonContentProviders, getDataPropertyValueCustomizerPanelFactories, getDataSourceHandlerFileTypeDescriptorGroups, getDataSourceHandlerFileTypeDescriptors, getDataSourceHandlers, getDefaultModelDescriptorFactories, getDomainObjectCustomizerPanelFactories, getDomainObjectCustomizerPanelWorkspaceCodecs, getDomainObjectWorkspaceCodecs, getFormatBarFactory, getGXYLayerCustomizerPanelFactories, getGXYLayerCustomizerPanelWorkspaceCodecs, getGXYLayerDecoderFileTypeDescriptors, getGXYLayerDecoders, getGXYLayerEncoderFileTypeDescriptors, getGXYLayerEncoders, getGXYLayerFactory, getGXYLayerSelectionTransferHandlers, getGXYLayerStyleProvider, getGXYLayerTypeProvider, getGXYLayerWorkspaceCodecs, getLabelPlacementHintProvider, getLayerHeightProviderFactory, getLayerMeasureProviderFactory, getModelContentTypeProvider, getModelCustomizerPanelFactories, getModelCustomizerPanelWorkspaceCodecs, getModelDecoderFileTypeDescriptorGroups, getModelDecoderFileTypeDescriptors, getModelDecoders, getModelEncoderCustomizerPanelFactories, getModelEncoderCustomizerPanelWorkspaceCodecs, getModelEncoderFileTypeDescriptors, getModelEncoders, getModelFactory, getModelHeightProviderFactory, getModelMeasureProviderFactory, getModelMetaDataCustomizerPanelFactories, getModelMetaDataCustomizerPanelWorkspaceCodecs, getModelWorkspaceCodecs, isGXYLayerOfFormat, isModelOfFormat, toString

Methods inherited from class java.lang.Object

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

Constructor Details

ALcyGeneralFormat

@Deprecated
protected ALcyGeneralFormat(ILcyLucyEnv aLucyEnv,
 Class aClass,
 ALcyProperties aProperties)

Deprecated.

Better use the constructor with explicit long and short prefix, to avoid any confusion. Functionally equivalent to ALcyGeneralFormat(aLucyEnv, ALcyTool.getLongPrefix(aClass), ALcyTool.getShortPrefix(aClass), aProperties).

Parameters:

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

aClass - A representative class for using this ALcyApplicationPaneTool, normally an extension of ALcyAddOn. It is used to retrieve the long and short prefixes using getLongPrefix and getShortPrefix. These prefixes are stored in workspace files, so if backward compatibility is a concern (e.g. read an old workspace file), the given class or its name must never change.

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

See Also:

• ALcyGeneralFormat(ILcyLucyEnv, String, String, ALcyProperties)

ALcyGeneralFormat

protected ALcyGeneralFormat(ILcyLucyEnv aLucyEnv,
 String aLongPrefix,
 String aShortPrefix,
 ALcyProperties aProperties)

Creates a ALcyGeneralFormat 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. This prefix will also be set as the property prefix and be used when reading values from aProperties. See getShortPrefix() and getPropertyPrefix(). Must not be null.

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

ALcyGeneralFormat

protected ALcyGeneralFormat(ILcyLucyEnv aLucyEnv,
 String aLongPrefix,
 String aShortPrefix,
 ALcyProperties aProperties,
 String aPropertyPrefix)

Creates a ALcyGeneralFormat 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.

aPropertyPrefix - The prefix to use when deriving keys to use for the ALcyProperties. Typically this is only different from aShortPrefix when the properties contain settings for multiple formats.

Method Details

getLucyEnv

public ILcyLucyEnv getLucyEnv()

Description copied from class: ALcyFormat

Returns the ILcyLucyEnv backend with which this ALcyFormat is associated.

Specified by:

getLucyEnv in class ALcyFormat

Returns:

The ILcyLucyEnv backend. Must not be null.

getLongPrefix

public String getLongPrefix()

Description copied from class: ALcyFormat

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 addon.

Specified by:

getLongPrefix in class ALcyFormat

Returns:

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

getShortPrefix

public String getShortPrefix()

Returns the short prefix of this format that can be used, for example, by the workspace codecs when writing information to the workspace. Typically this is the class name of add-on.

This prefix should not be used when you want to read values from the properties of this format. Use getPropertyPrefix() in that case.

Specified by:

getShortPrefix in class ALcyFormat

Returns:

the short prefix of this format

See Also:

• getPropertyPrefix()
• ALcyTool.getShortPrefix(Class)

getPropertyPrefix

public String getPropertyPrefix()

Returns the prefix that is used when deriving keys to retrieve configuration properties. Consult the class javadoc for more information.

Returns:

the prefix that is used to read properties from the getProperties() instance.

getProperties

public ALcyProperties getProperties()

Returns the ALcyProperties holding the configuration of this format. It's strongly recommended to use keys that start with a format specific property prefix.

Returns:

The ALcyProperties holding the configuration. Never null.

createAsynchronousPaintHintProvider

protected ILcyAsynchronousPaintHintProvider createAsynchronousPaintHintProvider()

Description copied from class: ALcyFormat

Creates a ILcyAsynchronousPaintHintProvider for this format.

Specified by:

createAsynchronousPaintHintProvider in class ALcyFormat

Returns:

A ILcyAsynchronousPaintHintProvider for the layers created by the layer factories of this format. May be null.

See Also:

• TLcySafeGuardFormatWrapper

createModelWorkspaceCodecs

protected ALcyWorkspaceObjectCodec[] createModelWorkspaceCodecs()

Description copied from class: ALcyFormat

Creates the ALcyWorkspaceObjectCodec codecs that can encode and decode the ILcdModel instances produces by the model decoders of this format.

Overrides:

createModelWorkspaceCodecs in class ALcyFormat

Returns:

An array containing the ALcyWorkspaceObjectCodec instances. Must not be null, but may have length 0. Must not contain null.

See Also:

• TLcySafeGuardFormatWrapper

createDomainObjectWorkspaceCodecs

protected ALcyWorkspaceObjectCodec[] createDomainObjectWorkspaceCodecs()

Description copied from class: ALcyFormat

Creates the ALcyWorkspaceObjectCodec that can encode and decode the ILcyCustomizerPanel instances for the domain objects produced by the model decoders of this format.

Overrides:

createDomainObjectWorkspaceCodecs in class ALcyFormat

Returns:

An array of ALcyWorkspaceObjectCodec instances. Must not be null but may have length 0. Must not contain null.

See Also:

• TLcySafeGuardFormatWrapper

createLabelPlacementHintProvider

protected ILcyGXYLabelPlacementHintProvider createLabelPlacementHintProvider()

Creates the ILcyLabelPlacementHintProvider that can create a TLcyGXYLabelPlacementHint for layers of this format.

This implementation return an ILcyLabelPlacementHintProvider that creates a TLcyGXYLabelPlacementHint containing a labeling group. The labeling group is read from the format's configuration file.

Overrides:

createLabelPlacementHintProvider in class ALcyFormat

Returns:

An ILcyLabelPlacementHintProvider.

See Also:

• TLcySafeGuardFormatWrapper