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

Interface ExportOperation

public interface ExportOperation

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

Since:

5.1.42

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ExportOperation.ChannelsProviderOptions Options for configuring the export of an added channels provider.
static interface	ExportOperation.Result Container providing access to the result of the export operation.
static interface	ExportOperation.SchemaOptions Options for configuring the export of an added schema.

Field Summary

Fields

Modifier and Type	Field and Description
static OperationType<ExportOperation>	TYPE Operation providing means to export store elements to files in a file system.

Method Summary

Methods

Modifier and Type	Method and Description
ExportOperation.ChannelsProviderOptions	addChannelProvider(ChannelSourceProvider element) Add a channels providing element for export.
void	addElement(IDProvider element) Generically adds a FirstSpirit element to be exported.
ExportOperation.SchemaOptions	addSchema(Schema element) Add a schema element for export.
ExportOperation.Result	perform(FileSystem<?> fileSystem) Perform the export on the given file system.
void	setDeleteObsoleteFiles(boolean enable) Defines to delete obsoletes files from the file system.
void	setExportChildElements(boolean enable) Defines to export child elements of elements added to this operation.
void	setExportParentElements(boolean enable) Defines to export parent elements of elements added to this operation.
void	setExportReleaseEntities(boolean enable) Defines to operate on released entities or the latest entities.
void	setStepsListener(StepsListener listener) Sets the listener that gets informed on steps being started.

Field Detail

TYPE

static final OperationType<ExportOperation> TYPE

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

Since:

5.1.42

Method Detail

addElement

void addElement(@NotNull
              IDProvider element)

Generically adds a FirstSpirit element to be exported. Added elements will be exported according to the global options enabled. For specific configurable elements, see the respective adding-methods.

Parameters:

element - The element to be added.

Since:

5.1.42

addSchema

ExportOperation.SchemaOptions addSchema(@NotNull
                                      Schema element)

Add a schema element for export. A schema can further be configured by the returned options object.

Parameters:

element - The schema element to be added.

Returns:

An options object for configuring the schema export.

Since:

5.1.42

addChannelProvider

ExportOperation.ChannelsProviderOptions addChannelProvider(@NotNull
                                                         ChannelSourceProvider element)

Add a channels providing element for export. A channel provider can be configured by the returned options object.

Parameters:

element - The channels providing element.

Returns:

An options object for configuring the channels export.

Since:

5.1.42

setExportReleaseEntities

void setExportReleaseEntities(boolean enable)

Defines to operate on released entities or the latest entities.

Parameters:

enable - true, to operate on released elements.

Since:

5.1.103

setExportChildElements

void setExportChildElements(boolean enable)

Defines to export child elements of elements added to this operation. Default value is true. Note that entities are not children of a schema.

Parameters:

enable - true, to export recursively.

Since:

5.1.42

setExportParentElements

void setExportParentElements(boolean enable)

Defines to export parent elements of elements added to this operation.

Parameters:

enable - true, to export parents.

Since:

5.1.42

setDeleteObsoleteFiles

void setDeleteObsoleteFiles(boolean enable)

Defines to delete obsoletes files from the file system.

Parameters:

enable - true, to delete obsolete files.

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

perform

ExportOperation.Result perform(@NotNull
                             FileSystem<?> fileSystem)
                               throws IOException

Perform the export on the given file system.

Parameters:

fileSystem - The file system to export to.

Returns:

A result object providing information about exported elements.

Throws:

IOException - if any access to the file system fails.

Since:

5.1.42