de.espirit.firstspirit.store.access.nexport.operations

Interface ImportOperation

public interface ImportOperation

Operation providing means to import store elements from files in a file system.

Since:

5.1.42

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ImportOperation.DatabaseLayerMapper Mapper providing layers to be used for Schema instances.
static class	ImportOperation.MapDatabaseLayerMapper Default implementation of ImportOperation.DatabaseLayerMapper based on a map.
static interface	ImportOperation.Problem Bundles a description, the store type, and the node id of a problematic element.
static interface	ImportOperation.Result Container providing access to the result of the import operation.

Field Summary

Fields

Modifier and Type	Field and Description
static ImportOperation.DatabaseLayerMapper	IDENTITY_LAYER_MAPPING Identity layer mapping, mapping source layer to target layer with same name.
static OperationType<ImportOperation>	TYPE Operation providing means to import store elements from files in a file system.

Method Summary

Methods

Modifier and Type	Method and Description
ImportOperation.Result	perform(FileSystem<?> fileSystem) Perform the import on the given file system.
void	setCreateEntities(boolean enable) Defines to create entities when importing.
void	setDatabaseLayerMapper(ImportOperation.DatabaseLayerMapper mapper) Sets a mapper providing information to map imported schemes to different layers.
void	setImportFilter(Filter<ImportElementInfo> filter) Sets a filter being used to decide upon elements to be imported.
void	setRevisionComment(String comment) Sets a comment for revisions created during the update.
void	setStepsListener(StepsListener listener) Sets the listener that gets informed on steps being started.

Field Detail

TYPE

static final OperationType<ImportOperation> TYPE

Operation providing means to import store elements from files in a file system.

Since:

5.1.42

IDENTITY_LAYER_MAPPING

static final ImportOperation.DatabaseLayerMapper IDENTITY_LAYER_MAPPING

Identity layer mapping, mapping source layer to target layer with same name.

Since:

5.1.104

See Also:

setDatabaseLayerMapper(DatabaseLayerMapper)

Method Detail

setCreateEntities

void setCreateEntities(boolean enable)

Defines to create entities when importing. This option is enabled by default.

Parameters:

enable - true, to create entities.

Since:

5.1.42

setDatabaseLayerMapper

void setDatabaseLayerMapper(@NotNull
                          ImportOperation.DatabaseLayerMapper mapper)

Sets a mapper providing information to map imported schemes to different layers.

Parameters:

mapper - The mapper providing the relevant information.

Since:

5.1.42

See Also:

IDENTITY_LAYER_MAPPING, ImportOperation.MapDatabaseLayerMapper.from(Map)

setImportFilter

void setImportFilter(@NotNull
                   Filter<ImportElementInfo> filter)

Sets a filter being used to decide upon elements to be imported. This is a pre-import filter that will be applied on the available file hierarchy as given by the file system in perform(FileSystem). Only elements passing the filter will be added for import. Children of passing elements will always be imported as well.

Parameters:

filter - The filter to be passed.

Since:

5.1.42

setStepsListener

void setStepsListener(@NotNull
                    StepsListener listener)

Sets the listener that gets informed on steps being started.

Parameters:

listener - The listener to be set.

Since:

5.1.42

setRevisionComment

void setRevisionComment(@NotNull
                      String comment)

Sets a comment for revisions created during the update.

Parameters:

comment - Revision comment, should not contain line breaks.

Since:

5.1.107

perform

ImportOperation.Result perform(@NotNull
                             FileSystem<?> fileSystem)
                               throws IOException,
                                      LockException,
                                      ElementDeletedException,
                                      ElementMovedException

Perform the import on the given file system. Exported elements from the file system will be imported as new elements. Exported elements corresponding to elements, which already exist in the project, will be updated.

Parameters:

fileSystem - The file system to export to.

Returns:

A result object providing information about imported elements.

Throws:

IOException

LockException

ElementDeletedException

ElementMovedException

Since:

5.1.42