de.digitalcollections.solrocr.lucene

Class OcrFieldHighlighter

java.lang.Object

org.apache.lucene.search.uhighlight.FieldHighlighter

de.digitalcollections.solrocr.lucene.OcrFieldHighlighter

public class OcrFieldHighlighter
extends org.apache.lucene.search.uhighlight.FieldHighlighter

A customization of FieldHighlighter to support lazy-loaded field values and byte offsets from payloads.

Field Summary

Fields

Modifier and Type	Field and Description
protected FieldByteOffsetStrategy	fieldByteOffsetStrategy

Fields inherited from class org.apache.lucene.search.uhighlight.FieldHighlighter

breakIterator, field, fieldOffsetStrategy, maxNoHighlightPassages, maxPassages, passageFormatter, passageScorer

Constructor Summary

Constructors

Constructor and Description
OcrFieldHighlighter(String field, org.apache.lucene.search.uhighlight.FieldOffsetStrategy fieldOffsetStrategy, FieldByteOffsetStrategy fieldByteOffsetStrategy, org.apache.lucene.search.uhighlight.PassageScorer passageScorer, BreakIterator breakIter, OcrPassageFormatter formatter, int maxPassages, int maxNoHighlightPassages)

Method Summary

Modifier and Type	Method and Description
int	getNumMatches(int docId)
protected org.apache.lucene.search.uhighlight.Passage[]	getSummaryPassagesNoHighlight(int maxPassages) We don't provide summaries if there is no highlighting, i.e.
protected org.apache.lucene.search.uhighlight.Passage[]	highlightByteOffsetsEnums(ByteOffsetsEnum off, int docId, String pageId) Highlight passages from the document using the byte offsets in the payloads of the matching terms.
OcrSnippet[]	highlightFieldForDoc(org.apache.lucene.index.LeafReader reader, int docId, IterableCharSequence content, String pageId) The primary method -- highlight this doc, assuming a specific field and given this content.
protected org.apache.lucene.search.uhighlight.Passage[]	highlightOffsetsEnums(org.apache.lucene.search.uhighlight.OffsetsEnum off)
protected org.apache.lucene.search.uhighlight.Passage[]	highlightOffsetsEnums(org.apache.lucene.search.uhighlight.OffsetsEnum off, int docId, String pageId)

Methods inherited from class org.apache.lucene.search.uhighlight.FieldHighlighter

getField, getOffsetSource, highlightFieldForDoc

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

fieldByteOffsetStrategy

protected FieldByteOffsetStrategy fieldByteOffsetStrategy

Constructor Detail

OcrFieldHighlighter

public OcrFieldHighlighter(String field,
                           org.apache.lucene.search.uhighlight.FieldOffsetStrategy fieldOffsetStrategy,
                           FieldByteOffsetStrategy fieldByteOffsetStrategy,
                           org.apache.lucene.search.uhighlight.PassageScorer passageScorer,
                           BreakIterator breakIter,
                           OcrPassageFormatter formatter,
                           int maxPassages,
                           int maxNoHighlightPassages)

Method Detail

highlightFieldForDoc

public OcrSnippet[] highlightFieldForDoc(org.apache.lucene.index.LeafReader reader,
                                         int docId,
                                         IterableCharSequence content,
                                         String pageId)
                                  throws IOException

The primary method -- highlight this doc, assuming a specific field and given this content. Largely copied from FieldHighlighter.highlightFieldForDoc(LeafReader, int, String), modified to support an IterableCharSequence as content.

Throws:

IOException

highlightOffsetsEnums

protected org.apache.lucene.search.uhighlight.Passage[] highlightOffsetsEnums(org.apache.lucene.search.uhighlight.OffsetsEnum off)
                                                                       throws IOException

Overrides:

highlightOffsetsEnums in class org.apache.lucene.search.uhighlight.FieldHighlighter

Throws:

IOException

highlightOffsetsEnums

protected org.apache.lucene.search.uhighlight.Passage[] highlightOffsetsEnums(org.apache.lucene.search.uhighlight.OffsetsEnum off,
                                                                              int docId,
                                                                              String pageId)
                                                                       throws IOException

Throws:

IOException

highlightByteOffsetsEnums

protected org.apache.lucene.search.uhighlight.Passage[] highlightByteOffsetsEnums(ByteOffsetsEnum off,
                                                                                  int docId,
                                                                                  String pageId)
                                                                           throws IOException

Highlight passages from the document using the byte offsets in the payloads of the matching terms. Largely copied from FieldHighlighter.highlightOffsetsEnums(OffsetsEnum), modified to load the byte offsets from the term payloads.

Throws:

IOException

getSummaryPassagesNoHighlight

protected org.apache.lucene.search.uhighlight.Passage[] getSummaryPassagesNoHighlight(int maxPassages)

We don't provide summaries if there is no highlighting, i.e. no matches in the OCR text

Overrides:

getSummaryPassagesNoHighlight in class org.apache.lucene.search.uhighlight.FieldHighlighter

getNumMatches

public int getNumMatches(int docId)