ALcyFormat (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.lucy.format.ALcyFormat

Direct Known Subclasses:

ALcyFormatWrapper, ALcyGeneralFormat
```
public abstract class ALcyFormat
extends Object
```
This class provides the basic support facilities for adding another data format to Lucy. It defines factory methods, some abstract, some with a default implementation, that clients are supposed to implement for their specific data format. For instance there is a factory method for the model decoder and layer factory.

The createAll method calls all the factory methods and checks whether the created objects follow the documented rules. After this method has been called, all the created objects can be retrieved with the appropriate getters.

None of the implementations of the factory methods are expected to register the created objects with the Lucy backend. For that you are advised to use the TLcyFormatTool.

You are encouraged to only implement the core functionality of your format into a subclass of this ALcyFormat, and use one or more ALcyFormatWrapper wrappers to enable common functionality. For instance, the TLcyAsynchronousFormatWrapper can enable asynchronous painting for a certain ALcyFormat by wrapping that format.

You are discouraged to subclass this class directly, rather use one of the more specific extensions such as ALcyGeneralFormat.

See Also:

ALcyFormatWrapper, TLcyFormatTool

Constructor Summary

Constructors
Modifier Constructor and Description

protected ALcyFormat()
Creates a new ALcyFormat.

Constructors
Modifier	Constructor and Description
`protected`	`ALcyFormat()` Creates a new `ALcyFormat`.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`createAll()` Creates all the instances of the concepts of this class by calling all the abstract factory methods, and performs some validity checks on the created values.
`protected abstract ILcyAsynchronousPaintHintProvider`	`createAsynchronousPaintHintProvider()` Creates a `ILcyAsynchronousPaintHintProvider` for this format.
`protected ILcdBalloonContentProvider[]`	`createBalloonContentProviders()` Creates the `ILcdBalloonContentProvider`s for this format.
`protected ILcyCustomizerPanelFactory[]`	`createDataPropertyValueCustomizerPanelFactories()` Creates the `ILcyCustomizerPanelFactory` factories that can create `ILcyCustomizerPanel` instances to change the value of a single data property of the domain objects created by the model decoders of this format.
`protected String[][]`	`createDataSourceHandlerFileTypeDescriptorGroups()` Creates file type descriptor groups for all decoders.
`protected ALcyFileTypeDescriptor[]`	`createDataSourceHandlerFileTypeDescriptors()` Creates the `ALcyFileTypeDescriptor` instances corresponding to the `ALcyFileTypeDescriptor` instances created by this format.
`protected ALcyDataSourceHandler[]`	`createDataSourceHandlers()` Creates `ALcyDataSourceHandler`(s) that are more general than `ALcyFileTypeDescriptor`s.
`protected ALcyDefaultModelDescriptorFactory[]`	`createDefaultModelDescriptorFactories()` Creates the `ALcyDefaultModelDescriptorFactory`s for this data format.
`protected ILcyCustomizerPanelFactory[]`	`createDomainObjectCustomizerPanelFactories()` Creates the `ILcyCustomizerPanelFactory` factories that can create `ILcyCustomizerPanel` instances for the domain objects created by the model decoders of this format.
`protected ALcyWorkspaceObjectCodec[]`	`createDomainObjectCustomizerPanelWorkspaceCodecs()` Creates the `ALcyWorkspaceObjectCodec` codecs for the `ILcyCustomizerPanel` instances for the domain objects created by the model decoders of 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 ALcyFormatBarFactory`	`createFormatBarFactory()` Creates the `ALcyFormatBarFactory` that can create a bar to manipulate layers of this format.
`protected ILcyCustomizerPanelFactory[]`	`createGXYLayerCustomizerPanelFactories()` Creates the `ILcyCustomizerPanelFactory` factories that can create `ILcyCustomizerPanel` instances for the layers created by the layer factories of this format.
`protected ALcyWorkspaceObjectCodec[]`	`createGXYLayerCustomizerPanelWorkspaceCodecs()` Creates the `ALcyWorkspaceObjectCodec` codecs for the `ILcyCustomizerPanel` instances for the layers created by the layer factories of this format.
`protected ALcyFileTypeDescriptor[]`	`createGXYLayerDecoderFileTypeDescriptors()` Creates `ALcyFileTypeDescriptor`s for the `ILcdGXYLayerDecoder`s.
`protected ILcdGXYLayerDecoder[]`	`createGXYLayerDecoders()` Creates the `ILcdGXYLayerDecoder` decoders that can decode layers for models created by the model decoders of this format.
`protected ALcyFileTypeDescriptor[]`	`createGXYLayerEncoderFileTypeDescriptors()` Creates `ALcyFileTypeDescriptor`s for the `ILcdGXYLayerEncoder`s.
`protected ILcdGXYLayerEncoder[]`	`createGXYLayerEncoders()` Creates the `ILcdGXYLayerEncoder` encoders for the layers created by the layer factories of this format.
`protected abstract ILcdGXYLayerFactory`	`createGXYLayerFactory()` Creates a `ILcdGXYLayerFactory` for this format.
`ILcdFilter`	`createGXYLayerOfFormatFilter()` Utility method to create a `ILcdFilter` that only accepts `ILcdGXYLayer`s that are accepted by `isGXYLayerOfFormat(com.luciad.view.gxy.ILcdGXYLayer)`.
`protected ALcyLayerSelectionTransferHandler[]`	`createGXYLayerSelectionTransferHandlers()` Creates the `ALcyLayerSelectionTransferHandler` transfer handlers that can transfer the selection of the 2D layers created by the layer factories of this format.
`protected ILcyLayerStyleProvider`	`createGXYLayerStyleProvider()` Creates the style provider that can retrieve and encode the style of the layers created by the layer factory of this format.
`protected abstract ILcyGXYLayerTypeProvider`	`createGXYLayerTypeProvider()` Creates an `ILcyGXYLayerTypeProvider` for this format.
`protected ALcyWorkspaceObjectCodec[]`	`createGXYLayerWorkspaceCodecs()` Creates the `ALcyWorkspaceObjectCodec` codecs that can encode and decode the layers created by the layer factories of this format.
`protected ILcyGXYLabelPlacementHintProvider`	`createLabelPlacementHintProvider()` Creates the `ILcyLabelPlacementHintProvider` that can create a `TLcyGXYLabelPlacementHint` for layers of this format.
`ILcdFilter`	`createLayerContextOfFormatFilter(boolean aAcceptArrays)` Utility method to create a `ILcdFilter` that only accepts `TLcyLayerContext`s whose layers are accepted by `isGXYLayerOfFormat(com.luciad.view.gxy.ILcdGXYLayer)`.
`protected ILcdLayerHeightProviderFactory`	`createLayerHeightProviderFactory()` Creates the `ILcdLayerHeightProviderFactory` that can create an `ILcdHeightProvider` for this format.
`protected ILcdLayerMeasureProviderFactory`	`createLayerMeasureProviderFactory()` Creates the `ILcdLayerMeasureProviderFactory` for this format.
`protected abstract ILcyModelContentTypeProvider`	`createModelContentTypeProvider()` Creates an `ILcyModelContentTypeProvider` for this format.
`ILcdFilter`	`createModelContextOfFormatFilter()` Utility method to create a `ILcdFilter` that only accepts `TLcyModelContext`s whose model is accepted by `isModelOfFormat(com.luciad.model.ILcdModel)`.
`protected ILcyCustomizerPanelFactory[]`	`createModelCustomizerPanelFactories()` Creates the `ILcyCustomizerPanelFactory`(s) that can create `ILcyCustomizerPanel` instances to customize the models produced by the model decoders and model factories of this format.
`protected ALcyWorkspaceObjectCodec[]`	`createModelCustomizerPanelWorkspaceCodecs()` Creates the `ALcyWorkspaceObjectCodec` that can encode and decode the `ILcyCustomizerPanel` instances for the models produced by this format.
`protected String[][]`	`createModelDecoderFileTypeDescriptorGroups()` Creates file type descriptor groups for all decoders.
`protected abstract ALcyFileTypeDescriptor[]`	`createModelDecoderFileTypeDescriptors()` Creates the `ALcyFileTypeDescriptor` instances corresponding to the `ILcdModelDecoder` instances created by this format.
`protected abstract ILcdModelDecoder[]`	`createModelDecoders()` Creates the `ILcdModelDecoder` decoders for this data format.
`protected ILcyCustomizerPanelFactory[]`	`createModelEncoderCustomizerPanelFactories()` Creates the `ILcyCustomizerPanelFactory` instances for the `ILcdModelEncoder` instances created by this class.
`protected ALcyWorkspaceObjectCodec[]`	`createModelEncoderCustomizerPanelWorkspaceCodecs()` Creates the `ALcyWorkspaceObjectCodec` codecs for the `ILcyCustomizerPanel` that customize the model encoder instances created by this class.
`protected ALcyFileTypeDescriptor[]`	`createModelEncoderFileTypeDescriptors()` Creates the array of `ALcyFileTypeDescriptor` instances for the `ILcdModelEncoder` instances created by this format.
`protected ILcdModelEncoder[]`	`createModelEncoders()` Creates the model encoders for this data format.
`protected ILcdModelFactory`	`createModelFactory()` Creates the `ILcdModelFactory` for this data format.
`protected ILcdModelHeightProviderFactory`	`createModelHeightProviderFactory()` Creates the `ILcdModelHeightProviderFactory` that can create an `ILcdHeightProvider` for this format.
`protected ILcdModelMeasureProviderFactory`	`createModelMeasureProviderFactory()` Creates the `ILcdModelMeasureProviderFactory` for this format.
`protected ILcyCustomizerPanelFactory[]`	`createModelMetaDataCustomizerPanelFactories()` Creates the `ILcyCustomizerPanelFactory`(s) that can create `ILcyCustomizerPanel` instances to customize the meta data of the models produced by the model decoders and model factories of this format.
`protected ALcyWorkspaceObjectCodec[]`	`createModelMetaDataCustomizerPanelWorkspaceCodecs()` Creates the `ALcyWorkspaceObjectCodec` codecs that can encode and decode the `ILcyCustomizerPanel` instances used to customize the meta data of the models produced by this format.
`ILcdFilter`	`createModelOfFormatFilter()` Utility method to create a `ILcdFilter` that only accepts `ILcdModel`s that are accepted by `isModelOfFormat(com.luciad.model.ILcdModel)` .
`protected ALcyWorkspaceObjectCodec[]`	`createModelWorkspaceCodecs()` Creates the `ALcyWorkspaceObjectCodec` codecs that can encode and decode the `ILcdModel` instances produces by the model decoders of this format.
`ILcyAsynchronousPaintHintProvider`	`getAsynchronousPaintHintProvider()` Returns the `ILcyAsynchronousPaintHintProvider` providing the `TLcyAsynchronousPaintHint` for the layers created by the layer factories of this format.
`ILcdBalloonContentProvider[]`	`getBalloonContentProviders()` Returns the `ILcdBalloonContentProvider`s created by this format.
`ILcyCustomizerPanelFactory[]`	`getDataPropertyValueCustomizerPanelFactories()` Creates the `ILcyCustomizerPanelFactory` factories that can create `ILcyCustomizerPanel` instances to change the value of a single data property of the domain objects created by the model decoders of this format.
`String[][]`	`getDataSourceHandlerFileTypeDescriptorGroups()` Returns the ID's of the groups for the `ALcyFileTypeDescriptor` instances of the `ALcyFileTypeDescriptor` instances created by this format.
`ALcyFileTypeDescriptor[]`	`getDataSourceHandlerFileTypeDescriptors()` Returns the array of `ALcyFileTypeDescriptor` instances created by this format for data source handlers.
`ALcyDataSourceHandler[]`	`getDataSourceHandlers()` Returns the array of `ALcyDataSourceHandler` instances created by this format.
`ALcyDefaultModelDescriptorFactory[]`	`getDefaultModelDescriptorFactories()` Returns the array of `ALcyDefaultModelDescriptorFactory` instances created by this format.
`ILcyCustomizerPanelFactory[]`	`getDomainObjectCustomizerPanelFactories()` Returns the `ILcyCustomizerPanelFactory` factories created by this format that can create `ILcyCustomizerPanel` instances for the domain objects produced by the model decoders of this format.
`ALcyWorkspaceObjectCodec[]`	`getDomainObjectCustomizerPanelWorkspaceCodecs()` Returns the `ALcyWorkspaceObjectCodec` codecs for the `ILcyCustomizerPanel` instances that customize the domain objects produced by the model decoders of this format.
`ALcyWorkspaceObjectCodec[]`	`getDomainObjectWorkspaceCodecs()` Returns the array of `ALcyWorkspaceObjectCodec` codecs created by this format that can encode the domain objects produced by this format.
`ALcyFormatBarFactory`	`getFormatBarFactory()` Returns the `ALcyFormatBarFactory` that can create a bar to manipulate layers of this format.
`ILcyCustomizerPanelFactory[]`	`getGXYLayerCustomizerPanelFactories()` Returns the `ILcyCustomizerPanelFactory`s that can create `ILcyCustomizerPanel` instances for the layers created by the layer factories of this format.
`ALcyWorkspaceObjectCodec[]`	`getGXYLayerCustomizerPanelWorkspaceCodecs()` Returns the `ALcyWorkspaceObjectCodec` codecs for the `ILcyCustomizerPanel` instances that customizer the layers created by the layer factories of this format.
`ALcyFileTypeDescriptor[]`	`getGXYLayerDecoderFileTypeDescriptors()` Returns the `ALcyFileTypeDescriptor` descriptors describing the file types of the `ILcdGXYLayerDecoder` instances created by this format.
`ILcdGXYLayerDecoder[]`	`getGXYLayerDecoders()` Returns the `ILcdGXYLayerDecoder` decoders created by this format.
`ALcyFileTypeDescriptor[]`	`getGXYLayerEncoderFileTypeDescriptors()` Returns the `ALcyFileTypeDescriptor` descriptors describing the files for the `ILcdGXYLayerEncoder` encoders created by this format.
`ILcdGXYLayerEncoder[]`	`getGXYLayerEncoders()` Returns the `ILcdGXYLayerEncoder` encoders that can encode the layers created by the layer factories of this format.
`ILcdGXYLayerFactory`	`getGXYLayerFactory()` Returns the `ILcdGXYLayerFactory` created by this format.
`ALcyLayerSelectionTransferHandler[]`	`getGXYLayerSelectionTransferHandlers()` Returns the `ALcyLayerSelectionTransferHandler` transfer handlers that can transfer the selection of the 2D layers created by the layer factories of this format.
`ILcyLayerStyleProvider`	`getGXYLayerStyleProvider()` Returns the `ILcdLayerStyleProvider` created by this format.
`ILcyGXYLayerTypeProvider`	`getGXYLayerTypeProvider()` Returns the `ILcyGXYLayerTypeProvider` created by this format.
`ALcyWorkspaceObjectCodec[]`	`getGXYLayerWorkspaceCodecs()` Returns the `ALcyWorkspaceObjectCodec` codecs that can encode and decode the layers created by the layer factories of this format.
`ILcyGXYLabelPlacementHintProvider`	`getLabelPlacementHintProvider()` Returns the `ILcyLabelPlacementHintProvider` that can create a `TLcyGXYLabelPlacementHint` for a layer of this format.
`ILcdLayerHeightProviderFactory`	`getLayerHeightProviderFactory()` Returns the `ILcdLayerHeightProviderFactory` that can create an `ILcdHeightProvider` for this format.
`ILcdLayerMeasureProviderFactory`	`getLayerMeasureProviderFactory()` Returns the `ILcdLayerMeasureProviderFactory` created by this format.
`abstract String`	`getLongPrefix()` Returns the long prefix of this format that can be used, for instance, to derive UID's.
`abstract ILcyLucyEnv`	`getLucyEnv()` Returns the `ILcyLucyEnv` backend with which this `ALcyFormat` is associated.
`ILcyModelContentTypeProvider`	`getModelContentTypeProvider()` Returns the `ILcyModelContentTypeProvider` created by this format.
`ILcyCustomizerPanelFactory[]`	`getModelCustomizerPanelFactories()` Returns the `ILcyCustomizerPanelFactory` factories created by this format that can create `ILcyCustomizerPanel` instances for the models produced by the model decoders and model factories of this format.
`ALcyWorkspaceObjectCodec[]`	`getModelCustomizerPanelWorkspaceCodecs()` Returns the array of `ALcyWorkspaceObjectCodec` codecs created by this format that can encode `ILcdCustomizerPanel` instances produced by this format.
`String[][]`	`getModelDecoderFileTypeDescriptorGroups()` Returns the ID's of the groups for the `ALcyFileTypeDescriptor` instances of the `ILcdModelDecoder` instances created by this format.
`ALcyFileTypeDescriptor[]`	`getModelDecoderFileTypeDescriptors()` Returns the array of `ALcyFileTypeDescriptor` instances created by this format.
`ILcdModelDecoder[]`	`getModelDecoders()` Returns the array of `ILcdModelDecoder` instances created by this format.
`ILcyCustomizerPanelFactory[]`	`getModelEncoderCustomizerPanelFactories()` Returns the array of `ILcyCustomizerPanelFactory` factories created by this format.
`ALcyWorkspaceObjectCodec[]`	`getModelEncoderCustomizerPanelWorkspaceCodecs()` Returns the `ALcyWorkspaceObjectCodec` codecs for the `ILcyCustomizerPanel` instances that customize the model encoders of this format.
`ALcyFileTypeDescriptor[]`	`getModelEncoderFileTypeDescriptors()` Returns the array of `ALcyFileTypeDescriptor` instances created by this format.
`ILcdModelEncoder[]`	`getModelEncoders()` Returns the array `ILcdModelEncoder` instances created by this format.
`ILcdModelFactory`	`getModelFactory()` Returns the `ILcdModelFactory` created by this format.
`ILcdModelHeightProviderFactory`	`getModelHeightProviderFactory()` Returns the `ILcdModelHeightProviderFactory` that can create an `ILcdHeightProvider` for this format.
`ILcdModelMeasureProviderFactory`	`getModelMeasureProviderFactory()` Returns the `ILcdModelMeasureProviderFactory` created by this format.
`ILcyCustomizerPanelFactory[]`	`getModelMetaDataCustomizerPanelFactories()` Returns the `ILcyCustomizerPanelFactory` factories created by this format that can create `ILcyCustomizerPanel` instances to customize the meta data for the models produced by the model decoders and model factories of this format.
`ALcyWorkspaceObjectCodec[]`	`getModelMetaDataCustomizerPanelWorkspaceCodecs()` Returns the `ALcyWorkspaceObjectCodec` codecs for the `ILcyCustomizerPanel` instances that customize the meta data for the models created by this class.
`ALcyWorkspaceObjectCodec[]`	`getModelWorkspaceCodecs()` Returns the array of `ALcyWorkspaceObjectCodec` codecs created by this format that can encode the state of the `ILcdModel` instances produced by this format.
`abstract String`	`getShortPrefix()` Returns the short prefix of this format that can be used, for instance, to derive keys for a `ALcyProperties` instance.
`boolean`	`isGXYLayerOfFormat(ILcdGXYLayer aGXYLayer)` Returns `true` if and only if the given layer is a layer of the current data format.
`abstract boolean`	`isModelOfFormat(ILcdModel aModel)` Returns true if and only if the given model is a model of the current data format.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ALcyFormat
```
protected ALcyFormat()
```
    Creates a new ALcyFormat.
- Method Detail
  - getLucyEnv
```
public abstract ILcyLucyEnv getLucyEnv()
```
    Returns the ILcyLucyEnv backend with which this ALcyFormat is associated.
    
    Returns:
    
    The ILcyLucyEnv backend. Must not be null.
  - getLongPrefix
```
public abstract String getLongPrefix()
```
    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.
    
    Returns:
    
    The long prefix that can be used to generate UID's. Must not be null.
  - getShortPrefix
```
public abstract String getShortPrefix()
```
    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 classname of the addon.
    
    Returns:
    
    The short prefix of this format. Must not be null.
  - createAll
```
public void createAll()
```
    Creates all the instances of the concepts of this class by calling all the abstract factory methods, and performs some validity checks on the created values. All created instances can later on be retrieved by calling the appropriate get<Concept> methods.
  - getBalloonContentProviders
```
public final ILcdBalloonContentProvider[] getBalloonContentProviders()
```
    Returns the ILcdBalloonContentProviders created by this format. Should only be called after createAll() has been called.
    
    Returns:
    
    The ILcdBalloonContentProviders created by this format
  - getModelContentTypeProvider
```
public final ILcyModelContentTypeProvider getModelContentTypeProvider()
```
    Returns the ILcyModelContentTypeProvider created by this format. Should only be called after createAll() has been called.
    
    Returns:
    
    The ILcyModelContentTypeProvider created by this format.
    
    See Also:
    
    createModelContentTypeProvider()
  - getModelFactory
```
public final ILcdModelFactory getModelFactory()
```
    Returns the ILcdModelFactory created by this format. Should only be called after createAll() has been called.
    
    Returns:
    
    The ILcdModelFactory created by this format.
    
    See Also:
    
    createModelFactory()
  - getDefaultModelDescriptorFactories
```
public final ALcyDefaultModelDescriptorFactory[] getDefaultModelDescriptorFactories()
```
    Returns the array of ALcyDefaultModelDescriptorFactory instances created by this format. Should only be called after createAll() has been called.
    
    Returns:
    
    The array of ALcyDefaultModelDescriptorFactorys created by this format.
    
    See Also:
    
    createDefaultModelDescriptorFactories()
  - getModelDecoders
```
public final ILcdModelDecoder[] getModelDecoders()
```
    Returns the array of ILcdModelDecoder instances created by this format. Should only be called after createAll() has been called.
    
    Returns:
    
    The array of ILcdModelDecoders created by this format.
    
    See Also:
    
    createModelDecoders()
  - getModelDecoderFileTypeDescriptors
```
public final ALcyFileTypeDescriptor[] getModelDecoderFileTypeDescriptors()
```
    Returns the array of ALcyFileTypeDescriptor instances created by this format. Should only be called after createAll() has been called.
    
    Returns:
    
    The array of ALcyFileTypeDescriptor instances.
    
    See Also:
    
    createModelDecoderFileTypeDescriptors(), getModelDecoders()
  - getModelDecoderFileTypeDescriptorGroups
```
public final String[][] getModelDecoderFileTypeDescriptorGroups()
```
    Returns the ID's of the groups for the ALcyFileTypeDescriptor instances of the ILcdModelDecoder instances created by this format. Should only be called after createAll() has been called.
    
    Returns:
    
    The two-dimensional array of ID's of the groups for the ALcyFileTypeDescriptor instances.
    
    See Also:
    
    createModelDecoderFileTypeDescriptorGroups(), getModelDecoderFileTypeDescriptors()
  - getModelEncoders
```
public final ILcdModelEncoder[] getModelEncoders()
```
    Returns the array ILcdModelEncoder instances created by this format. Should only be called after createAll() has been called.
    
    Returns:
    
    The array of ILcdModelEncoder instances.
  - getModelEncoderFileTypeDescriptors
```
public final ALcyFileTypeDescriptor[] getModelEncoderFileTypeDescriptors()
```
    Returns the array of ALcyFileTypeDescriptor instances created by this format. Should only be called after createAll() has been called.
    
    Returns:
    
    The array of ALcyFileTypeDescriptor instances corresponding to the created ILcdModelEncoder instances.
    
    See Also:
    
    createModelEncoderFileTypeDescriptors(), getModelEncoders()
  - getModelEncoderCustomizerPanelFactories
```
public final ILcyCustomizerPanelFactory[] getModelEncoderCustomizerPanelFactories()
```
    Returns the array of ILcyCustomizerPanelFactory factories created by this format. Should only be called after createAll() has been called.
    
    The created ILcyCustomizerPanels should work with instances of TLcyModelEncoderContext in their setObject method.
    
    Returns:
    
    The array of ILcyCustomizerPanelFactory factories.
    
    See Also:
    
    createModelEncoderCustomizerPanelFactories()
  - getModelEncoderCustomizerPanelWorkspaceCodecs
```
public final ALcyWorkspaceObjectCodec[] getModelEncoderCustomizerPanelWorkspaceCodecs()
```
    Returns the ALcyWorkspaceObjectCodec codecs for the ILcyCustomizerPanel instances that customize the model encoders of this format. Should only be called after createAll() has been called.
    
    Returns:
    
    An array containing the ALcyWorkspaceObjectCodec instances. Must not be null, but may have length 0. Must not contain null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - getModelWorkspaceCodecs
```
public final ALcyWorkspaceObjectCodec[] getModelWorkspaceCodecs()
```
    Returns the array of ALcyWorkspaceObjectCodec codecs created by this format that can encode the state of the ILcdModel instances produced by this format. Should only be called after createAll() has been called.
    
    Returns:
    
    The array of ALcyWorkspaceObjectCodec instances.
    
    See Also:
    
    createModelWorkspaceCodecs()
  - getDomainObjectWorkspaceCodecs
```
public final ALcyWorkspaceObjectCodec[] getDomainObjectWorkspaceCodecs()
```
    Returns the array of ALcyWorkspaceObjectCodec codecs created by this format that can encode the domain objects produced by this format. Should only be called after createAll() has been called.
    
    Returns:
    
    The array of ALcyWorkspaceObjectCodec instances.
    
    See Also:
    
    createDomainObjectWorkspaceCodecs()
  - getModelCustomizerPanelWorkspaceCodecs
```
public final ALcyWorkspaceObjectCodec[] getModelCustomizerPanelWorkspaceCodecs()
```
    Returns the array of ALcyWorkspaceObjectCodec codecs created by this format that can encode ILcdCustomizerPanel instances produced by this format. Should only be called after createAll() has been called.
    
    Returns:
    
    The array of ALcyWorkspaceObjectCodec instances.
    
    See Also:
    
    createDomainObjectWorkspaceCodecs()
  - getModelCustomizerPanelFactories
```
public final ILcyCustomizerPanelFactory[] getModelCustomizerPanelFactories()
```
    Returns the ILcyCustomizerPanelFactory factories created by this format that can create ILcyCustomizerPanel instances for the models produced by the model decoders and model factories of this format. Should only be called after createAll() has been called.
    
    The created ILcyCustomizerPanels should work with instances of TLcyModelContext in their setObject method.
    
    Returns:
    
    The array of ILcyCustomizerPanelFactory factories.
    
    See Also:
    
    createModelCustomizerPanelFactories()
  - getModelMetaDataCustomizerPanelFactories
```
public final ILcyCustomizerPanelFactory[] getModelMetaDataCustomizerPanelFactories()
```
    Returns the ILcyCustomizerPanelFactory factories created by this format that can create ILcyCustomizerPanel instances to customize the meta data for the models produced by the model decoders and model factories of this format. Should only be called after createAll() has been called.
    
    The created ILcyCustomizerPanels should work with instances of TLcyModelMetaDataContext in their setObject method.
    
    Returns:
    
    The array of ILcyCustomizerPanelFactory factories.
    
    See Also:
    
    createModelMetaDataCustomizerPanelFactories()
  - getModelMetaDataCustomizerPanelWorkspaceCodecs
```
public final ALcyWorkspaceObjectCodec[] getModelMetaDataCustomizerPanelWorkspaceCodecs()
```
    Returns the ALcyWorkspaceObjectCodec codecs for the ILcyCustomizerPanel instances that customize the meta data for the models created by this class. Should only be called after createAll() has been called.
    
    Returns:
    
    An array containing the ALcyWorkspaceObjectCodec instances. Must not be null, but may have length 0. Must not contain null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - getDomainObjectCustomizerPanelFactories
```
public final ILcyCustomizerPanelFactory[] getDomainObjectCustomizerPanelFactories()
```
    Returns the ILcyCustomizerPanelFactory factories created by this format that can create ILcyCustomizerPanel instances for the domain objects produced by the model decoders of this format. Should only be called after createAll() has been called.
    
    The created ILcyCustomizerPanels should work with instances of TLcyDomainObjectContext in their setObject method.
    
    Returns:
    
    The array of ILcyCustomizerPanelFactory factories.
    
    See Also:
    
    createDomainObjectCustomizerPanelFactories()
  - getDomainObjectCustomizerPanelWorkspaceCodecs
```
public final ALcyWorkspaceObjectCodec[] getDomainObjectCustomizerPanelWorkspaceCodecs()
```
    Returns the ALcyWorkspaceObjectCodec codecs for the ILcyCustomizerPanel instances that customize the domain objects produced by the model decoders of this format. Should only be called after createAll() has been called.
    
    Returns:
    
    An array containing the ALcyWorkspaceObjectCodec instances. Must not be null, but may have length 0. Must not contain null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - getGXYLayerTypeProvider
```
public final ILcyGXYLayerTypeProvider getGXYLayerTypeProvider()
```
    Returns the ILcyGXYLayerTypeProvider created by this format. Should only be called after createAll() has been called.
    
    Returns:
    
    The ILcyGXYLayerTypeProvider.
    
    See Also:
    
    createGXYLayerTypeProvider()
  - getGXYLayerFactory
```
public final ILcdGXYLayerFactory getGXYLayerFactory()
```
    Returns the ILcdGXYLayerFactory created by this format. Should only be called after createAll() has been called.
    
    Returns:
    
    The ILcdGXYLayerFactory.
    
    See Also:
    
    createGXYLayerFactory()
  - getGXYLayerStyleProvider
```
public final ILcyLayerStyleProvider getGXYLayerStyleProvider()
```
    Returns the ILcdLayerStyleProvider created by this format. Should only be called after createAll() has been called.
    
    Returns:
    
    The ILcyLayerStyleProvider.
    
    See Also:
    
    createGXYLayerStyleProvider()
  - getGXYLayerDecoders
```
public final ILcdGXYLayerDecoder[] getGXYLayerDecoders()
```
    Returns the ILcdGXYLayerDecoder decoders created by this format. Should only be called after createAll() has been called.
    
    Returns:
    
    The array of ILcdGXYLayerDecoder decoders.
    
    See Also:
    
    createGXYLayerDecoders()
  - getGXYLayerDecoderFileTypeDescriptors
```
public final ALcyFileTypeDescriptor[] getGXYLayerDecoderFileTypeDescriptors()
```
    Returns the ALcyFileTypeDescriptor descriptors describing the file types of the ILcdGXYLayerDecoder instances created by this format. Should only be called after createAll() has been called.
    
    Returns:
    
    The array of ALcyFileTypeDescriptor descriptors.
    
    See Also:
    
    createGXYLayerDecoderFileTypeDescriptors()
  - getGXYLayerEncoders
```
public final ILcdGXYLayerEncoder[] getGXYLayerEncoders()
```
    Returns the ILcdGXYLayerEncoder encoders that can encode the layers created by the layer factories of this format. Should only be called after createAll() has been called.
    
    Returns:
    
    The array of ILcdGXYLayerEncoder encoders.
    
    See Also:
    
    createGXYLayerEncoders()
  - getGXYLayerEncoderFileTypeDescriptors
```
public final ALcyFileTypeDescriptor[] getGXYLayerEncoderFileTypeDescriptors()
```
    Returns the ALcyFileTypeDescriptor descriptors describing the files for the ILcdGXYLayerEncoder encoders created by this format. Should only be called after createAll() has been called.
    
    Returns:
    
    The array of ALcyFileTypeDescriptor descriptors.
    
    See Also:
    
    createGXYLayerEncoderFileTypeDescriptors()
  - getAsynchronousPaintHintProvider
```
public final ILcyAsynchronousPaintHintProvider getAsynchronousPaintHintProvider()
```
    Returns the ILcyAsynchronousPaintHintProvider providing the TLcyAsynchronousPaintHint for the layers created by the layer factories of this format. Should only be called after createAll() has been called.
    
    Returns:
    
    The ILcyAsynchronousPaintHintProvider.
    
    See Also:
    
    createAsynchronousPaintHintProvider()
  - getGXYLayerWorkspaceCodecs
```
public final ALcyWorkspaceObjectCodec[] getGXYLayerWorkspaceCodecs()
```
    Returns the ALcyWorkspaceObjectCodec codecs that can encode and decode the layers created by the layer factories of this format. Should only be called after createAll() has been called.
    
    Returns:
    
    The array of ALcyWorkspaceObjectCodec codecs.
    
    See Also:
    
    createGXYLayerWorkspaceCodecs()
  - getGXYLayerCustomizerPanelFactories
```
public final ILcyCustomizerPanelFactory[] getGXYLayerCustomizerPanelFactories()
```
    Returns the ILcyCustomizerPanelFactorys that can create ILcyCustomizerPanel instances for the layers created by the layer factories of this format. Should only be called after createAll() has been called.
    
    The created ILcyCustomizerPanels should work with instances of TLcyLayerContext in their setObject method.
    
    Returns:
    
    The array of ILcyCustomizerPanelFactorys.
    
    See Also:
    
    createGXYLayerCustomizerPanelFactories()
  - getGXYLayerCustomizerPanelWorkspaceCodecs
```
public final ALcyWorkspaceObjectCodec[] getGXYLayerCustomizerPanelWorkspaceCodecs()
```
    Returns the ALcyWorkspaceObjectCodec codecs for the ILcyCustomizerPanel instances that customizer the layers created by the layer factories of this format. Should only be called after createAll() has been called.
    
    Returns:
    
    An array containing the ALcyWorkspaceObjectCodec instances. Must not be null, but may have length 0. Must not contain null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - getGXYLayerSelectionTransferHandlers
```
public final ALcyLayerSelectionTransferHandler[] getGXYLayerSelectionTransferHandlers()
```
    Returns the ALcyLayerSelectionTransferHandler transfer handlers that can transfer the selection of the 2D layers created by the layer factories of this format. Should only be called after createAll() has been called.
    
    Returns:
    
    The array of ALcyLayerSelectionTransferHandler transfer handlers.
    
    See Also:
    
    createGXYLayerSelectionTransferHandlers()
  - getFormatBarFactory
```
public final ALcyFormatBarFactory getFormatBarFactory()
```
    Returns the ALcyFormatBarFactory that can create a bar to manipulate layers of this format. Should only be called after createAll() has been called.
    
    Returns:
    
    The ALcyFormatBarFactory.
    
    See Also:
    
    createFormatBarFactory()
  - getLayerHeightProviderFactory
```
public final ILcdLayerHeightProviderFactory getLayerHeightProviderFactory()
```
    Returns the ILcdLayerHeightProviderFactory that can create an ILcdHeightProvider for this format. Should only be called after createAll() has been called.
    
    Returns:
    
    The ILcdLayerHeightProviderFactory
    
    See Also:
    
    createLayerHeightProviderFactory()
  - getModelHeightProviderFactory
```
public final ILcdModelHeightProviderFactory getModelHeightProviderFactory()
```
    Returns the ILcdModelHeightProviderFactory that can create an ILcdHeightProvider for this format. Should only be called after createAll() has been called.
    
    Returns:
    
    The ILcdModelHeightProviderFactory
    
    See Also:
    
    createModelHeightProviderFactory()
  - getLabelPlacementHintProvider
```
public final ILcyGXYLabelPlacementHintProvider getLabelPlacementHintProvider()
```
    Returns the ILcyLabelPlacementHintProvider that can create a TLcyGXYLabelPlacementHint for a layer of this format. Should only be called after createAll() has been called.
    
    Returns:
    
    the ILcyLabelPlacementHintProvider.
    
    See Also:
    
    createLabelPlacementHintProvider()
  - createModelMeasureProviderFactory
```
protected ILcdModelMeasureProviderFactory createModelMeasureProviderFactory()
```
    Creates the ILcdModelMeasureProviderFactory for this format.
    
    The default implementation returns null.
    
    Returns:
    
    the ILcdModelMeasureProviderFactory for this format. Can be null.
    
    See Also:
    
    getModelMeasureProviderFactory()
  - getModelMeasureProviderFactory
```
public final ILcdModelMeasureProviderFactory getModelMeasureProviderFactory()
```
    Returns the ILcdModelMeasureProviderFactory created by this format. Should only be called after createAll() has been called.
    
    Returns:
    
    the ILcdModelMeasureProviderFactory created by this format.
    
    See Also:
    
    createModelMeasureProviderFactory()
  - createLayerMeasureProviderFactory
```
protected ILcdLayerMeasureProviderFactory createLayerMeasureProviderFactory()
```
    Creates the ILcdLayerMeasureProviderFactory for this format.
    
    The default implementation returns null.
    
    Returns:
    
    the ILcdLayerMeasureProviderFactory for this format. Can be null.
    
    See Also:
    
    getLayerMeasureProviderFactory()
  - getLayerMeasureProviderFactory
```
public final ILcdLayerMeasureProviderFactory getLayerMeasureProviderFactory()
```
    Returns the ILcdLayerMeasureProviderFactory created by this format. Should only be called after createAll() has been called.
    
    Returns:
    
    the ILcdLayerMeasureProviderFactory created by this format.
    
    See Also:
    
    createLayerMeasureProviderFactory()
  - isModelOfFormat
```
public abstract boolean isModelOfFormat(ILcdModel aModel)
```
    Returns true if and only if the given model is a model of the current data format.
    
    Parameters:
    
    aModel - The model to check.
    
    Returns:
    
    true if and only if the given model is a model of the current data format.
  - createModelContentTypeProvider
```
protected abstract ILcyModelContentTypeProvider createModelContentTypeProvider()
```
    Creates an ILcyModelContentTypeProvider for this format.
    
    Returns:
    
    the ILcyModelContentTypeProvider for this data format. May be null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - createBalloonContentProviders
```
protected ILcdBalloonContentProvider[] createBalloonContentProviders()
```
    Creates the ILcdBalloonContentProviders for this format.
    
    The default implementation returns an empty array.
    
    Returns:
    
    the ILcdBalloonContentProviders for this format. Must not be null. The array may be empty but not contain null.
  - createModelFactory
```
protected ILcdModelFactory createModelFactory()
```
    Creates the ILcdModelFactory for this data format. All newly created models of the add-on are expected to be constructed through this factory.
    
    Returns:
    
    The ILcdModelFactory for this data format. May be null.
  - createDefaultModelDescriptorFactories
```
protected ALcyDefaultModelDescriptorFactory[] createDefaultModelDescriptorFactories()
```
    Creates the ALcyDefaultModelDescriptorFactorys for this data format.
    
    The default implementation returns a zero-length array.
    
    Returns:
    
    The ALcyDefaultModelDescriptorFactory (or multiple) for this data format. Must not be null, but the array may have length 0.
  - createModelDecoders
```
protected abstract ILcdModelDecoder[] createModelDecoders()
```
    Creates the ILcdModelDecoder decoders for this data format.
    
    It's also the responsibility of this method to make sure that the given lucy environment listens to status events from the decoder. This method should not register the decoder to the lucy env.
    
    Note that TLcdStatusInputStreamFactory might be useful to implement this method.
    
    Returns:
    
    The ILcdModelDecoder (or multiple) for this data format. Must not be null, but the array may have length 0.
    
    See Also:
    
    TLcdStatusInputStreamFactory
  - createModelDecoderFileTypeDescriptors
```
protected abstract ALcyFileTypeDescriptor[] createModelDecoderFileTypeDescriptors()
```
    Creates the ALcyFileTypeDescriptor instances corresponding to the ILcdModelDecoder instances created by this format.
    
    Returns:
    
    The array of ALcyFileTypeDescriptor instances. Must not be null. Its length should be equal to the length of the array created by createModelDecoders. It may contain null.
  - createModelDecoderFileTypeDescriptorGroups
```
protected String[][] createModelDecoderFileTypeDescriptorGroups()
```
    Creates file type descriptor groups for all decoders. The groups may be empty, but the group count must equal the decoder count.
    
    Returns:
    
    A two-dimensional array containing the groups for the ALcyFileTypeDescriptor instances of the ILcdModelDecoders. The first dimension must be equal to the length of the array of ILcdModelDecoder instances created by this format. It must not contain null, but may contain empty arrays.
  - createModelEncoders
```
protected ILcdModelEncoder[] createModelEncoders()
```
    Creates the model encoders for this data format. It is the responsibility of this method to ensure that the given lucy environment listens to status events from the encoder. This method should not register the encoder to the lucy env.
    
    Note that TLcdStatusOutputStreamFactory might be useful to implement this method.
    
    Returns:
    
    An array of ILcdModelEncoder instances. Must not be null, but may have length 0. Must not contain null.
    
    See Also:
    
    TLcdStatusOutputStreamFactory
  - createModelEncoderFileTypeDescriptors
```
protected ALcyFileTypeDescriptor[] createModelEncoderFileTypeDescriptors()
```
    Creates the array of ALcyFileTypeDescriptor instances for the ILcdModelEncoder instances created by this format.
    
    Returns:
    
    The array of ALcyFileTypeDescriptor instances. Must not be null and its length must be equal to the length of the array of ILcdModelEncoder instances created by this format. May contain null.
    
    See Also:
    
    createModelEncoders()
  - createModelEncoderCustomizerPanelFactories
```
protected ILcyCustomizerPanelFactory[] createModelEncoderCustomizerPanelFactories()
```
    Creates the ILcyCustomizerPanelFactory instances for the ILcdModelEncoder instances created by this class.
    
    The created ILcyCustomizerPanels should work with instances of TLcyModelEncoderContext in their setObject method.
    
    Hint: When overriding this method, you should also consider overriding createModelEncoderCustomizerPanelWorkspaceCodecs(). This is needed if your ILcyCustomizerPanels need to store any specific state in the workspace.
    
    Returns:
    
    An array of ILcyCustomizerPanelFactory instances. Must not be null but may have length 0. Must not contain null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - createModelEncoderCustomizerPanelWorkspaceCodecs
```
protected ALcyWorkspaceObjectCodec[] createModelEncoderCustomizerPanelWorkspaceCodecs()
```
    Creates the ALcyWorkspaceObjectCodec codecs for the ILcyCustomizerPanel that customize the model encoder instances created by this class.
    
    Returns:
    
    An array containing the ALcyWorkspaceObjectCodec instances. Must not be null, but may have length 0. Must not contain null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - createModelWorkspaceCodecs
```
protected ALcyWorkspaceObjectCodec[] createModelWorkspaceCodecs()
```
    Creates the ALcyWorkspaceObjectCodec codecs that can encode and decode the ILcdModel instances produces by the model decoders of this format.
    
    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()
```
    Creates the ALcyWorkspaceObjectCodec that can encode and decode the ILcyCustomizerPanel instances for the domain objects produced by the model decoders of this format.
    
    Returns:
    
    An array of ALcyWorkspaceObjectCodec instances. Must not be null but may have length 0. Must not contain null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - createModelCustomizerPanelWorkspaceCodecs
```
protected ALcyWorkspaceObjectCodec[] createModelCustomizerPanelWorkspaceCodecs()
```
    Creates the ALcyWorkspaceObjectCodec that can encode and decode the ILcyCustomizerPanel instances for the models produced by this format.
    
    Returns:
    
    An array of ALcyWorkspaceObjectCodec instances. Must not be null but may have length 0. Must not contain null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - createModelCustomizerPanelFactories
```
protected ILcyCustomizerPanelFactory[] createModelCustomizerPanelFactories()
```
    Creates the ILcyCustomizerPanelFactory(s) that can create ILcyCustomizerPanel instances to customize the models produced by the model decoders and model factories of this format.
    
    The created ILcyCustomizerPanels should work with instances of TLcyModelContext in their setObject method.
    
    Hint: When overriding this method, you should also consider overriding createModelCustomizerPanelWorkspaceCodecs(). This is needed if your ILcyCustomizerPanels need to store any specific state in the workspace.
    
    Returns:
    
    An array containing the ILcyCustomizerPanelFactory instances. Must not be null but may have length 0. Must not contain null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - createModelMetaDataCustomizerPanelFactories
```
protected ILcyCustomizerPanelFactory[] createModelMetaDataCustomizerPanelFactories()
```
    Creates the ILcyCustomizerPanelFactory(s) that can create ILcyCustomizerPanel instances to customize the meta data of the models produced by the model decoders and model factories of this format.
    
    The created ILcyCustomizerPanels should work with instances of TLcyModelMetaDataContext in their setObject method.
    
    Hint: When overriding this method, you should also consider overriding createModelMetaDataCustomizerPanelWorkspaceCodecs(). This is needed if your ILcyCustomizerPanels need to store any specific state in the workspace.
    
    Returns:
    
    An array containing the ILcyCustomizerPanelFactory instances. Must not be null but may have length 0. Must not contain null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - createModelMetaDataCustomizerPanelWorkspaceCodecs
```
protected ALcyWorkspaceObjectCodec[] createModelMetaDataCustomizerPanelWorkspaceCodecs()
```
    Creates the ALcyWorkspaceObjectCodec codecs that can encode and decode the ILcyCustomizerPanel instances used to customize the meta data of the models produced by this format.
    
    Returns:
    
    An array of ALcyWorkspaceObjectCodec instances. Must not be null but may have length 0. Must not contain null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - createDomainObjectCustomizerPanelFactories
```
protected ILcyCustomizerPanelFactory[] createDomainObjectCustomizerPanelFactories()
```
    Creates the ILcyCustomizerPanelFactory factories that can create ILcyCustomizerPanel instances for the domain objects created by the model decoders of this format.
    
    The created ILcyCustomizerPanels should work with instances of TLcyDomainObjectContext in their setObject method.
    
    Hint: When overriding this method, you should also consider overriding createDomainObjectCustomizerPanelWorkspaceCodecs(). This is needed if your ILcyCustomizerPanels need to store any specific state in the workspace.
    
    Returns:
    
    An array containing the ILcyCustomizerPanelFactory instances. Must not be null but may have length 0. Must not contain null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - createDomainObjectCustomizerPanelWorkspaceCodecs
```
protected ALcyWorkspaceObjectCodec[] createDomainObjectCustomizerPanelWorkspaceCodecs()
```
    Creates the ALcyWorkspaceObjectCodec codecs for the ILcyCustomizerPanel instances for the domain objects created by the model decoders of this format.
    
    Returns:
    
    An array containing the ALcyWorkspaceObjectCodec instances. Must not be null, but may have length 0. Must not contain null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - createGXYLayerTypeProvider
```
protected abstract ILcyGXYLayerTypeProvider createGXYLayerTypeProvider()
```
    Creates an ILcyGXYLayerTypeProvider for this format.
    
    Returns:
    
    A ILcyGXYLayerTypeProvider for this data format. May be null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - createGXYLayerFactory
```
protected abstract ILcdGXYLayerFactory createGXYLayerFactory()
```
    Creates a ILcdGXYLayerFactory for this format.
    The factory can also configure label algorithms on the created layers.
    
    Returns:
    
    the ILcdGXYLayerFactory for this data format. May be null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - createGXYLayerStyleProvider
```
protected ILcyLayerStyleProvider createGXYLayerStyleProvider()
```
    Creates the style provider that can retrieve and encode the style of the layers created by the layer factory of this format.
    
    Returns:
    
    the style provider to retrieve and encode the style of the layers. May be null
  - createAsynchronousPaintHintProvider
```
protected abstract ILcyAsynchronousPaintHintProvider createAsynchronousPaintHintProvider()
```
    Creates a ILcyAsynchronousPaintHintProvider for this format.
    
    Returns:
    
    A ILcyAsynchronousPaintHintProvider for the layers created by the layer factories of this format. May be null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - createGXYLayerDecoders
```
protected ILcdGXYLayerDecoder[] createGXYLayerDecoders()
```
    Creates the ILcdGXYLayerDecoder decoders that can decode layers for models created by the model decoders of this format.
    
    The default implementation returns a zero-length array.
    
    It is the responsibility of this method to make sure that the lucy environment listens to status events from the decoder. This method should not register the decoder to the lucy env.
    
    Note that TLcdStatusInputStreamFactory might be useful to implement this method.
    
    Returns:
    
    An array of layer decoders. It must not be null, but may have length 0. It must not contain null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - createGXYLayerDecoderFileTypeDescriptors
```
protected ALcyFileTypeDescriptor[] createGXYLayerDecoderFileTypeDescriptors()
```
    Creates ALcyFileTypeDescriptors for the ILcdGXYLayerDecoders. The length of the returned array must be equal to that of createGXYLayerDecoders().
    
    An example usage of these ALcyFileTypeDescriptor instances could be to determine whether a style file is located next to source file of a layer, and apply that style when such a layer is created. Most of the default Lucy formats have such a mechanism in place in their layer factory: they look for a style file with the same name as the source file, but with an extension as specified by a non-null ALcyFileTypeDescriptor.
    
    The default implementation returns a zero-length array.
    
    Returns:
    
    An array of ALcyFileTypeDescriptor instances. Must not be null and its length must be equal to the length of the array of layer decoders created by this format. May contain null.
  - createGXYLayerEncoders
```
protected ILcdGXYLayerEncoder[] createGXYLayerEncoders()
```
    Creates the ILcdGXYLayerEncoder encoders for the layers created by the layer factories of this format.
    
    The default implementation returns a zero-length array.
    
    It is the responsibility of this method to make sure that the lucy environment listens to status events from the encoder. This method should not register the encoder to the lucy env.
    
    Note that TLcdStatusOutputStreamFactory might be useful to implement this method.
    
    Returns:
    
    An array of ILcdGXYLayerEncoder instances. Must not be null but may have length 0. Must not contain null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper, TLcdStatusOutputStreamFactory
  - createGXYLayerEncoderFileTypeDescriptors
```
protected ALcyFileTypeDescriptor[] createGXYLayerEncoderFileTypeDescriptors()
```
    Creates ALcyFileTypeDescriptors for the ILcdGXYLayerEncoders. The length of the returned array must be equal to that of createGXYLayerEncoders().
    
    An example usage of these ALcyFileTypeDescriptor instances is the File | Save layer style action which is available in Lucy. It allows to save the style of a layer to a file ending with an extension as specified by these ALcyFileTypeDescriptors. When no ALcyFileTypeDescriptors are available (or only null ALcyFileTypeDescriptors) it will not be possible to save the layer style to file.
    
    The default implementation returns a zero-length array.
    
    Returns:
    
    An array of ALcyFileTypeDescriptor instances. Must not be null and its length must be equal to the length of the array of layer encoders created by this format. May contain null.
    
    See Also:
    
    createGXYLayerEncoders()
  - createGXYLayerWorkspaceCodecs
```
protected ALcyWorkspaceObjectCodec[] createGXYLayerWorkspaceCodecs()
```
    Creates the ALcyWorkspaceObjectCodec codecs that can encode and decode the layers created by the layer factories of this format.
    
    The default implementation returns a zero-length array.
    
    Returns:
    
    An array of ALcyWorkspaceObjectCodec instances. Must not be null but may have length 0. Must not contain null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - createGXYLayerCustomizerPanelFactories
```
protected ILcyCustomizerPanelFactory[] createGXYLayerCustomizerPanelFactories()
```
    Creates the ILcyCustomizerPanelFactory factories that can create ILcyCustomizerPanel instances for the layers created by the layer factories of this format.
    
    The created ILcyCustomizerPanels should work with instances of TLcyLayerContext in their setObject method.
    
    The default implementation returns a zero-length array.
    
    Hint: When overriding this method, you should also consider overriding createGXYLayerCustomizerPanelWorkspaceCodecs(). This is needed if your ILcyCustomizerPanels need to store any specific state in the workspace.
    
    Returns:
    
    An array of ILcyCustomizerPanelFactory instances. Must not be null but may have length 0. Must not contain null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - createGXYLayerCustomizerPanelWorkspaceCodecs
```
protected ALcyWorkspaceObjectCodec[] createGXYLayerCustomizerPanelWorkspaceCodecs()
```
    Creates the ALcyWorkspaceObjectCodec codecs for the ILcyCustomizerPanel instances for the layers created by the layer factories of this format.
    
    Returns:
    
    An array containing the ALcyWorkspaceObjectCodec instances. Must not be null, but may have length 0. Must not contain null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - createGXYLayerSelectionTransferHandlers
```
protected ALcyLayerSelectionTransferHandler[] createGXYLayerSelectionTransferHandlers()
```
    Creates the ALcyLayerSelectionTransferHandler transfer handlers that can transfer the selection of the 2D layers created by the layer factories of this format.
    
    The default implementation returns a zero-length array.
    
    Returns:
    
    An array of ALcyLayerSelectionTransferHandler instances. Must not be null but may have length 0. Must not contain null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - createFormatBarFactory
```
protected ALcyFormatBarFactory createFormatBarFactory()
```
    Creates the ALcyFormatBarFactory that can create a bar to manipulate layers of this format.
    
    The default implementation returns null.
    
    Returns:
    
    An ALcyFormatBarFactory. May be null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - createLayerHeightProviderFactory
```
protected ILcdLayerHeightProviderFactory createLayerHeightProviderFactory()
```
    Creates the ILcdLayerHeightProviderFactory that can create an ILcdHeightProvider for this format.
    
    The default implementation returns null.
    
    Returns:
    
    An ILcdLayerHeightProviderFactory. May be null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - createModelHeightProviderFactory
```
protected ILcdModelHeightProviderFactory createModelHeightProviderFactory()
```
    Creates the ILcdModelHeightProviderFactory that can create an ILcdHeightProvider for this format.
    
    The default implementation returns null.
    
    Returns:
    
    An ILcdModelHeightProviderFactory. May be null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - createLabelPlacementHintProvider
```
protected ILcyGXYLabelPlacementHintProvider createLabelPlacementHintProvider()
```
    Creates the ILcyLabelPlacementHintProvider that can create a TLcyGXYLabelPlacementHint for layers of this format.
    The default implementation returns null.
    
    Returns:
    
    An ILcyLabelPlacementHintProvider. May be null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - createModelOfFormatFilter
```
public final ILcdFilter createModelOfFormatFilter()
```
    Utility method to create a ILcdFilter that only accepts ILcdModels that are accepted by isModelOfFormat(com.luciad.model.ILcdModel) .
    
    Returns:
    
    The ILcdFilter. Never null.
  - createModelContextOfFormatFilter
```
public final ILcdFilter createModelContextOfFormatFilter()
```
    Utility method to create a ILcdFilter that only accepts TLcyModelContexts whose model is accepted by isModelOfFormat(com.luciad.model.ILcdModel).
    
    Returns:
    
    The ILcdFilter.
  - isGXYLayerOfFormat
```
public boolean isGXYLayerOfFormat(ILcdGXYLayer aGXYLayer)
```
    Returns true if and only if the given layer is a layer of the current data format.
    
    Parameters:
    
    aGXYLayer - The layer to check.
    
    Returns:
    
    true if and only if the given layer is a layer of the current data format.
  - createGXYLayerOfFormatFilter
```
public final ILcdFilter createGXYLayerOfFormatFilter()
```
    Utility method to create a ILcdFilter that only accepts ILcdGXYLayers that are accepted by isGXYLayerOfFormat(com.luciad.view.gxy.ILcdGXYLayer).
    
    Returns:
    
    The ILcdFilter. Never null.
  - createLayerContextOfFormatFilter
```
public final ILcdFilter createLayerContextOfFormatFilter(boolean aAcceptArrays)
```
    Utility method to create a ILcdFilter that only accepts TLcyLayerContexts whose layers are accepted by isGXYLayerOfFormat(com.luciad.view.gxy.ILcdGXYLayer).
    
    Parameters:
    
    aAcceptArrays - if true, the filter will also accept arrays of TLcyLayerContext
    
    Returns:
    
    The ILcdFilter.
  - createDataSourceHandlers
```
protected ALcyDataSourceHandler[] createDataSourceHandlers()
```
    Creates ALcyDataSourceHandler(s) that are more general than ALcyFileTypeDescriptors.
    
    Returns:
    
    An array containing the ALcyDataSourceHandler instances. Must not be null but may have length 0. Must not contain null.
  - createDataSourceHandlerFileTypeDescriptors
```
protected ALcyFileTypeDescriptor[] createDataSourceHandlerFileTypeDescriptors()
```
    Creates the ALcyFileTypeDescriptor instances corresponding to the ALcyFileTypeDescriptor instances created by this format.
    
    Returns:
    
    The array of ALcyFileTypeDescriptor instances. Must not be null. Its length should be equal to the length of the array created by createDataSourceHandlers. It may contain null.
  - createDataSourceHandlerFileTypeDescriptorGroups
```
protected String[][] createDataSourceHandlerFileTypeDescriptorGroups()
```
    Creates file type descriptor groups for all decoders. The groups may be empty, but the group count must equal the decoder count.
    
    Returns:
    
    A two-dimensional array containing the groups for the ALcyFileTypeDescriptor instances of the ALcyFileTypeDescriptors. The first dimension must be equal to the length of the array of ALcyFileTypeDescriptor instances created by this format. It must not contain null, but may contain empty arrays.
  - createDataPropertyValueCustomizerPanelFactories
```
protected ILcyCustomizerPanelFactory[] createDataPropertyValueCustomizerPanelFactories()
```
    Creates the ILcyCustomizerPanelFactory factories that can create ILcyCustomizerPanel instances to change the value of a single data property of the domain objects created by the model decoders of this format.
    
    These customizer panels can for instance be used in the Table view or the Object properties.
    
    The created ILcyCustomizerPanels should work with instances of TLcdDataPropertyValueContext in their setObject method.
    
    The default implementation returns a zero-length array.
    
    Returns:
    
    An array of ILcyCustomizerPanelFactory instances. Must not be null but may have length 0. Must not contain null.
  - getDataSourceHandlers
```
public final ALcyDataSourceHandler[] getDataSourceHandlers()
```
    Returns the array of ALcyDataSourceHandler instances created by this format. Should only be called after createAll() has been called.
    
    Returns:
    
    The array of ALcyDataSourceHandlers created by this format.
    
    See Also:
    
    createDataSourceHandlers()
  - getDataSourceHandlerFileTypeDescriptors
```
public final ALcyFileTypeDescriptor[] getDataSourceHandlerFileTypeDescriptors()
```
    Returns the array of ALcyFileTypeDescriptor instances created by this format for data source handlers. Should only be called after createAll() has been called.
    
    Returns:
    
    The array of ALcyFileTypeDescriptor instances for data source handlers.
    
    See Also:
    
    createDataSourceHandlerFileTypeDescriptors(), getDataSourceHandlers()
  - getDataSourceHandlerFileTypeDescriptorGroups
```
public final String[][] getDataSourceHandlerFileTypeDescriptorGroups()
```
    Returns the ID's of the groups for the ALcyFileTypeDescriptor instances of the ALcyFileTypeDescriptor instances created by this format. Should only be called after createAll() has been called.
    
    Returns:
    
    The two-dimensional array of ID's of the groups for the ALcyFileTypeDescriptor instances.
    
    See Also:
    
    createDataSourceHandlerFileTypeDescriptorGroups(), getDataSourceHandlerFileTypeDescriptors()
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getDataPropertyValueCustomizerPanelFactories
```
public final ILcyCustomizerPanelFactory[] getDataPropertyValueCustomizerPanelFactories()
```
    Creates the ILcyCustomizerPanelFactory factories that can create ILcyCustomizerPanel instances to change the value of a single data property of the domain objects created by the model decoders of this format. Should only be called aftercreateAll() has been called.
    
    Returns:
    
    The array of ILcyCustomizerPanelFactorys.
    
    See Also:
    
    createDataPropertyValueCustomizerPanelFactories()

LuciadLightspeedClass ALcyFormat

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ALcyFormat

Method Detail

getLucyEnv

getLongPrefix

getShortPrefix

createAll

getBalloonContentProviders

getModelContentTypeProvider

getModelFactory

getDefaultModelDescriptorFactories

getModelDecoders

getModelDecoderFileTypeDescriptors

getModelDecoderFileTypeDescriptorGroups

getModelEncoders

getModelEncoderFileTypeDescriptors

getModelEncoderCustomizerPanelFactories

getModelEncoderCustomizerPanelWorkspaceCodecs

getModelWorkspaceCodecs

getDomainObjectWorkspaceCodecs

getModelCustomizerPanelWorkspaceCodecs

getModelCustomizerPanelFactories

getModelMetaDataCustomizerPanelFactories

getModelMetaDataCustomizerPanelWorkspaceCodecs

getDomainObjectCustomizerPanelFactories

getDomainObjectCustomizerPanelWorkspaceCodecs

getGXYLayerTypeProvider

getGXYLayerFactory

getGXYLayerStyleProvider

getGXYLayerDecoders

getGXYLayerDecoderFileTypeDescriptors

getGXYLayerEncoders

getGXYLayerEncoderFileTypeDescriptors

getAsynchronousPaintHintProvider

getGXYLayerWorkspaceCodecs

getGXYLayerCustomizerPanelFactories

getGXYLayerCustomizerPanelWorkspaceCodecs

getGXYLayerSelectionTransferHandlers

getFormatBarFactory

getLayerHeightProviderFactory

getModelHeightProviderFactory

getLabelPlacementHintProvider

createModelMeasureProviderFactory

getModelMeasureProviderFactory

createLayerMeasureProviderFactory

getLayerMeasureProviderFactory

isModelOfFormat

createModelContentTypeProvider

createBalloonContentProviders

createModelFactory

createDefaultModelDescriptorFactories

createModelDecoders

createModelDecoderFileTypeDescriptors

createModelDecoderFileTypeDescriptorGroups

createModelEncoders

createModelEncoderFileTypeDescriptors

createModelEncoderCustomizerPanelFactories

createModelEncoderCustomizerPanelWorkspaceCodecs

createModelWorkspaceCodecs

createDomainObjectWorkspaceCodecs

createModelCustomizerPanelWorkspaceCodecs

createModelCustomizerPanelFactories

createModelMetaDataCustomizerPanelFactories

createModelMetaDataCustomizerPanelWorkspaceCodecs

createDomainObjectCustomizerPanelFactories

createDomainObjectCustomizerPanelWorkspaceCodecs

createGXYLayerTypeProvider

createGXYLayerFactory

createGXYLayerStyleProvider

createAsynchronousPaintHintProvider

createGXYLayerDecoders

createGXYLayerDecoderFileTypeDescriptors

createGXYLayerEncoders

createGXYLayerEncoderFileTypeDescriptors

createGXYLayerWorkspaceCodecs

createGXYLayerCustomizerPanelFactories