eu.ehri.project.importers.ead

Class EadImporter

java.lang.Object

eu.ehri.project.importers.base.AbstractImporter<Map<String,Object>,AbstractUnit>

eu.ehri.project.importers.ead.EadImporter

All Implemented Interfaces:

ItemImporter<Map<String,Object>,AbstractUnit>

Direct Known Subclasses:

VirtualEadImporter

public class EadImporter
extends AbstractImporter<Map<String,Object>,AbstractUnit>

Import EAD for a given repository into the database. Due to the laxness of the EAD standard this is a fairly complex procedure. An EAD a single entity at the highest level of description or multiple top-level entities, with or without a hierarchical structure describing their child items. This means that we need to recursively descend through the archdesc and c,c01-12 levels.

TODO: Extensive cleanups, optimisation, and rationalisation.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCESS_POINT

Fields inherited from class eu.ehri.project.importers.base.AbstractImporter

actioner, framedGraph, log, manager, permissionScope

Constructor Summary

Constructors

Constructor and Description
EadImporter(com.tinkerpop.frames.FramedGraph<?> graph, PermissionScope permissionScope, Actioner actioner, ImportLog log) Construct an EadImporter object.

Method Summary

Modifier and Type	Method and Description
protected Iterable<Map<String,Object>>	extractRelations(Map<String,Object> data)
protected Bundle	getDescription(Map<String,Object> itemData) Extract the documentary unit description bundle from the raw map data.
AbstractUnit	importItem(Map<String,Object> itemData) Import an item representation into the graph, and return the Node.
AbstractUnit	importItem(Map<String,Object> itemData, List<String> idPath) Import a single archdesc or c01-12 item, keeping a reference to the hierarchical depth.
protected Bundle	mergeWithPreviousAndSave(Bundle unit, Bundle descBundle, List<String> idPath) Finds any bundle in the graph with the same ObjectIdentifier.

Methods inherited from class eu.ehri.project.importers.base.AbstractImporter

addCallback, addErrorCallback, getActioner, getPermissionScope, getPersister, getPersister, handleCallbacks, handleError

Methods inherited from class java.lang.Object

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

Field Detail

ACCESS_POINT

public static final String ACCESS_POINT

See Also:

Constant Field Values

Constructor Detail

EadImporter

public EadImporter(com.tinkerpop.frames.FramedGraph<?> graph,
                   PermissionScope permissionScope,
                   Actioner actioner,
                   ImportLog log)

Construct an EadImporter object.

Parameters:

graph - the framed graph

permissionScope - the permission scope

log - the log

Method Detail

importItem

public AbstractUnit importItem(Map<String,Object> itemData,
                               List<String> idPath)
                        throws ValidationError

Import a single archdesc or c01-12 item, keeping a reference to the hierarchical depth.

Parameters:

itemData - The raw data map

idPath - The identifiers of parent documents, not including those of the overall permission scope

Returns:

the imported node

Throws:

ValidationError - when the itemData does not contain an identifier for the unit or...

getDescription

protected Bundle getDescription(Map<String,Object> itemData)
                         throws ValidationError

Extract the documentary unit description bundle from the raw map data.

Note: the itemData map is mutable and should be considered an out parameter.

Parameters:

itemData - the raw data map

Returns:

a description bundle

Throws:

ValidationError

mergeWithPreviousAndSave

protected Bundle mergeWithPreviousAndSave(Bundle unit,
                                          Bundle descBundle,
                                          List<String> idPath)
                                   throws ValidationError

Finds any bundle in the graph with the same ObjectIdentifier. If there is no bundle with this identifier, it is created. If it exists and a Description in the given language exists from the same source file, the description is replaced. If the description is from another source, it is added to the bundle's descriptions.

Parameters:

unit - the DocumentaryUnit to be saved

descBundle - the documentsDescription to replace any previous ones with this language

idPath - the ID path of this bundle (will be relative to the ID path of the permission scope)

Returns:

A bundle with description relationships merged.

Throws:

ValidationError

extractRelations

protected Iterable<Map<String,Object>> extractRelations(Map<String,Object> data)

importItem

public AbstractUnit importItem(Map<String,Object> itemData)
                        throws ValidationError

Description copied from interface: ItemImporter

Import an item representation into the graph, and return the Node.

Parameters:

itemData - the item representation to import

Returns:

the imported node

Throws:

ValidationError - when the item representation does not validate