ALcyFormatWrapper (LuciadLightspeed API documentation)

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

Direct Known Subclasses:

TLcyAsynchronousFormatWrapper, TLcyDrawingFormat, TLcyGXYAsynchronousLayerTreeNodeFormatWrapper, ~~TLcyGXYLayerTreeNodeFormatWrapper~~ , TLcyGXYLayerTreeNodeFormatWrapper2, TLcyGXYLspAsynchronousLayerTreeNodeFormatWrapper, TLcyModelListToTreeNodeFormatWrapper, TLcyMutableFileFormatWrapper, TLcySafeGuardFormatWrapper, TLcyTransformingModelFormatWrapper
```
public abstract class ALcyFormatWrapper
extends ALcyFormat
```
Convenience class to wrap an ALcyFormat: one only has to overwrite those methods that are required. This is also known as the decorator design pattern.

Note that wrapping an abstract class can be cumbersome because methods might be added to the abstract class in a newer version of the API. The advantage of extending from this ALcyFormatWrapper is that if methods are ever added to ALcyFormat, they will also be added here.

Constructor Summary

Constructors
Modifier Constructor and Description

protected ALcyFormatWrapper(ALcyFormat aFormat)
Creates a wrapper for the specified ALcyFormat.

Constructors
Modifier	Constructor and Description
`protected`	`ALcyFormatWrapper(ALcyFormat aFormat)` Creates a wrapper for the specified `ALcyFormat`.

Method Summary

All Methods Instance 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 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 ILcdGXYLayerFactory`	`createGXYLayerFactory()` Creates a `ILcdGXYLayerFactory` for this format.
`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 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.
`protected ILcdLayerHeightProviderFactory`	`createLayerHeightProviderFactory()` Creates the `ILcdLayerHeightProviderFactory` that can create an `ILcdHeightProvider` for this format.
`protected ILcdLayerMeasureProviderFactory`	`createLayerMeasureProviderFactory()` Creates the `ILcdLayerMeasureProviderFactory` for this format.
`protected ILcyModelContentTypeProvider`	`createModelContentTypeProvider()` Creates an `ILcyModelContentTypeProvider` for this format.
`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 ALcyFileTypeDescriptor[]`	`createModelDecoderFileTypeDescriptors()` Creates the `ALcyFileTypeDescriptor` instances corresponding to the `ILcdModelDecoder` instances created by this format.
`protected 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.
`protected ALcyWorkspaceObjectCodec[]`	`createModelWorkspaceCodecs()` Creates the `ALcyWorkspaceObjectCodec` codecs that can encode and decode the `ILcdModel` instances produces by the model decoders of this format.
`ALcyFormat`	`getFormat()` Returns the wrapped `ALcyFormat`.
`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.
`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.
`boolean`	`isModelOfFormat(ILcdModel aModel)` Returns true if and only if the given model is a model of the current data format.

Methods inherited from class com.luciad.lucy.format.ALcyFormat
createGXYLayerOfFormatFilter, createLayerContextOfFormatFilter, createModelContextOfFormatFilter, 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, toString

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

- Constructor Detail
  - ALcyFormatWrapper
```
protected ALcyFormatWrapper(ALcyFormat aFormat)
```
    Creates a wrapper for the specified ALcyFormat.
    
    Parameters:
    
    aFormat - The ALcyFormat to decorate. Must not be null.
- Method Detail
  - getFormat
```
public ALcyFormat getFormat()
```
    Returns the wrapped ALcyFormat.
    
    Returns:
    
    The wrapped ALcyFormat. Never null.
  - 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()
```
    Description copied from class: ALcyFormat
    
    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.
    
    Specified by:
    
    getShortPrefix in class ALcyFormat
    
    Returns:
    
    The short prefix of this format. Must not be null.
  - createAll
```
public void createAll()
```
    Description copied from class: ALcyFormat
    
    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.
    
    Overrides:
    
    createAll in class ALcyFormat
  - isModelOfFormat
```
public boolean isModelOfFormat(ILcdModel aModel)
```
    Description copied from class: ALcyFormat
    
    Returns true if and only if the given model is a model of the current data format.
    
    Specified by:
    
    isModelOfFormat in class ALcyFormat
    
    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 ILcyModelContentTypeProvider createModelContentTypeProvider()
```
    Description copied from class: ALcyFormat
    
    Creates an ILcyModelContentTypeProvider for this format.
    
    Specified by:
    
    createModelContentTypeProvider in class ALcyFormat
    
    Returns:
    
    the ILcyModelContentTypeProvider for this data format. May be null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - createModelFactory
```
protected ILcdModelFactory createModelFactory()
```
    Description copied from class: ALcyFormat
    
    Creates the ILcdModelFactory for this data format. All newly created models of the add-on are expected to be constructed through this factory.
    
    Overrides:
    
    createModelFactory in class ALcyFormat
    
    Returns:
    
    The ILcdModelFactory for this data format. May be null.
  - createDefaultModelDescriptorFactories
```
protected ALcyDefaultModelDescriptorFactory[] createDefaultModelDescriptorFactories()
```
    Description copied from class: ALcyFormat
    
    Creates the ALcyDefaultModelDescriptorFactorys for this data format.
    
    The default implementation returns a zero-length array.
    
    Overrides:
    
    createDefaultModelDescriptorFactories in class ALcyFormat
    
    Returns:
    
    The ALcyDefaultModelDescriptorFactory (or multiple) for this data format. Must not be null, but the array may have length 0.
  - createModelDecoders
```
protected ILcdModelDecoder[] createModelDecoders()
```
    Description copied from class: ALcyFormat
    
    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.
    
    Specified by:
    
    createModelDecoders in class ALcyFormat
    
    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 ALcyFileTypeDescriptor[] createModelDecoderFileTypeDescriptors()
```
    Description copied from class: ALcyFormat
    
    Creates the ALcyFileTypeDescriptor instances corresponding to the ILcdModelDecoder instances created by this format.
    
    Specified by:
    
    createModelDecoderFileTypeDescriptors in class ALcyFormat
    
    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()
```
    Description copied from class: ALcyFormat
    
    Creates file type descriptor groups for all decoders. The groups may be empty, but the group count must equal the decoder count.
    
    Overrides:
    
    createModelDecoderFileTypeDescriptorGroups in class ALcyFormat
    
    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()
```
    Description copied from class: ALcyFormat
    
    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.
    
    Overrides:
    
    createModelEncoders in class ALcyFormat
    
    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()
```
    Description copied from class: ALcyFormat
    
    Creates the array of ALcyFileTypeDescriptor instances for the ILcdModelEncoder instances created by this format.
    
    Overrides:
    
    createModelEncoderFileTypeDescriptors in class ALcyFormat
    
    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:
    
    ALcyFormat.createModelEncoders()
  - createModelEncoderCustomizerPanelFactories
```
protected ILcyCustomizerPanelFactory[] createModelEncoderCustomizerPanelFactories()
```
    Description copied from class: ALcyFormat
    
    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 ALcyFormat.createModelEncoderCustomizerPanelWorkspaceCodecs(). This is needed if your ILcyCustomizerPanels need to store any specific state in the workspace.
    
    Overrides:
    
    createModelEncoderCustomizerPanelFactories in class ALcyFormat
    
    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()
```
    Description copied from class: ALcyFormat
    
    Creates the ALcyWorkspaceObjectCodec codecs for the ILcyCustomizerPanel that customize the model encoder instances created by this class.
    
    Overrides:
    
    createModelEncoderCustomizerPanelWorkspaceCodecs 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
  - createModelCustomizerPanelWorkspaceCodecs
```
protected ALcyWorkspaceObjectCodec[] createModelCustomizerPanelWorkspaceCodecs()
```
    Description copied from class: ALcyFormat
    
    Creates the ALcyWorkspaceObjectCodec that can encode and decode the ILcyCustomizerPanel instances for the models produced by this format.
    
    Overrides:
    
    createModelCustomizerPanelWorkspaceCodecs 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
  - 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
  - createDomainObjectCustomizerPanelFactories
```
protected ILcyCustomizerPanelFactory[] createDomainObjectCustomizerPanelFactories()
```
    Description copied from class: ALcyFormat
    
    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 ALcyFormat.createDomainObjectCustomizerPanelWorkspaceCodecs(). This is needed if your ILcyCustomizerPanels need to store any specific state in the workspace.
    
    Overrides:
    
    createDomainObjectCustomizerPanelFactories in class ALcyFormat
    
    Returns:
    
    An array containing the ILcyCustomizerPanelFactory instances. Must not be null but may have length 0. Must not contain null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - createModelCustomizerPanelFactories
```
protected ILcyCustomizerPanelFactory[] createModelCustomizerPanelFactories()
```
    Description copied from class: ALcyFormat
    
    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 ALcyFormat.createModelCustomizerPanelWorkspaceCodecs(). This is needed if your ILcyCustomizerPanels need to store any specific state in the workspace.
    
    Overrides:
    
    createModelCustomizerPanelFactories in class ALcyFormat
    
    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()
```
    Description copied from class: ALcyFormat
    
    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 ALcyFormat.createModelMetaDataCustomizerPanelWorkspaceCodecs(). This is needed if your ILcyCustomizerPanels need to store any specific state in the workspace.
    
    Overrides:
    
    createModelMetaDataCustomizerPanelFactories in class ALcyFormat
    
    Returns:
    
    An array containing the ILcyCustomizerPanelFactory instances. Must not be null but may have length 0. Must not contain null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - createGXYLayerTypeProvider
```
protected ILcyGXYLayerTypeProvider createGXYLayerTypeProvider()
```
    Description copied from class: ALcyFormat
    
    Creates an ILcyGXYLayerTypeProvider for this format.
    
    Specified by:
    
    createGXYLayerTypeProvider in class ALcyFormat
    
    Returns:
    
    A ILcyGXYLayerTypeProvider for this data format. May be null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - createGXYLayerFactory
```
protected ILcdGXYLayerFactory createGXYLayerFactory()
```
    Description copied from class: ALcyFormat
    
    Creates a ILcdGXYLayerFactory for this format.
    The factory can also configure label algorithms on the created layers.
    
    Specified by:
    
    createGXYLayerFactory in class ALcyFormat
    
    Returns:
    
    the ILcdGXYLayerFactory for this data format. May be null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - 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
  - createGXYLayerDecoders
```
protected ILcdGXYLayerDecoder[] createGXYLayerDecoders()
```
    Description copied from class: ALcyFormat
    
    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.
    
    Overrides:
    
    createGXYLayerDecoders in class ALcyFormat
    
    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()
```
    Description copied from class: ALcyFormat
    
    Creates ALcyFileTypeDescriptors for the ILcdGXYLayerDecoders. The length of the returned array must be equal to that of ALcyFormat.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.
    
    Overrides:
    
    createGXYLayerDecoderFileTypeDescriptors in class ALcyFormat
    
    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()
```
    Description copied from class: ALcyFormat
    
    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.
    
    Overrides:
    
    createGXYLayerEncoders in class ALcyFormat
    
    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()
```
    Description copied from class: ALcyFormat
    
    Creates ALcyFileTypeDescriptors for the ILcdGXYLayerEncoders. The length of the returned array must be equal to that of ALcyFormat.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.
    
    Overrides:
    
    createGXYLayerEncoderFileTypeDescriptors in class ALcyFormat
    
    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:
    
    ALcyFormat.createGXYLayerEncoders()
  - createGXYLayerWorkspaceCodecs
```
protected ALcyWorkspaceObjectCodec[] createGXYLayerWorkspaceCodecs()
```
    Description copied from class: ALcyFormat
    
    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.
    
    Overrides:
    
    createGXYLayerWorkspaceCodecs 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
  - createGXYLayerCustomizerPanelFactories
```
protected ILcyCustomizerPanelFactory[] createGXYLayerCustomizerPanelFactories()
```
    Description copied from class: ALcyFormat
    
    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 ALcyFormat.createGXYLayerCustomizerPanelWorkspaceCodecs(). This is needed if your ILcyCustomizerPanels need to store any specific state in the workspace.
    
    Overrides:
    
    createGXYLayerCustomizerPanelFactories in class ALcyFormat
    
    Returns:
    
    An array of ILcyCustomizerPanelFactory instances. Must not be null but may have length 0. Must not contain null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - isGXYLayerOfFormat
```
public boolean isGXYLayerOfFormat(ILcdGXYLayer aGXYLayer)
```
    Description copied from class: ALcyFormat
    
    Returns true if and only if the given layer is a layer of the current data format.
    
    Overrides:
    
    isGXYLayerOfFormat in class ALcyFormat
    
    Parameters:
    
    aGXYLayer - The layer to check.
    
    Returns:
    
    true if and only if the given layer is a layer of the current data format.
  - createGXYLayerSelectionTransferHandlers
```
protected ALcyLayerSelectionTransferHandler[] createGXYLayerSelectionTransferHandlers()
```
    Description copied from class: ALcyFormat
    
    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.
    
    Overrides:
    
    createGXYLayerSelectionTransferHandlers in class ALcyFormat
    
    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()
```
    Description copied from class: ALcyFormat
    
    Creates the ALcyFormatBarFactory that can create a bar to manipulate layers of this format.
    
    The default implementation returns null.
    
    Overrides:
    
    createFormatBarFactory in class ALcyFormat
    
    Returns:
    
    An ALcyFormatBarFactory. May be null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - createModelHeightProviderFactory
```
protected ILcdModelHeightProviderFactory createModelHeightProviderFactory()
```
    Description copied from class: ALcyFormat
    
    Creates the ILcdModelHeightProviderFactory that can create an ILcdHeightProvider for this format.
    
    The default implementation returns null.
    
    Overrides:
    
    createModelHeightProviderFactory in class ALcyFormat
    
    Returns:
    
    An ILcdModelHeightProviderFactory. May be null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - createLayerHeightProviderFactory
```
protected ILcdLayerHeightProviderFactory createLayerHeightProviderFactory()
```
    Description copied from class: ALcyFormat
    
    Creates the ILcdLayerHeightProviderFactory that can create an ILcdHeightProvider for this format.
    
    The default implementation returns null.
    
    Overrides:
    
    createLayerHeightProviderFactory in class ALcyFormat
    
    Returns:
    
    An ILcdLayerHeightProviderFactory. May be null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - createLabelPlacementHintProvider
```
protected ILcyGXYLabelPlacementHintProvider createLabelPlacementHintProvider()
```
    Description copied from class: ALcyFormat
    
    Creates the ILcyLabelPlacementHintProvider that can create a TLcyGXYLabelPlacementHint for layers of this format.
    The default implementation returns null.
    
    Overrides:
    
    createLabelPlacementHintProvider in class ALcyFormat
    
    Returns:
    
    An ILcyLabelPlacementHintProvider. May be null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - createGXYLayerStyleProvider
```
protected ILcyLayerStyleProvider createGXYLayerStyleProvider()
```
    Description copied from class: ALcyFormat
    
    Creates the style provider that can retrieve and encode the style of the layers created by the layer factory of this format.
    
    Overrides:
    
    createGXYLayerStyleProvider in class ALcyFormat
    
    Returns:
    
    the style provider to retrieve and encode the style of the layers. May be null
  - createGXYLayerCustomizerPanelWorkspaceCodecs
```
protected ALcyWorkspaceObjectCodec[] createGXYLayerCustomizerPanelWorkspaceCodecs()
```
    Description copied from class: ALcyFormat
    
    Creates the ALcyWorkspaceObjectCodec codecs for the ILcyCustomizerPanel instances for the layers created by the layer factories of this format.
    
    Overrides:
    
    createGXYLayerCustomizerPanelWorkspaceCodecs 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
  - createDomainObjectCustomizerPanelWorkspaceCodecs
```
protected ALcyWorkspaceObjectCodec[] createDomainObjectCustomizerPanelWorkspaceCodecs()
```
    Description copied from class: ALcyFormat
    
    Creates the ALcyWorkspaceObjectCodec codecs for the ILcyCustomizerPanel instances for the domain objects created by the model decoders of this format.
    
    Overrides:
    
    createDomainObjectCustomizerPanelWorkspaceCodecs 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
  - createModelMetaDataCustomizerPanelWorkspaceCodecs
```
protected ALcyWorkspaceObjectCodec[] createModelMetaDataCustomizerPanelWorkspaceCodecs()
```
    Description copied from class: ALcyFormat
    
    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.
    
    Overrides:
    
    createModelMetaDataCustomizerPanelWorkspaceCodecs 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
  - createDataSourceHandlerFileTypeDescriptorGroups
```
protected String[][] createDataSourceHandlerFileTypeDescriptorGroups()
```
    Description copied from class: ALcyFormat
    
    Creates file type descriptor groups for all decoders. The groups may be empty, but the group count must equal the decoder count.
    
    Overrides:
    
    createDataSourceHandlerFileTypeDescriptorGroups in class ALcyFormat
    
    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.
  - createDataSourceHandlerFileTypeDescriptors
```
protected ALcyFileTypeDescriptor[] createDataSourceHandlerFileTypeDescriptors()
```
    Description copied from class: ALcyFormat
    
    Creates the ALcyFileTypeDescriptor instances corresponding to the ALcyFileTypeDescriptor instances created by this format.
    
    Overrides:
    
    createDataSourceHandlerFileTypeDescriptors in class ALcyFormat
    
    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.
  - createDataSourceHandlers
```
protected ALcyDataSourceHandler[] createDataSourceHandlers()
```
    Description copied from class: ALcyFormat
    
    Creates ALcyDataSourceHandler(s) that are more general than ALcyFileTypeDescriptors.
    
    Overrides:
    
    createDataSourceHandlers in class ALcyFormat
    
    Returns:
    
    An array containing the ALcyDataSourceHandler instances. Must not be null but may have length 0. Must not contain null.
  - createDataPropertyValueCustomizerPanelFactories
```
protected ILcyCustomizerPanelFactory[] createDataPropertyValueCustomizerPanelFactories()
```
    Description copied from class: ALcyFormat
    
    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.
    
    Overrides:
    
    createDataPropertyValueCustomizerPanelFactories in class ALcyFormat
    
    Returns:
    
    An array of ILcyCustomizerPanelFactory instances. Must not be null but may have length 0. Must not contain null.
  - createBalloonContentProviders
```
protected ILcdBalloonContentProvider[] createBalloonContentProviders()
```
    Description copied from class: ALcyFormat
    
    Creates the ILcdBalloonContentProviders for this format.
    
    The default implementation returns an empty array.
    
    Overrides:
    
    createBalloonContentProviders in class ALcyFormat
    
    Returns:
    
    the ILcdBalloonContentProviders for this format. Must not be null. The array may be empty but not contain null.
  - createModelMeasureProviderFactory
```
protected ILcdModelMeasureProviderFactory createModelMeasureProviderFactory()
```
    Description copied from class: ALcyFormat
    
    Creates the ILcdModelMeasureProviderFactory for this format.
    
    The default implementation returns null.
    
    Overrides:
    
    createModelMeasureProviderFactory in class ALcyFormat
    
    Returns:
    
    the ILcdModelMeasureProviderFactory for this format. Can be null.
    
    See Also:
    
    ALcyFormat.getModelMeasureProviderFactory()
  - createLayerMeasureProviderFactory
```
protected ILcdLayerMeasureProviderFactory createLayerMeasureProviderFactory()
```
    Description copied from class: ALcyFormat
    
    Creates the ILcdLayerMeasureProviderFactory for this format.
    
    The default implementation returns null.
    
    Overrides:
    
    createLayerMeasureProviderFactory in class ALcyFormat
    
    Returns:
    
    the ILcdLayerMeasureProviderFactory for this format. Can be null.
    
    See Also:
    
    ALcyFormat.getLayerMeasureProviderFactory()

LuciadLightspeedClass ALcyFormatWrapper

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

ALcyFormatWrapper

Method Detail

getFormat

getLucyEnv

getLongPrefix

getShortPrefix

createAll

isModelOfFormat

createModelContentTypeProvider

createModelFactory

createDefaultModelDescriptorFactories

createModelDecoders

createModelDecoderFileTypeDescriptors

createModelDecoderFileTypeDescriptorGroups

createModelEncoders

createModelEncoderFileTypeDescriptors

createModelEncoderCustomizerPanelFactories

createModelEncoderCustomizerPanelWorkspaceCodecs

createModelCustomizerPanelWorkspaceCodecs

createModelWorkspaceCodecs

createDomainObjectWorkspaceCodecs

createDomainObjectCustomizerPanelFactories

createModelCustomizerPanelFactories

createModelMetaDataCustomizerPanelFactories

createGXYLayerTypeProvider

createGXYLayerFactory

createAsynchronousPaintHintProvider

createGXYLayerDecoders

createGXYLayerDecoderFileTypeDescriptors

createGXYLayerEncoders

createGXYLayerEncoderFileTypeDescriptors

createGXYLayerWorkspaceCodecs

createGXYLayerCustomizerPanelFactories

isGXYLayerOfFormat

createGXYLayerSelectionTransferHandlers

createFormatBarFactory

createModelHeightProviderFactory

createLayerHeightProviderFactory

createLabelPlacementHintProvider

createGXYLayerStyleProvider

createGXYLayerCustomizerPanelWorkspaceCodecs

createDomainObjectCustomizerPanelWorkspaceCodecs

createModelMetaDataCustomizerPanelWorkspaceCodecs

createDataSourceHandlerFileTypeDescriptorGroups

createDataSourceHandlerFileTypeDescriptors

createDataSourceHandlers

createDataPropertyValueCustomizerPanelFactories

createBalloonContentProviders

createModelMeasureProviderFactory

createLayerMeasureProviderFactory