de.digitalcollections.solrocr.formats

Interface OcrFormat

All Known Implementing Classes:

AltoFormat, HocrFormat, MiniOcrFormat

public interface OcrFormat

Provides access to format-specific BreakIterator and OcrPassageFormatter instances.

Method Summary

Modifier and Type	Method and Description
BreakIterator	getBreakIterator(OcrBlock breakBlock, OcrBlock limitBlock, int contextSize) Get a BreakIterator that splits the content according to the break parameters
OcrPassageFormatter	getPassageFormatter(String prehHighlightTag, String postHighlightTag, boolean absoluteHighlights) Get a PassageFormatter that builds OCR snippets from passages

Method Detail

getBreakIterator

BreakIterator getBreakIterator(OcrBlock breakBlock,
                               OcrBlock limitBlock,
                               int contextSize)

Get a BreakIterator that splits the content according to the break parameters

Parameters:

breakBlock - the type of OcrBlock that the input document is split on to build passages

limitBlock - the type of OcrBlock that a passage may not cross

contextSize - the number of break blocks in a context that forms a highlighting passage

getPassageFormatter

OcrPassageFormatter getPassageFormatter(String prehHighlightTag,
                                        String postHighlightTag,
                                        boolean absoluteHighlights)

Get a PassageFormatter that builds OCR snippets from passages

Parameters:

prehHighlightTag - the tag to put in the snippet text before a highlighted region, e.g. <em>

postHighlightTag - the tag to put in the snippet text after a highlighted region, e.g. </em>

absoluteHighlights - whether the coordinates for highlights should be absolute, i.e. relative to the page and not the containing snippet