eu.ehri.project.importers.managers

Class AbstractImportManager

java.lang.Object

eu.ehri.project.importers.managers.AbstractImportManager

All Implemented Interfaces:

ImportManager

Direct Known Subclasses:

CsvImportManager, SaxImportManager

public abstract class AbstractImportManager
extends Object
implements ImportManager

Base ImportManager.

Field Summary

Fields

Modifier and Type	Field and Description
protected Actioner	actioner
protected boolean	allowUpdates
protected Integer	currentPosition
protected com.tinkerpop.frames.FramedGraph<?>	framedGraph
protected Class<? extends ItemImporter>	importerClass
protected PermissionScope	permissionScope
protected boolean	tolerant

Constructor Summary

Constructors

Constructor and Description
AbstractImportManager(com.tinkerpop.frames.FramedGraph<?> graph, PermissionScope scope, Actioner actioner, boolean tolerant, boolean allowUpdates, Class<? extends ItemImporter> importerClass) Constructor.

Method Summary

Modifier and Type	Method and Description
ImportLog	importArchive(org.apache.commons.compress.archivers.ArchiveInputStream stream, String logMessage) Import multiple items via an archive input stream.
ImportLog	importFile(String filePath, String logMessage) Import a file by specifying its path.
ImportLog	importFiles(List<String> filePaths, String logMessage) Import multiple files via a list of file paths.
protected abstract void	importInputStream(InputStream stream, String tag, ActionManager.EventContext context, ImportLog log) Import an InputStream with an event context.
ImportLog	importInputStream(InputStream stream, String tag, String logMessage) Import an item via an input stream.
boolean	isTolerant() Determine if the importer is in tolerant mode.

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.ehri.project.importers.managers.ImportManager

importInputStream

Field Detail

framedGraph

protected final com.tinkerpop.frames.FramedGraph<?> framedGraph

permissionScope

protected final PermissionScope permissionScope

actioner

protected final Actioner actioner

tolerant

protected final boolean tolerant

allowUpdates

protected final boolean allowUpdates

currentPosition

protected Integer currentPosition

importerClass

protected final Class<? extends ItemImporter> importerClass

Constructor Detail

AbstractImportManager

public AbstractImportManager(com.tinkerpop.frames.FramedGraph<?> graph,
                             PermissionScope scope,
                             Actioner actioner,
                             boolean tolerant,
                             boolean allowUpdates,
                             Class<? extends ItemImporter> importerClass)

Constructor.

Parameters:

graph - the framed graph

scope - the permission scope

actioner - the actioner

tolerant - allow individual items to fail validation without failing an entire batch

allowUpdates - allow this import manager to update data items as well as create them

importerClass - the class of the item importer object

Method Detail

isTolerant

public boolean isTolerant()

Determine if the importer is in tolerant mode.

Returns:

a boolean value

importFile

public ImportLog importFile(String filePath,
                            String logMessage)
                     throws IOException,
                            InputParseError,
                            ValidationError

Description copied from interface: ImportManager

Import a file by specifying its path.

Specified by:

importFile in interface ImportManager

Parameters:

filePath - path to the file to import

logMessage - an optional message to describe the import

Returns:

an ImportLog for the given file

Throws:

IOException - when reading or writing files fails

InputParseError - when parsing the file fails

ValidationError - when the content of the file is invalid

importInputStream

public ImportLog importInputStream(InputStream stream,
                                   String tag,
                                   String logMessage)
                            throws IOException,
                                   InputParseError,
                                   ValidationError

Description copied from interface: ImportManager

Import an item via an input stream.

Specified by:

importInputStream in interface ImportManager

Parameters:

stream - the input stream

tag - an optional tag identifying the source of the stream

logMessage - an optional log message to describe the import

Returns:

an ImportLog for the given stream

Throws:

IOException - when reading or writing fails

InputParseError - when parsing the stream data fails

ValidationError - when the content of the file is invalid

importFiles

public ImportLog importFiles(List<String> filePaths,
                             String logMessage)
                      throws IOException,
                             ValidationError,
                             InputParseError

Description copied from interface: ImportManager

Import multiple files via a list of file paths.

Specified by:

importFiles in interface ImportManager

Parameters:

filePaths - a list of file paths

logMessage - an optional log message to describe the import

Returns:

an ImportLog for the given stream

Throws:

IOException - when reading or writing fails

ValidationError - when the content of the file is invalid

InputParseError - when parsing the stream data fails

importArchive

public ImportLog importArchive(org.apache.commons.compress.archivers.ArchiveInputStream stream,
                               String logMessage)
                        throws IOException,
                               InputParseError,
                               ValidationError

Description copied from interface: ImportManager

Import multiple items via an archive input stream.

Specified by:

importArchive in interface ImportManager

Parameters:

stream - the archive input stream

logMessage - an optional log message to describe the import

Returns:

an ImportLog for the given stream

Throws:

IOException - when reading or writing fails

InputParseError - when parsing the stream data fails

ValidationError - when the content of the file is invalid

importInputStream

protected abstract void importInputStream(InputStream stream,
                                          String tag,
                                          ActionManager.EventContext context,
                                          ImportLog log)
                                   throws IOException,
                                          ValidationError,
                                          InputParseError

Import an InputStream with an event context.

Parameters:

stream - the InputStream to import

tag - an optional tag identifying the source of the stream

context - the event that this import is part of

log - an import log to write to

Throws:

IOException

ValidationError

InputParseError