eu.ehri.project.importers.json

Class BatchOperations

java.lang.Object

eu.ehri.project.importers.json.BatchOperations

public class BatchOperations
extends Object

Batch operations for JSON data in Bundle format.

Constructor Summary

Constructors

Constructor and Description
BatchOperations(com.tinkerpop.frames.FramedGraph<?> graph) Simple constructor, with system scope, version creation activated and tolerant mode off.
BatchOperations(com.tinkerpop.frames.FramedGraph<?> graph, PermissionScope scopeOpt, boolean version, boolean tolerant, List<ImportCallback> callbacks) Constructor.

Method Summary

Modifier and Type	Method and Description
int	batchDelete(List<String> ids, Actioner actioner, Optional<String> logMessage) Delete a batch of items by ID.
ImportLog	batchImport(InputStream inputStream, Actioner actioner, Optional<String> logMessage) Create or update a batch of items.
ImportLog	batchUpdate(InputStream inputStream, Actioner actioner, Optional<String> logMessage) Update a batch of items.
BatchOperations	setScope(PermissionScope scope) Set the permission scope.
BatchOperations	setTolerant(boolean tolerant) Toggle tolerant mode, which will prevent the entire batch failing if a single item fails to validate.
BatchOperations	setVersioning(boolean versioning) Toggle versioning for item updates.
BatchOperations	withCallbacks(ImportCallback... callbacks) Add import callbacks to the importer.

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchOperations

public BatchOperations(com.tinkerpop.frames.FramedGraph<?> graph,
                       PermissionScope scopeOpt,
                       boolean version,
                       boolean tolerant,
                       List<ImportCallback> callbacks)

Constructor.

Parameters:

graph - the graph object

scopeOpt - a nullable scope entity

version - whether to created versioned for changed items

tolerant - whether to allow individual validation errors without failing the entire batch

BatchOperations

public BatchOperations(com.tinkerpop.frames.FramedGraph<?> graph)

Simple constructor, with system scope, version creation activated and tolerant mode off.

Parameters:

graph - the graph object

Method Detail

setTolerant

public BatchOperations setTolerant(boolean tolerant)

Toggle tolerant mode, which will prevent the entire batch failing if a single item fails to validate.

Parameters:

tolerant - true or false

Returns:

a new batch operation manager

setVersioning

public BatchOperations setVersioning(boolean versioning)

Toggle versioning for item updates.

Parameters:

versioning - true or false

Returns:

a new batch operation manager

setScope

public BatchOperations setScope(PermissionScope scope)

Set the permission scope.

Parameters:

scope - a permission scope frame

Returns:

a new batch operation manager

withCallbacks

public BatchOperations withCallbacks(ImportCallback... callbacks)

Add import callbacks to the importer. Note: order of execution is undefined.

Parameters:

callbacks - one or more ImportCallback instances

Returns:

a new batch operation manager

batchImport

public ImportLog batchImport(InputStream inputStream,
                             Actioner actioner,
                             Optional<String> logMessage)
                      throws DeserializationError,
                             ItemNotFound,
                             ValidationError

Create or update a batch of items.

Parameters:

inputStream - an input stream containing a JSON list of bundles corresponding to the items to update or create.

actioner - the current user

logMessage - a log message

Returns:

an import log

Throws:

DeserializationError

ItemNotFound

ValidationError

batchUpdate

public ImportLog batchUpdate(InputStream inputStream,
                             Actioner actioner,
                             Optional<String> logMessage)
                      throws DeserializationError,
                             ItemNotFound,
                             ValidationError

Update a batch of items.

Parameters:

inputStream - an input stream containing a JSON list of bundles corresponding to the items to update.

actioner - the current user

logMessage - a log message

Returns:

an import log

Throws:

DeserializationError

ItemNotFound

ValidationError

batchDelete

public int batchDelete(List<String> ids,
                       Actioner actioner,
                       Optional<String> logMessage)
                throws ItemNotFound

Delete a batch of items by ID.

Parameters:

ids - a list of item IDs

actioner - the current user

logMessage - an optional log message

Returns:

the number of items deleted

Throws:

ItemNotFound