de.digitalcollections.solrocr.formats.OcrFormat Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of solr-ocrhighlighting Show documentation

Solr plugin to add support for highlighting directly from various OCR formats (hOCR/ALTO/MiniOCR) without having to store the OCR documents in the index.

There is a newer version: 0.7.0

Show newest version

package de.digitalcollections.solrocr.formats;

import java.text.BreakIterator;

/**
 * Provides access to format-specific {@link BreakIterator} and {@link OcrPassageFormatter} instances.
 */
public interface OcrFormat {
  /** Get a BreakIterator that splits the content according to the break parameters
   *
   * @param breakBlock the type of {@link OcrBlock} that the input document is split on to build passages
   * @param limitBlock the type of {@link OcrBlock} that a passage may not cross
   * @param contextSize the number of break blocks in a context that forms a highlighting passage
   * */
  BreakIterator getBreakIterator(OcrBlock breakBlock, OcrBlock limitBlock, int contextSize);

  /**
   * Get a PassageFormatter that builds OCR snippets from passages
   *
   * @param prehHighlightTag the tag to put in the snippet text before a highlighted region, e.g. <em>
   * @param postHighlightTag the tag to put in the snippet text after a highlighted region, e.g. </em>
   * @param absoluteHighlights whether the coordinates for highlights should be absolute, i.e. relative to the page
   *                           and not the containing snippet
   */
  OcrPassageFormatter getPassageFormatter(String prehHighlightTag, String postHighlightTag, boolean absoluteHighlights);
}