Package org.openrefine.importers.tree

Class TreeImportingParserBase

java.lang.Object

org.openrefine.importers.ImportingParserBase

org.openrefine.importers.tree.TreeImportingParserBase

All Implemented Interfaces:

ImportingParser

Direct Known Subclasses:

JsonImporter, XmlImporter

public abstract class TreeImportingParserBase
extends ImportingParserBase

Abstract class for importer parsers which handle tree-shaped data (currently XML and JSON).

Constructor Summary

Constructors

Constructor	Description
TreeImportingParserBase()

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
void	parseOneFile(TreeImportUtilities.ColumnIndexAllocator allocator, List<Row> rows, ProjectMetadata metadata, ImportingJob job, String fileSource, String archiveFileName, InputStream inputStream, ImportColumnGroup rootColumnGroup, long limit, com.fasterxml.jackson.databind.node.ObjectNode options)	Parse a single file from an InputStream.
protected void	parseOneFile(TreeImportUtilities.ColumnIndexAllocator allocator, List<Row> rows, ProjectMetadata metadata, ImportingJob job, String fileSource, String archiveFileName, TreeReader treeParser, ImportColumnGroup rootColumnGroup, long limit, com.fasterxml.jackson.databind.node.ObjectNode options)	Parse a single file from a TreeReader.
void	parseOneFile(TreeImportUtilities.ColumnIndexAllocator allocator, List<Row> rows, ProjectMetadata metadata, ImportingJob job, ImportingFileRecord fileRecord, ImportColumnGroup rootColumnGroup, long limit, com.fasterxml.jackson.databind.node.ObjectNode options, MultiFileReadingProgress progress)

Methods inherited from class org.openrefine.importers.ImportingParserBase

parseOneFile

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeImportingParserBase

public TreeImportingParserBase()

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

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

Overrides:

parse in class ImportingParserBase

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 void parseOneFile(TreeImportUtilities.ColumnIndexAllocator allocator,
                         List<Row> rows,
                         ProjectMetadata metadata,
                         ImportingJob job,
                         ImportingFileRecord fileRecord,
                         ImportColumnGroup rootColumnGroup,
                         long limit,
                         com.fasterxml.jackson.databind.node.ObjectNode options,
                         MultiFileReadingProgress progress)
                  throws Exception

Throws:

Exception

parseOneFile

public void parseOneFile(TreeImportUtilities.ColumnIndexAllocator allocator,
                         List<Row> rows,
                         ProjectMetadata metadata,
                         ImportingJob job,
                         String fileSource,
                         String archiveFileName,
                         InputStream inputStream,
                         ImportColumnGroup rootColumnGroup,
                         long limit,
                         com.fasterxml.jackson.databind.node.ObjectNode options)
                  throws Exception

Parse a single file from an InputStream. The default implementation just throws a NotImplementedException. Override in subclasses to implement.

Throws:

Exception

parseOneFile

protected void parseOneFile(TreeImportUtilities.ColumnIndexAllocator allocator,
                            List<Row> rows,
                            ProjectMetadata metadata,
                            ImportingJob job,
                            String fileSource,
                            String archiveFileName,
                            TreeReader treeParser,
                            ImportColumnGroup rootColumnGroup,
                            long limit,
                            com.fasterxml.jackson.databind.node.ObjectNode options)
                     throws Exception

Parse a single file from a TreeReader.

Throws:

Exception