Package com.google.refine.importing

Interface ImportingParser

All Known Implementing Classes:
ExcelImporter, FixedWidthImporter, ImportingParserBase, JsonImporter, LineBasedImporter, MarcImporter, OdsImporter, RdfJsonldTripleImporter, RdfTripleImporter, RdfXmlTripleImporter, SeparatorBasedImporter, TabularImportingParserBase, TreeImportingParserBase, WikitextImporter, XmlImporter
public interface ImportingParser

  • 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)
     

  • Method Details

    • createParserUIInitializationData

      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. 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.
      Parameters:
      job -
      fileRecords -
      format -
      Returns:
      ObjectNode options

    • parse

      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)
      Parameters:
      project -
      metadata -
      job -
      fileRecords -
      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
      exceptions - list of exceptions thrown during the parse. Expects an empty List as input to which it can append new Exceptions thrown