Package org.openrefine.importers

Class ExcelImporter

java.lang.Object

org.openrefine.importers.ImportingParserBase

org.openrefine.importers.InputStreamImporter

org.openrefine.importers.ExcelImporter

All Implemented Interfaces:

ImportingParser

public class ExcelImporter
extends InputStreamImporter

Constructor Summary

Constructors

Constructor	Description
ExcelImporter()

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.
protected static Cell	extractCell(org.apache.poi.ss.usermodel.Cell cell)
protected static Cell	extractCell(org.apache.poi.ss.usermodel.Cell cell, boolean forceText)
protected static Cell	extractCell(org.apache.poi.ss.usermodel.Cell cell, Map<String,Recon> reconMap)
Grid	parseOneFile(Runner runner, ProjectMetadata metadata, ImportingJob job, String fileSource, String archiveFileName, Supplier<InputStream> inputStreamSupplier, long limit, com.fasterxml.jackson.databind.node.ObjectNode options)	Parses one file, read from an InputStream 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

ExcelImporter

public ExcelImporter()

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 Grid parseOneFile(Runner runner,
                         ProjectMetadata metadata,
                         ImportingJob job,
                         String fileSource,
                         String archiveFileName,
                         Supplier<InputStream> inputStreamSupplier,
                         long limit,
                         com.fasterxml.jackson.databind.node.ObjectNode options)
                  throws Exception

Description copied from class: InputStreamImporter

Parses one file, read from an InputStream object, into a Grid.

Specified by:

parseOneFile in class InputStreamImporter

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 which contained this file

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

extractCell

protected static Cell extractCell(org.apache.poi.ss.usermodel.Cell cell,
                                  boolean forceText)

extractCell

protected static Cell extractCell(org.apache.poi.ss.usermodel.Cell cell)

extractCell

protected static Cell extractCell(org.apache.poi.ss.usermodel.Cell cell,
                                  Map<String,Recon> reconMap)