Package com.google.refine.importers.tree

Class TreeImportingParserBase

java.lang.Object

com.google.refine.importers.ImportingParserBase

com.google.refine.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 & JSON).

Field Summary

Fields inherited from class com.google.refine.importers.ImportingParserBase

useInputStream

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TreeImportingParserBase(boolean useInputStream)

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.node.ObjectNode	createParserUIInitializationData(ImportingJob job, List<com.fasterxml.jackson.databind.node.ObjectNode> fileRecords, String format)	Create data sufficient for the parser UI on the client side to do its work.
void	parse(Project project, ProjectMetadata metadata, ImportingJob job, List<com.fasterxml.jackson.databind.node.ObjectNode> fileRecords, String format, int limit, com.fasterxml.jackson.databind.node.ObjectNode options, List<Exception> exceptions)
void	parseOneFile(Project project, ProjectMetadata metadata, ImportingJob job, com.fasterxml.jackson.databind.node.ObjectNode fileRecord, ImportColumnGroup rootColumnGroup, int limit, com.fasterxml.jackson.databind.node.ObjectNode options, List<Exception> exceptions, ImporterUtilities.MultiFileReadingProgress progress)
protected void	parseOneFile(Project project, ProjectMetadata metadata, ImportingJob job, String fileSource, TreeReader treeParser, ImportColumnGroup rootColumnGroup, int limit, com.fasterxml.jackson.databind.node.ObjectNode options, List<Exception> exceptions)	Parse a single file from a TreeReader.
void	parseOneFile(Project project, ProjectMetadata metadata, ImportingJob job, String fileSource, InputStream inputStream, ImportColumnGroup rootColumnGroup, int limit, com.fasterxml.jackson.databind.node.ObjectNode options, List<Exception> exceptions)	Parse a single file from an InputStream.
void	parseOneFile(Project project, ProjectMetadata metadata, ImportingJob job, String fileSource, Reader reader, ImportColumnGroup rootColumnGroup, int limit, com.fasterxml.jackson.databind.node.ObjectNode options, List<Exception> exceptions)	Parse a single file from a Reader.

Methods inherited from class com.google.refine.importers.ImportingParserBase

addArchiveColumn, addFilenameColumn, parseOneFile, parseOneFile, parseOneFile

Methods inherited from class java.lang.Object

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

Constructor Details

TreeImportingParserBase

protected TreeImportingParserBase(boolean useInputStream)

Method Details

createParserUIInitializationData

public com.fasterxml.jackson.databind.node.ObjectNode createParserUIInitializationData(ImportingJob job,
 List<com.fasterxml.jackson.databind.node.ObjectNode> 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

Returns:

ObjectNode options

parse

public void parse(Project project,
 ProjectMetadata metadata,
 ImportingJob job,
 List<com.fasterxml.jackson.databind.node.ObjectNode> fileRecords,
 String format,
 int limit,
 com.fasterxml.jackson.databind.node.ObjectNode options,
 List<Exception> exceptions)

Specified by:

parse in interface ImportingParser

Overrides:

parse in class ImportingParserBase

limit - maximum number of rows to create

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

exceptions - list of exceptions thrown during the parse. Expects an empty List as input to which it can append new Exceptions thrown

parseOneFile

public void parseOneFile(Project project,
 ProjectMetadata metadata,
 ImportingJob job,
 com.fasterxml.jackson.databind.node.ObjectNode fileRecord,
 ImportColumnGroup rootColumnGroup,
 int limit,
 com.fasterxml.jackson.databind.node.ObjectNode options,
 List<Exception> exceptions,
 ImporterUtilities.MultiFileReadingProgress progress)
                  throws IOException

Throws:

IOException

parseOneFile

public void parseOneFile(Project project,
 ProjectMetadata metadata,
 ImportingJob job,
 String fileSource,
 Reader reader,
 ImportColumnGroup rootColumnGroup,
 int limit,
 com.fasterxml.jackson.databind.node.ObjectNode options,
 List<Exception> exceptions)

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

parseOneFile

public void parseOneFile(Project project,
 ProjectMetadata metadata,
 ImportingJob job,
 String fileSource,
 InputStream inputStream,
 ImportColumnGroup rootColumnGroup,
 int limit,
 com.fasterxml.jackson.databind.node.ObjectNode options,
 List<Exception> exceptions)

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

parseOneFile

protected void parseOneFile(Project project,
 ProjectMetadata metadata,
 ImportingJob job,
 String fileSource,
 TreeReader treeParser,
 ImportColumnGroup rootColumnGroup,
 int limit,
 com.fasterxml.jackson.databind.node.ObjectNode options,
 List<Exception> exceptions)

Parse a single file from a TreeReader.