Package com.norconex.importer.handler

Interface DocHandler

All Known Subinterfaces:
ConfigurableDocHandler<T>
All Known Implementing Classes:
AbstractDocumentSplitter, BinaryContentTransformer, CharacterCaseTransformer, CharsetTransformer, CollapseRepeatingTransformer, ConditionalDocHandler, ConstantTransformer, CopyTransformer, CountMatchesTransformer, CsvSplitter, CurrentDateTransformer, DateFormatTransformer, DebugTransformer, DefaultParser, DeleteTransformer, DocumentLengthTransformer, DomSplitter, DomTransformer, ExternalParser, ExternalTransformer, FieldReportTransformer, ForceSingleValueTransformer, HierarchyTransformer, If, IfNot, ImageTransformer, KeepOnlyTransformer, LanguageTransformer, MergeTransformer, PdfPageSplitter, RegexTransformer, Reject, RenameTransformer, ReplaceTransformer, SaveDocumentTransformer, ScriptTransformer, SplitTransformer, StripAfterTransformer, StripBeforeTransformer, StripBetweenTransformer, SubstringTransformer, TextBetweenTransformer, TextStatisticsTransformer, TikaParser, TitleGeneratorTransformer, TranslatorSplitter, TruncateTransformer, UrlExtractorTransformer, UuidTransformer, XmlStreamSplitter
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface DocHandler
Document Handler are responsible for interacting with a document to either parse it, transform it, decorate it, split it, translate it, filter it, etc.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    NAME
    Default serialization id name.

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    close()
    Closes any required resources.
    boolean
    handle(DocHandlerContext docHandlerContext)
    Perform any operations on a document.
    default void
    init()
    Initialize any required resources.

  • Field Details

  • Method Details

    • init

      default void init() throws IOException
      Initialize any required resources. Invoked once per Importer instance, by the Importer.
      Throws:
      IOException - An I/O exception of some sort has occurred

    • handle

      boolean handle(DocHandlerContext docHandlerContext) throws IOException
      Perform any operations on a document.
      Parameters:
      docHandlerContext - the document handling context
      Returns:
      false to stop processing and reject a document or true to proceed to the next configured handler.
      Throws:
      IOException - An I/O exception of some sort has occurred

    • close

      default void close() throws IOException
      Closes any required resources. Invoked once per Importer instance, by the Importer.
      Throws:
      IOException - An I/O exception of some sort has occurred