eu.ehri.project.importers.base

Interface ItemImporter<I,T extends Accessible>

Type Parameters:

I - Type of node representation that can be imported, for example, Map<String, Object>.

All Known Implementing Classes:

AbstractImporter, CsvAuthoritativeItemImporter, CsvConceptImporter, CsvHistoricalAgentImporter, EacImporter, EadImporter, EagImporter, PersonalitiesImporter, UkrainianUnitImporter, VirtualEadImporter, Wp2PersonalitiesImporter

public interface ItemImporter<I,T extends Accessible>

Interface for importers that import documentary units, historical agents and virtual collections, with their constituent logical data, description(s), and date periods.

Method Summary

Modifier and Type	Method and Description
void	addCallback(ImportCallback callback) Add a callback to run when an item is created.
void	addErrorCallback(ErrorCallback callback) Add a callback to run when an item errors.
void	handleError(Exception ex) Used to indicate a validation error in the handler for a given element.
T	importItem(I itemData) Import an item representation into the graph, and return the Node.
T	importItem(I itemData, List<String> scopeIds) Import an item representation into the graph at a certain depth, and return the Node.

Method Detail

importItem

T importItem(I itemData)
      throws ValidationError

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

importItem

T importItem(I itemData,
             List<String> scopeIds)
      throws ValidationError

Import an item representation into the graph at a certain depth, and return the Node.

Parameters:

itemData - the item representation to import

scopeIds - parent identifiers for ID generation, not including permission scope

Returns:

the imported node

Throws:

ValidationError - when the item representation does not validate

handleError

void handleError(Exception ex)

Used to indicate a validation error in the handler for a given element.

Parameters:

ex - a validation exception

addCallback

void addCallback(ImportCallback callback)

Add a callback to run when an item is created.

Parameters:

callback - a callback function object

addErrorCallback

void addErrorCallback(ErrorCallback callback)

Add a callback to run when an item errors.

Parameters:

callback - a callback function object