org.modeshape.jcr.api

Class RestoreOptions

java.lang.Object

org.modeshape.jcr.api.RestoreOptions

public abstract class RestoreOptions
extends Object

Class which allows a customization of the restore process

Field Summary

Fields

Modifier and Type	Field and Description
static RestoreOptions	DEFAULT The default options used during restore, if no explicit ones are given.
static int	DEFAULT_BATCH_SIZE The number of documents written in one unit (i.e. transaction) from the backup files into the persistent storage.

Constructor Summary

Constructors

Constructor and Description
RestoreOptions()

Method Summary

Modifier and Type	Method and Description
int	batchSize() Return the number of documents that are written to the persistent store in one unit of work (transaction) This is a setting that can be used to influence the memory and throughout of the restore process.
boolean	includeBinaries() Whether binaries should be restored or not.
boolean	reindexContentOnFinish() Whether a full reindexing should be performed or not after restoring the content.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_BATCH_SIZE

public static final int DEFAULT_BATCH_SIZE

The number of documents written in one unit (i.e. transaction) from the backup files into the persistent storage.

See Also:

Constant Field Values

DEFAULT

public static final RestoreOptions DEFAULT

The default options used during restore, if no explicit ones are given.

Constructor Detail

RestoreOptions

public RestoreOptions()

Method Detail

reindexContentOnFinish

public boolean reindexContentOnFinish()

Whether a full reindexing should be performed or not after restoring the content.

Returns:

true if a full reindexing should be performed; defaults to true

batchSize

public int batchSize()

Return the number of documents that are written to the persistent store in one unit of work (transaction)

This is a setting that can be used to influence the memory and throughout of the restore process.

Returns:

the number of documents; defaults to 1000

Since:

5.0

includeBinaries

public boolean includeBinaries()

Whether binaries should be restored or not. ModeShape uses references between documents and binary values, so depending on the context it may not always be desired for binary values to be restored.

Returns:

true if binary values should be included; defaults to true

toString

public String toString()

Overrides:

toString in class Object