Class ALcyFormatWrapper
- Direct Known Subclasses:
TLcyAsynchronousFormatWrapper
,TLcyDrawingFormat
,TLcyGXYAsynchronousLayerTreeNodeFormatWrapper
,TLcyGXYLayerTreeNodeFormatWrapper
,TLcyGXYLayerTreeNodeFormatWrapper2
,TLcyGXYLspAsynchronousLayerTreeNodeFormatWrapper
,TLcyModelListToTreeNodeFormatWrapper
,TLcyMutableFileFormatWrapper
,TLcySafeGuardFormatWrapper
,TLcyTransformingModelFormatWrapper
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
ModifierConstructorDescriptionprotected
ALcyFormatWrapper
(ALcyFormat aFormat) Creates a wrapper for the specifiedALcyFormat
. -
Method Summary
Modifier and TypeMethodDescriptionvoid
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
Creates aILcyAsynchronousPaintHintProvider
for this format.protected ILcdBalloonContentProvider[]
Creates theILcdBalloonContentProvider
s for this format.protected ILcyCustomizerPanelFactory[]
Creates theILcyCustomizerPanelFactory
factories that can createILcyCustomizerPanel
instances to change the value of a single data property of the domain objects created by the model decoders of this format.protected String[][]
Creates file type descriptor groups for all decoders.protected ALcyFileTypeDescriptor[]
Creates theALcyFileTypeDescriptor
instances corresponding to theALcyFileTypeDescriptor
instances created by this format.protected ALcyDataSourceHandler[]
CreatesALcyDataSourceHandler
(s) that are more general thanALcyFileTypeDescriptor
s.protected ALcyDefaultModelDescriptorFactory[]
Creates theALcyDefaultModelDescriptorFactory
s for this data format.protected ILcyCustomizerPanelFactory[]
Creates theILcyCustomizerPanelFactory
factories that can createILcyCustomizerPanel
instances for the domain objects created by the model decoders of this format.protected ALcyWorkspaceObjectCodec[]
Creates theALcyWorkspaceObjectCodec
codecs for theILcyCustomizerPanel
instances for the domain objects created by the model decoders of this format.protected ALcyWorkspaceObjectCodec[]
Creates theALcyWorkspaceObjectCodec
that can encode and decode theILcyCustomizerPanel
instances for the domain objects produced by the model decoders of this format.protected ALcyFormatBarFactory
Creates theALcyFormatBarFactory
that can create a bar to manipulate layers of this format.protected ILcyCustomizerPanelFactory[]
Creates theILcyCustomizerPanelFactory
factories that can createILcyCustomizerPanel
instances for the layers created by the layer factories of this format.protected ALcyWorkspaceObjectCodec[]
Creates theALcyWorkspaceObjectCodec
codecs for theILcyCustomizerPanel
instances for the layers created by the layer factories of this format.protected ALcyFileTypeDescriptor[]
CreatesALcyFileTypeDescriptor
s for theILcdGXYLayerDecoder
s.protected ILcdGXYLayerDecoder[]
Creates theILcdGXYLayerDecoder
decoders that can decode layers for models created by the model decoders of this format.protected ALcyFileTypeDescriptor[]
CreatesALcyFileTypeDescriptor
s for theILcdGXYLayerEncoder
s.protected ILcdGXYLayerEncoder[]
Creates theILcdGXYLayerEncoder
encoders for the layers created by the layer factories of this format.protected ILcdGXYLayerFactory
Creates aILcdGXYLayerFactory
for this format.protected ALcyLayerSelectionTransferHandler[]
Creates theALcyLayerSelectionTransferHandler
transfer handlers that can transfer the selection of the 2D layers created by the layer factories of this format.protected ILcyLayerStyleProvider
Creates the style provider that can retrieve and encode the style of the layers created by the layer factory of this format.protected ILcyGXYLayerTypeProvider
Creates anILcyGXYLayerTypeProvider
for this format.protected ALcyWorkspaceObjectCodec[]
Creates theALcyWorkspaceObjectCodec
codecs that can encode and decode the layers created by the layer factories of this format.protected ILcyGXYLabelPlacementHintProvider
Creates theILcyLabelPlacementHintProvider
that can create aTLcyGXYLabelPlacementHint
for layers of this format.protected ILcdLayerHeightProviderFactory
Creates theILcdLayerHeightProviderFactory
that can create anILcdHeightProvider
for this format.protected ILcdLayerMeasureProviderFactory
Creates theILcdLayerMeasureProviderFactory
for this format.protected ILcyModelContentTypeProvider
Creates anILcyModelContentTypeProvider
for this format.protected ILcyCustomizerPanelFactory[]
Creates theILcyCustomizerPanelFactory
(s) that can createILcyCustomizerPanel
instances to customize the models produced by the model decoders and model factories of this format.protected ALcyWorkspaceObjectCodec[]
Creates theALcyWorkspaceObjectCodec
that can encode and decode theILcyCustomizerPanel
instances for the models produced by this format.protected String[][]
Creates file type descriptor groups for all decoders.protected ALcyFileTypeDescriptor[]
Creates theALcyFileTypeDescriptor
instances corresponding to theILcdModelDecoder
instances created by this format.protected ILcdModelDecoder[]
Creates theILcdModelDecoder
decoders for this data format.protected ILcyCustomizerPanelFactory[]
Creates theILcyCustomizerPanelFactory
instances for theILcdModelEncoder
instances created by this class.protected ALcyWorkspaceObjectCodec[]
Creates theALcyWorkspaceObjectCodec
codecs for theILcyCustomizerPanel
that customize the model encoder instances created by this class.protected ALcyFileTypeDescriptor[]
Creates the array ofALcyFileTypeDescriptor
instances for theILcdModelEncoder
instances created by this format.protected ILcdModelEncoder[]
Creates the model encoders for this data format.protected ILcdModelFactory
Creates theILcdModelFactory
for this data format.protected ILcdModelHeightProviderFactory
Creates theILcdModelHeightProviderFactory
that can create anILcdHeightProvider
for this format.protected ILcdModelMeasureProviderFactory
Creates theILcdModelMeasureProviderFactory
for this format.protected ILcyCustomizerPanelFactory[]
Creates theILcyCustomizerPanelFactory
(s) that can createILcyCustomizerPanel
instances to customize the meta data of the models produced by the model decoders and model factories of this format.protected ALcyWorkspaceObjectCodec[]
Creates theALcyWorkspaceObjectCodec
codecs that can encode and decode theILcyCustomizerPanel
instances used to customize the meta data of the models produced by this format.protected ALcyWorkspaceObjectCodec[]
Creates theALcyWorkspaceObjectCodec
codecs that can encode and decode theILcdModel
instances produces by the model decoders of this format.Returns the wrappedALcyFormat
.Returns the long prefix of this format that can be used, for instance, to derive UID's.Returns theILcyLucyEnv
backend with which thisALcyFormat
is associated.Returns the short prefix of this format that can be used, for instance, to derive keys for aALcyProperties
instance.boolean
isGXYLayerOfFormat
(ILcdGXYLayer aGXYLayer) Returnstrue
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
-
Constructor Details
-
ALcyFormatWrapper
Creates a wrapper for the specified
ALcyFormat
.- Parameters:
aFormat
- TheALcyFormat
to decorate. Must not benull
.
-
-
Method Details
-
getFormat
Returns the wrapped
ALcyFormat
.- Returns:
- The wrapped
ALcyFormat
. Nevernull
.
-
getLucyEnv
Description copied from class:ALcyFormat
Returns the
ILcyLucyEnv
backend with which thisALcyFormat
is associated.- Specified by:
getLucyEnv
in classALcyFormat
- Returns:
- The
ILcyLucyEnv
backend. Must not benull
.
-
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 classALcyFormat
- Returns:
- The long prefix that can be used to generate UID's. Must not be
null
.
-
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 classALcyFormat
- 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 classALcyFormat
-
isModelOfFormat
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 classALcyFormat
- Parameters:
aModel
- The model to check.- Returns:
true
if and only if the given model is a model of the current data format.
-
createModelContentTypeProvider
Description copied from class:ALcyFormat
Creates an
ILcyModelContentTypeProvider
for this format.- Specified by:
createModelContentTypeProvider
in classALcyFormat
- Returns:
- the
ILcyModelContentTypeProvider
for this data format. May benull
. - See Also:
-
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 classALcyFormat
- Returns:
- The
ILcdModelFactory
for this data format. May benull
.
-
createDefaultModelDescriptorFactories
Description copied from class:ALcyFormat
Creates the
ALcyDefaultModelDescriptorFactory
s for this data format.The default implementation returns a zero-length array.
- Overrides:
createDefaultModelDescriptorFactories
in classALcyFormat
- Returns:
- The
ALcyDefaultModelDescriptorFactory
(or multiple) for this data format. Must not benull
, but the array may have length0
.
-
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 classALcyFormat
- Returns:
- The
ILcdModelDecoder
(or multiple) for this data format. Must not benull
, but the array may have length0
. - See Also:
-
createModelDecoderFileTypeDescriptors
Description copied from class:ALcyFormat
Creates the
ALcyFileTypeDescriptor
instances corresponding to theILcdModelDecoder
instances created by this format.- Specified by:
createModelDecoderFileTypeDescriptors
in classALcyFormat
- Returns:
- The array of
ALcyFileTypeDescriptor
instances. Must not benull
. Its length should be equal to the length of the array created bycreateModelDecoders
. It may containnull
.
-
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 classALcyFormat
- Returns:
- A two-dimensional array containing the groups for the
ALcyFileTypeDescriptor
instances of theILcdModelDecoder
s. The first dimension must be equal to the length of the array ofILcdModelDecoder
instances created by this format. It must not containnull
, but may contain empty arrays.
-
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 classALcyFormat
- Returns:
- An array of
ILcdModelEncoder
instances. Must not benull
, but may have length0
. Must not containnull
. - See Also:
-
createModelEncoderFileTypeDescriptors
Description copied from class:ALcyFormat
Creates the array of
ALcyFileTypeDescriptor
instances for theILcdModelEncoder
instances created by this format.- Overrides:
createModelEncoderFileTypeDescriptors
in classALcyFormat
- Returns:
- The array of
ALcyFileTypeDescriptor
instances. Must not benull
and its length must be equal to the length of the array ofILcdModelEncoder
instances created by this format. May containnull
. - See Also:
-
createModelEncoderCustomizerPanelFactories
Description copied from class:ALcyFormat
Creates the
ILcyCustomizerPanelFactory
instances for theILcdModelEncoder
instances created by this class.The created
ILcyCustomizerPanel
s should work with instances ofTLcyModelEncoderContext
in theirsetObject
method.Hint: When overriding this method, you should also consider overriding
ALcyFormat.createModelEncoderCustomizerPanelWorkspaceCodecs()
. This is needed if yourILcyCustomizerPanel
s need to store any specific state in the workspace.- Overrides:
createModelEncoderCustomizerPanelFactories
in classALcyFormat
- Returns:
- An array of
ILcyCustomizerPanelFactory
instances. Must not benull
but may have length0
. Must not containnull
. - See Also:
-
createModelEncoderCustomizerPanelWorkspaceCodecs
Description copied from class:ALcyFormat
Creates the
ALcyWorkspaceObjectCodec
codecs for theILcyCustomizerPanel
that customize the model encoder instances created by this class.- Overrides:
createModelEncoderCustomizerPanelWorkspaceCodecs
in classALcyFormat
- Returns:
- An array containing the
ALcyWorkspaceObjectCodec
instances. Must not benull
, but may have length0
. Must not containnull
. - See Also:
-
createModelCustomizerPanelWorkspaceCodecs
Description copied from class:ALcyFormat
Creates the
ALcyWorkspaceObjectCodec
that can encode and decode theILcyCustomizerPanel
instances for the models produced by this format.- Overrides:
createModelCustomizerPanelWorkspaceCodecs
in classALcyFormat
- Returns:
- An array of
ALcyWorkspaceObjectCodec
instances. Must not benull
but may have length0
. Must not containnull
. - See Also:
-
createModelWorkspaceCodecs
Description copied from class:ALcyFormat
Creates the
ALcyWorkspaceObjectCodec
codecs that can encode and decode theILcdModel
instances produces by the model decoders of this format.- Overrides:
createModelWorkspaceCodecs
in classALcyFormat
- Returns:
- An array containing the
ALcyWorkspaceObjectCodec
instances. Must not benull
, but may have length0
. Must not containnull
. - See Also:
-
createDomainObjectWorkspaceCodecs
Description copied from class:ALcyFormat
Creates the
ALcyWorkspaceObjectCodec
that can encode and decode theILcyCustomizerPanel
instances for the domain objects produced by the model decoders of this format.- Overrides:
createDomainObjectWorkspaceCodecs
in classALcyFormat
- Returns:
- An array of
ALcyWorkspaceObjectCodec
instances. Must not benull
but may have length0
. Must not containnull
. - See Also:
-
createDomainObjectCustomizerPanelFactories
Description copied from class:ALcyFormat
Creates the
ILcyCustomizerPanelFactory
factories that can createILcyCustomizerPanel
instances for the domain objects created by the model decoders of this format.The created
ILcyCustomizerPanel
s should work with instances ofTLcyDomainObjectContext
in theirsetObject
method.Hint: When overriding this method, you should also consider overriding
ALcyFormat.createDomainObjectCustomizerPanelWorkspaceCodecs()
. This is needed if yourILcyCustomizerPanel
s need to store any specific state in the workspace.- Overrides:
createDomainObjectCustomizerPanelFactories
in classALcyFormat
- Returns:
- An array containing the
ILcyCustomizerPanelFactory
instances. Must not benull
but may have length0
. Must not containnull
. - See Also:
-
createModelCustomizerPanelFactories
Description copied from class:ALcyFormat
Creates the
ILcyCustomizerPanelFactory
(s) that can createILcyCustomizerPanel
instances to customize the models produced by the model decoders and model factories of this format.The created
ILcyCustomizerPanel
s should work with instances ofTLcyModelContext
in theirsetObject
method.Hint: When overriding this method, you should also consider overriding
ALcyFormat.createModelCustomizerPanelWorkspaceCodecs()
. This is needed if yourILcyCustomizerPanel
s need to store any specific state in the workspace.- Overrides:
createModelCustomizerPanelFactories
in classALcyFormat
- Returns:
- An array containing the
ILcyCustomizerPanelFactory
instances. Must not benull
but may have length0
. Must not containnull
. - See Also:
-
createModelMetaDataCustomizerPanelFactories
Description copied from class:ALcyFormat
Creates the
ILcyCustomizerPanelFactory
(s) that can createILcyCustomizerPanel
instances to customize the meta data of the models produced by the model decoders and model factories of this format.The created
ILcyCustomizerPanel
s should work with instances ofTLcyModelMetaDataContext
in theirsetObject
method.Hint: When overriding this method, you should also consider overriding
ALcyFormat.createModelMetaDataCustomizerPanelWorkspaceCodecs()
. This is needed if yourILcyCustomizerPanel
s need to store any specific state in the workspace.- Overrides:
createModelMetaDataCustomizerPanelFactories
in classALcyFormat
- Returns:
- An array containing the
ILcyCustomizerPanelFactory
instances. Must not benull
but may have length0
. Must not containnull
. - See Also:
-
createGXYLayerTypeProvider
Description copied from class:ALcyFormat
Creates an
ILcyGXYLayerTypeProvider
for this format.- Specified by:
createGXYLayerTypeProvider
in classALcyFormat
- Returns:
- A
ILcyGXYLayerTypeProvider
for this data format. May benull
. - See Also:
-
createGXYLayerFactory
Description copied from class:ALcyFormat
Creates a
The factory can also configure label algorithms on the created layers.ILcdGXYLayerFactory
for this format.- Specified by:
createGXYLayerFactory
in classALcyFormat
- Returns:
- the
ILcdGXYLayerFactory
for this data format. May benull
. - See Also:
-
createAsynchronousPaintHintProvider
Description copied from class:ALcyFormat
Creates a
ILcyAsynchronousPaintHintProvider
for this format.- Specified by:
createAsynchronousPaintHintProvider
in classALcyFormat
- Returns:
- A
ILcyAsynchronousPaintHintProvider
for the layers created by the layer factories of this format. May benull
. - See Also:
-
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 classALcyFormat
- Returns:
- An array of layer decoders. It must not be
null
, but may have length0
. It must not containnull
. - See Also:
-
createGXYLayerDecoderFileTypeDescriptors
Description copied from class:ALcyFormat
Creates
ALcyFileTypeDescriptor
s for theILcdGXYLayerDecoder
s. The length of the returned array must be equal to that ofALcyFormat.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 classALcyFormat
- Returns:
- An array of
ALcyFileTypeDescriptor
instances. Must not benull
and its length must be equal to the length of the array of layer decoders created by this format. May containnull
.
-
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 classALcyFormat
- Returns:
- An array of
ILcdGXYLayerEncoder
instances. Must not benull
but may have length0
. Must not containnull
. - See Also:
-
createGXYLayerEncoderFileTypeDescriptors
Description copied from class:ALcyFormat
Creates
ALcyFileTypeDescriptor
s for theILcdGXYLayerEncoder
s. The length of the returned array must be equal to that ofALcyFormat.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 theseALcyFileTypeDescriptor
s. When noALcyFileTypeDescriptor
s are available (or onlynull
ALcyFileTypeDescriptor
s) it will not be possible to save the layer style to file.The default implementation returns a zero-length array.
- Overrides:
createGXYLayerEncoderFileTypeDescriptors
in classALcyFormat
- Returns:
- An array of
ALcyFileTypeDescriptor
instances. Must not benull
and its length must be equal to the length of the array of layer encoders created by this format. May containnull
. - See Also:
-
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 classALcyFormat
- Returns:
- An array of
ALcyWorkspaceObjectCodec
instances. Must not benull
but may have length0
. Must not containnull
. - See Also:
-
createGXYLayerCustomizerPanelFactories
Description copied from class:ALcyFormat
Creates the
ILcyCustomizerPanelFactory
factories that can createILcyCustomizerPanel
instances for the layers created by the layer factories of this format.The created
ILcyCustomizerPanel
s should work with instances ofTLcyLayerContext
in theirsetObject
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 yourILcyCustomizerPanel
s need to store any specific state in the workspace.- Overrides:
createGXYLayerCustomizerPanelFactories
in classALcyFormat
- Returns:
- An array of
ILcyCustomizerPanelFactory
instances. Must not benull
but may have length0
. Must not containnull
. - See Also:
-
isGXYLayerOfFormat
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 classALcyFormat
- Parameters:
aGXYLayer
- The layer to check.- Returns:
true
if and only if the given layer is a layer of the current data format.
-
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 classALcyFormat
- Returns:
- An array of
ALcyLayerSelectionTransferHandler
instances. Must not benull
but may have length0
. Must not containnull
. - See Also:
-
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 classALcyFormat
- Returns:
- An
ALcyFormatBarFactory
. May benull
. - See Also:
-
createModelHeightProviderFactory
Description copied from class:ALcyFormat
Creates the
ILcdModelHeightProviderFactory
that can create anILcdHeightProvider
for this format.The default implementation returns
null
.- Overrides:
createModelHeightProviderFactory
in classALcyFormat
- Returns:
- An
ILcdModelHeightProviderFactory
. May benull
. - See Also:
-
createLayerHeightProviderFactory
Description copied from class:ALcyFormat
Creates the
ILcdLayerHeightProviderFactory
that can create anILcdHeightProvider
for this format.The default implementation returns
null
.- Overrides:
createLayerHeightProviderFactory
in classALcyFormat
- Returns:
- An
ILcdLayerHeightProviderFactory
. May benull
. - See Also:
-
createLabelPlacementHintProvider
Description copied from class:ALcyFormat
Creates theILcyLabelPlacementHintProvider
that can create aTLcyGXYLabelPlacementHint
for layers of this format.The default implementation returns
null
.- Overrides:
createLabelPlacementHintProvider
in classALcyFormat
- Returns:
- An
ILcyLabelPlacementHintProvider
. May benull
. - See Also:
-
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 classALcyFormat
- Returns:
- the style provider to retrieve and encode the style of the layers. May be
null
-
createGXYLayerCustomizerPanelWorkspaceCodecs
Description copied from class:ALcyFormat
Creates the
ALcyWorkspaceObjectCodec
codecs for theILcyCustomizerPanel
instances for the layers created by the layer factories of this format.- Overrides:
createGXYLayerCustomizerPanelWorkspaceCodecs
in classALcyFormat
- Returns:
- An array containing the
ALcyWorkspaceObjectCodec
instances. Must not benull
, but may have length0
. Must not containnull
. - See Also:
-
createDomainObjectCustomizerPanelWorkspaceCodecs
Description copied from class:ALcyFormat
Creates the
ALcyWorkspaceObjectCodec
codecs for theILcyCustomizerPanel
instances for the domain objects created by the model decoders of this format.- Overrides:
createDomainObjectCustomizerPanelWorkspaceCodecs
in classALcyFormat
- Returns:
- An array containing the
ALcyWorkspaceObjectCodec
instances. Must not benull
, but may have length0
. Must not containnull
. - See Also:
-
createModelMetaDataCustomizerPanelWorkspaceCodecs
Description copied from class:ALcyFormat
Creates the
ALcyWorkspaceObjectCodec
codecs that can encode and decode theILcyCustomizerPanel
instances used to customize the meta data of the models produced by this format.- Overrides:
createModelMetaDataCustomizerPanelWorkspaceCodecs
in classALcyFormat
- Returns:
- An array of
ALcyWorkspaceObjectCodec
instances. Must not benull
but may have length0
. Must not containnull
. - See Also:
-
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 classALcyFormat
- Returns:
- A two-dimensional array containing the groups for the
ALcyFileTypeDescriptor
instances of theALcyFileTypeDescriptor
s. The first dimension must be equal to the length of the array ofALcyFileTypeDescriptor
instances created by this format. It must not containnull
, but may contain empty arrays.
-
createDataSourceHandlerFileTypeDescriptors
Description copied from class:ALcyFormat
Creates the
ALcyFileTypeDescriptor
instances corresponding to theALcyFileTypeDescriptor
instances created by this format.- Overrides:
createDataSourceHandlerFileTypeDescriptors
in classALcyFormat
- Returns:
- The array of
ALcyFileTypeDescriptor
instances. Must not benull
. Its length should be equal to the length of the array created bycreateDataSourceHandlers
. It may containnull
.
-
createDataSourceHandlers
Description copied from class:ALcyFormat
Creates
ALcyDataSourceHandler
(s) that are more general thanALcyFileTypeDescriptor
s.- Overrides:
createDataSourceHandlers
in classALcyFormat
- Returns:
- An array containing the
ALcyDataSourceHandler
instances. Must not benull
but may have length0
. Must not containnull
.
-
createDataPropertyValueCustomizerPanelFactories
Description copied from class:ALcyFormat
Creates the
ILcyCustomizerPanelFactory
factories that can createILcyCustomizerPanel
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
ILcyCustomizerPanel
s should work with instances ofTLcdDataPropertyValueContext
in theirsetObject
method.The default implementation returns a zero-length array.
- Overrides:
createDataPropertyValueCustomizerPanelFactories
in classALcyFormat
- Returns:
- An array of
ILcyCustomizerPanelFactory
instances. Must not benull
but may have length0
. Must not containnull
.
-
createBalloonContentProviders
Description copied from class:ALcyFormat
Creates the
ILcdBalloonContentProvider
s for this format.The default implementation returns an empty array.
- Overrides:
createBalloonContentProviders
in classALcyFormat
- Returns:
- the
ILcdBalloonContentProvider
s for this format. Must not benull
. The array may be empty but not containnull
.
-
createModelMeasureProviderFactory
Description copied from class:ALcyFormat
Creates the
ILcdModelMeasureProviderFactory
for this format.The default implementation returns
null
.- Overrides:
createModelMeasureProviderFactory
in classALcyFormat
- Returns:
- the
ILcdModelMeasureProviderFactory
for this format. Can benull
. - See Also:
-
createLayerMeasureProviderFactory
Description copied from class:ALcyFormat
Creates the
ILcdLayerMeasureProviderFactory
for this format.The default implementation returns
null
.- Overrides:
createLayerMeasureProviderFactory
in classALcyFormat
- Returns:
- the
ILcdLayerMeasureProviderFactory
for this format. Can benull
. - See Also:
-