eu.ehri.project.importers.managers

Interface ImportManager

All Known Implementing Classes:

AbstractImportManager, CsvImportManager, SaxImportManager

public interface ImportManager

An Import Manager takes a single file or stream, or a list of files, and a log message and imports the data from the file into the database, linking the import as an action with the given log message.

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.
default ImportLog	importInputStream(InputStream stream, String logMessage) Import an item via an input stream.
ImportLog	importInputStream(InputStream stream, String tag, String logMessage) Import an item via an input stream.

Method Detail

importFile

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

Import a file by specifying its path.

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

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

Import an item via an input stream.

Parameters:

stream - the 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

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

Import an item via an input stream.

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

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

Import multiple files via a list of file paths.

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

InputParseError - when parsing the stream data fails

ValidationError - when the content of the file is invalid

importArchive

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

Import multiple items via an archive input stream.

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