Package org.openrefine.importers

Class ReaderImporter

java.lang.Object

org.openrefine.importers.ImportingParserBase

org.openrefine.importers.ReaderImporter

All Implemented Interfaces:

ImportingParser

Direct Known Subclasses:

FixedWidthImporter, LineBasedImporter, PCAxisImporter, RdfTripleImporter, SeparatorBasedImporter, WikitextImporter

public abstract class ReaderImporter
extends ImportingParserBase

A base class for importers which read files in text mode (with a Reader).

Constructor Summary

Constructors

Constructor	Description
ReaderImporter()

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.
abstract Grid	parseOneFile(Runner runner, ProjectMetadata metadata, ImportingJob job, String fileSource, String archiveFileName, Supplier<Reader> reader, long limit, com.fasterxml.jackson.databind.node.ObjectNode options)	Parses one file, read from a Reader object, into a Grid.

Methods inherited from class org.openrefine.importers.ImportingParserBase

parse, parseOneFile

Methods inherited from class java.lang.Object

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

Constructor Detail

ReaderImporter

public ReaderImporter()

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

Overrides:

createParserUIInitializationData in class ImportingParserBase

parseOneFile

public abstract Grid parseOneFile(Runner runner,
                                  ProjectMetadata metadata,
                                  ImportingJob job,
                                  String fileSource,
                                  String archiveFileName,
                                  Supplier<Reader> reader,
                                  long limit,
                                  com.fasterxml.jackson.databind.node.ObjectNode options)
                           throws Exception

Parses one file, read from a Reader object, into a Grid.

Parameters:

runner - the runner to use (the returned Grid will be generated by it)

metadata - the project metadata associated with the project to parse (which can be modified by the importer)

job - the importing job where this import is being done

fileSource - the path or source of the file (could be "clipboard" or a URL as well)

archiveFileName - the path or source of the archive the file was extracted from

reader - the reader object where to read the data from

limit - the maximum number of rows to read

options - any options passed to the importer as a JSON payload

Returns:

a parsed Grid

Throws:

Exception