eu.ehri.project.importers.ead

Class EadSync

java.lang.Object

eu.ehri.project.importers.ead.EadSync

public class EadSync
extends Object

Synchronise items in a repository or fonds from EAD data.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EadSync.EadIngestOperation An operation that performs the actual ingest, given the ImportManager and returning an ImportLog.
class	EadSync.EadSyncError Signal that something has gone wrong with the sync operation.

Constructor Summary

Constructors

Constructor and Description
EadSync(com.tinkerpop.frames.FramedGraph<?> graph, Api api, PermissionScope scope, Actioner actioner, SaxImportManager importManager)

Method Summary

Modifier and Type	Method and Description
SyncLog	sync(EadSync.EadIngestOperation op, Set<String> excludes, String logMessage) Synchronise an archival scope from EAD files.

Methods inherited from class java.lang.Object

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

Constructor Detail

EadSync

public EadSync(com.tinkerpop.frames.FramedGraph<?> graph,
               Api api,
               PermissionScope scope,
               Actioner actioner,
               SaxImportManager importManager)

Method Detail

sync

public SyncLog sync(EadSync.EadIngestOperation op,
                    Set<String> excludes,
                    String logMessage)
             throws ValidationError,
                    DeserializationError,
                    IOException,
                    EadSync.EadSyncError

Synchronise an archival scope from EAD files. The actual ingest operation is delegated to the given SaxImportManager instance.

For sync to work correctly the local (scoped) item identifiers must be unique in the scope in which sync is taking place.

Parameters:

op - the ingest operation

logMessage - a log message that will be attached to the delete event

Returns:

a SyncLog instance

Throws:

EadSync.EadSyncError - if local identifiers are not unique

ValidationError

DeserializationError

IOException