TLcySafeGuardFormatWrapper (LuciadLightspeed API documentation)

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

public class TLcySafeGuardFormatWrapper
extends ALcyFormatWrapper

Decorator for an ALcyFormat that safe guards all operations on models and layers to make sure no invalid models or layers are ever accepted or handled. It relies on the implementation of isModelOfFormat(com.luciad.model.ILcdModel) and isGXYLayerOfFormat(com.luciad.view.gxy.ILcdGXYLayer) of the given ALcyFormat to do so.

As a result, implementers of an ALcyFormat can simplify this type of code:


 protected ILcyModelContentTypeProvider createModelContentTypeProvider() {
   return new ILcyModelContentTypeProvider() {
     public int getModelContentType( ILcdModel aModel ) {
       if ( aModel.getModelDescriptor() instanceof TLcdSHPModelDescriptor ) {
         return MIXED;
       }
       else {
         return UNKNOWN;
       }
     }
   };
 }

to this:


  protected ILcyModelContentTypeProvider createModelContentTypeProvider() {
   return new ILcyModelContentTypeProvider() {
     public int getModelContentType( ILcdModel aModel ) {
       return MIXED;
     }
   };
 }

which is easier and less error prone. Similar simplifications apply to all other concepts such as ILcdGXYLayerFactory, ILcdGXYLayerEncoder etc.

Constructor Summary

Constructors
Constructor and Description

TLcySafeGuardFormatWrapper(ALcyFormat aFormat)
Creates a new TLcySafeGuardFormatWrapper around the given ALcyFormat.

Constructors
Constructor and Description
`TLcySafeGuardFormatWrapper(ALcyFormat aFormat)` Creates a new `TLcySafeGuardFormatWrapper` around the given `ALcyFormat`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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 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 ILcdGXYLayerDecoder[]`	`createGXYLayerDecoders()` Creates the `ILcdGXYLayerDecoder` decoders that can decode layers for models created by the model decoders of this format.
`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.
`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 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 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.
`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.ALcyFormatWrapper
createAll, createDataSourceHandlerFileTypeDescriptorGroups, createDataSourceHandlerFileTypeDescriptors, createDataSourceHandlers, createGXYLayerDecoderFileTypeDescriptors, createGXYLayerEncoderFileTypeDescriptors, createModelDecoderFileTypeDescriptorGroups, createModelDecoderFileTypeDescriptors, createModelEncoderFileTypeDescriptors, getFormat, getLongPrefix, getLucyEnv, getShortPrefix

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
  - TLcySafeGuardFormatWrapper
```
public TLcySafeGuardFormatWrapper(ALcyFormat aFormat)
```
    Creates a new TLcySafeGuardFormatWrapper around the given ALcyFormat.
    
    Parameters:
    
    aFormat - The format to wrap.
- Method Detail
  - 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.
    
    Overrides:
    
    isModelOfFormat in class ALcyFormatWrapper
    
    Parameters:
    
    aModel - The model to check.
    
    Returns:
    
    true if and only if the given model is a model of the current data format.
  - createModelContentTypeProvider
```
public ILcyModelContentTypeProvider createModelContentTypeProvider()
```
    Description copied from class: ALcyFormat
    
    Creates an ILcyModelContentTypeProvider for this format.
    
    Overrides:
    
    createModelContentTypeProvider in class ALcyFormatWrapper
    
    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 ALcyFormatWrapper
    
    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 ALcyFormatWrapper
    
    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.
    
    Overrides:
    
    createModelDecoders in class ALcyFormatWrapper
    
    Returns:
    
    The ILcdModelDecoder (or multiple) for this data format. Must not be null, but the array may have length 0.
    
    See Also:
    
    TLcdStatusInputStreamFactory
  - 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 ALcyFormatWrapper
    
    Returns:
    
    An array of ILcdModelEncoder instances. Must not be null, but may have length 0. Must not contain null.
    
    See Also:
    
    TLcdStatusOutputStreamFactory
  - 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 ALcyFormatWrapper
    
    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 ALcyFormatWrapper
    
    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()
```
    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 ALcyFormatWrapper
    
    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 ALcyFormatWrapper
    
    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 ALcyFormatWrapper
    
    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()
```
    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 ALcyFormatWrapper
    
    Returns:
    
    An array containing the ALcyWorkspaceObjectCodec 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 ALcyFormatWrapper
    
    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 ALcyFormatWrapper
    
    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()
```
    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 ALcyFormatWrapper
    
    Returns:
    
    An array of ALcyWorkspaceObjectCodec 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.
    
    Overrides:
    
    createGXYLayerTypeProvider in class ALcyFormatWrapper
    
    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.
    
    Overrides:
    
    createGXYLayerFactory in class ALcyFormatWrapper
    
    Returns:
    
    the ILcdGXYLayerFactory for this data 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 ALcyFormatWrapper
    
    Returns:
    
    An array of layer decoders. It must not be null, but may have length 0. It must not contain null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - 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 ALcyFormatWrapper
    
    Returns:
    
    An array of ILcdGXYLayerEncoder instances. Must not be null but may have length 0. Must not contain null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper, TLcdStatusOutputStreamFactory
  - createAsynchronousPaintHintProvider
```
protected ILcyAsynchronousPaintHintProvider createAsynchronousPaintHintProvider()
```
    Description copied from class: ALcyFormat
    
    Creates a ILcyAsynchronousPaintHintProvider for this format.
    
    Overrides:
    
    createAsynchronousPaintHintProvider in class ALcyFormatWrapper
    
    Returns:
    
    A ILcyAsynchronousPaintHintProvider for the layers created by the layer factories of this format. May be null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - 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 ALcyFormatWrapper
    
    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 ALcyFormatWrapper
    
    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()
```
    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 ALcyFormatWrapper
    
    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 ALcyFormatWrapper
    
    Returns:
    
    An array of ALcyWorkspaceObjectCodec instances. Must not be null but may have length 0. Must not contain null.
    
    See Also:
    
    TLcySafeGuardFormatWrapper
  - 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 ALcyFormatWrapper
    
    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 ALcyFormatWrapper
    
    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 ALcyFormatWrapper
    
    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 ALcyFormatWrapper
    
    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 ALcyFormatWrapper
    
    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 ALcyFormatWrapper
    
    Returns:
    
    the style provider to retrieve and encode the style of the layers. May be 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 ALcyFormatWrapper
    
    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 ALcyFormatWrapper
    
    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 ALcyFormatWrapper
    
    Returns:
    
    the ILcdLayerMeasureProviderFactory for this format. Can be null.
    
    See Also:
    
    ALcyFormat.getLayerMeasureProviderFactory()
  - 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 ALcyFormatWrapper
    
    Returns:
    
    An array of ILcyCustomizerPanelFactory instances. Must not be null but may have length 0. Must not contain null.
  - 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 ALcyFormatWrapper
    
    Parameters:
    
    aGXYLayer - The layer to check.
    
    Returns:
    
    true if and only if the given layer is a layer of the current data format.

LuciadLightspeedClass TLcySafeGuardFormatWrapper

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

TLcySafeGuardFormatWrapper

Method Detail

isModelOfFormat

createModelContentTypeProvider

createModelFactory

createDefaultModelDescriptorFactories

createModelDecoders

createModelEncoders

createModelEncoderCustomizerPanelFactories

createModelEncoderCustomizerPanelWorkspaceCodecs

createModelWorkspaceCodecs

createDomainObjectWorkspaceCodecs

createDomainObjectCustomizerPanelFactories

createDomainObjectCustomizerPanelWorkspaceCodecs

createModelCustomizerPanelFactories

createModelMetaDataCustomizerPanelFactories

createModelMetaDataCustomizerPanelWorkspaceCodecs

createGXYLayerTypeProvider

createGXYLayerFactory

createGXYLayerDecoders

createGXYLayerEncoders

createAsynchronousPaintHintProvider

createGXYLayerWorkspaceCodecs

createGXYLayerCustomizerPanelFactories

createGXYLayerCustomizerPanelWorkspaceCodecs

createModelCustomizerPanelWorkspaceCodecs

createGXYLayerSelectionTransferHandlers

createFormatBarFactory

createModelHeightProviderFactory

createLayerHeightProviderFactory

createLabelPlacementHintProvider

createGXYLayerStyleProvider

createBalloonContentProviders

createModelMeasureProviderFactory

createLayerMeasureProviderFactory

createDataPropertyValueCustomizerPanelFactories

isGXYLayerOfFormat