Package org.openrefine.importers

Class ImportingParserBase

java.lang.Object

org.openrefine.importers.ImportingParserBase

All Implemented Interfaces:

ImportingParser

Direct Known Subclasses:

InputStreamImporter, ReaderImporter, TreeImportingParserBase

public abstract class ImportingParserBase
extends Object
implements ImportingParser

Importer which handles the import of multiple files as a single one.

Constructor Summary

Constructors

Constructor	Description
ImportingParserBase()

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.node.ObjectNode	createParserUIInitializationData(Runner runner, ImportingJob job, List<ImportingFileRecord> fileRecords, String format)	Create data sufficient for the parser UI on the client side to do its work.
Grid	parse(Runner runner, ProjectMetadata metadata, ImportingJob job, List<ImportingFileRecord> fileRecords, String format, long limit, com.fasterxml.jackson.databind.node.ObjectNode options)	Main method of the parser: parse a grid out of input files
Grid	parseOneFile(Runner runner, ProjectMetadata metadata, ImportingJob job, ImportingFileRecord fileRecord, long limit, com.fasterxml.jackson.databind.node.ObjectNode options, MultiFileReadingProgress progress)

Methods inherited from class java.lang.Object

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

Constructor Detail

ImportingParserBase

public ImportingParserBase()

Method Detail

createParserUIInitializationData

public com.fasterxml.jackson.databind.node.ObjectNode createParserUIInitializationData(Runner runner,
                                                                                       ImportingJob job,
                                                                                       List<ImportingFileRecord> fileRecords,
                                                                                       String format)

Description copied from interface: ImportingParser

Create data sufficient for the parser UI on the client side to do its work. For example, an XML parser UI would need to know some sample elements so it can let the user pick which the path to the record elements.

Specified by:

createParserUIInitializationData in interface ImportingParser

parse

public Grid parse(Runner runner,
                  ProjectMetadata metadata,
                  ImportingJob job,
                  List<ImportingFileRecord> fileRecords,
                  String format,
                  long limit,
                  com.fasterxml.jackson.databind.node.ObjectNode options)
           throws Exception

Description copied from interface: ImportingParser

Main method of the parser: parse a grid out of input files

Specified by:

parse in interface ImportingParser

Parameters:

runner - the runner to use to create the grid

metadata - the project metadata, to which the importer can contribute

job - the importing job, useful to report importing progress

fileRecords - the files to import

format - the identifier for the format

limit - maximum number of rows to create

options - custom options put together by the UI corresponding to this parser, which the parser should understand

Throws:

Exception

parseOneFile

public Grid parseOneFile(Runner runner,
                         ProjectMetadata metadata,
                         ImportingJob job,
                         ImportingFileRecord fileRecord,
                         long limit,
                         com.fasterxml.jackson.databind.node.ObjectNode options,
                         MultiFileReadingProgress progress)
                  throws Exception

Throws:

Exception