Package de.espirit.firstspirit.transport

Interface LayerMapper

All Superinterfaces:

Serializable

All Known Implementing Classes:

LayerMapper.LayerNameBasedLayerMapper, LayerMapper.SchemaUidBasedLayerMapper

public interface LayerMapper
extends Serializable

Mapper providing layers to be used for transported Schema instances.
This mapper is used in content transport and external sync.

Since:

5.2.513

See Also:

• ImportOperation.setLayerMapper(LayerMapper)
• FeatureInstallAgent.installFeature(FeatureFile, LayerMapper)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	LayerMapper.LayerNameBasedLayerMapper	Default implementation based on a given map mapping from source layer name to target layer name.
static interface	LayerMapper.MappingContext	Mapping context providing access to the transported schema and the source layer name.
static final class	LayerMapper.SchemaUidBasedLayerMapper	Default implementation of a layer mapper using a given map mapping schema uid to target layer name.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CREATE_NEW_DEFAULT_LAYER	Use this field as result of getLayer(MappingContext) to force creation of a new project default layer
static final LayerMapper	CREATE_NEW_DEFAULT_LAYER_MAPPER	Default implementation of a LayerMapper always answering getLayer(MappingContext) call with CREATE_NEW_DEFAULT_LAYER to force creation of a new default layer

Method Summary

Modifier and Type	Method	Description
@NotNull String	getLayer(@NotNull LayerMapper.MappingContext mappingContext)	Gets the name of the layer to be used for the given schema.

Field Details

CREATE_NEW_DEFAULT_LAYER

static final String CREATE_NEW_DEFAULT_LAYER

Use this field as result of getLayer(MappingContext) to force creation of a new project default layer

Since:

5.2.513

See Also:

• getLayer(MappingContext)
• Constant Field Values

CREATE_NEW_DEFAULT_LAYER_MAPPER

static final LayerMapper CREATE_NEW_DEFAULT_LAYER_MAPPER

Default implementation of a LayerMapper always answering getLayer(MappingContext) call with CREATE_NEW_DEFAULT_LAYER to force creation of a new default layer

Since:

5.2.513

Method Details

getLayer

@NotNull
@NotNull String getLayer(@NotNull
 @NotNull LayerMapper.MappingContext mappingContext)

Gets the name of the layer to be used for the given schema. Return CREATE_NEW_DEFAULT_LAYER to force creation of a new default layer in the target project which should be used for the transported schema.

Parameters:

mappingContext - mapping data related to the transported schema

Returns:

The name of the layer to be used.

Since:

5.2.513

See Also:

• CREATE_NEW_DEFAULT_LAYER