de.digitalcollections.solrocr.lucene

Class OcrHighlighter

java.lang.Object

org.apache.lucene.search.uhighlight.UnifiedHighlighter

de.digitalcollections.solrocr.lucene.OcrHighlighter

public class OcrHighlighter
extends org.apache.lucene.search.uhighlight.UnifiedHighlighter

A UnifiedHighlighter variant to support lazy-loading field values from arbitrary storage and using byte offsets from term payloads for highlighting instead of character offsets.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.search.uhighlight.UnifiedHighlighter

org.apache.lucene.search.uhighlight.UnifiedHighlighter.HighlightFlag, org.apache.lucene.search.uhighlight.UnifiedHighlighter.LimitedStoredFieldVisitor, org.apache.lucene.search.uhighlight.UnifiedHighlighter.OffsetSource

Field Summary

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

DEFAULT_CACHE_CHARS_THRESHOLD, DEFAULT_MAX_LENGTH, fieldInfos, indexAnalyzer, MULTIVAL_SEP_CHAR, searcher, ZERO_LEN_AUTOMATA_ARRAY

Constructor Summary

Constructors

Constructor and Description
OcrHighlighter(org.apache.lucene.search.IndexSearcher indexSearcher, org.apache.lucene.analysis.Analyzer indexAnalyzer, ExternalFieldLoader fieldLoader, org.apache.solr.common.params.SolrParams params)

Method Summary

Modifier and Type	Method and Description
protected ByteOffsetPhraseHelper	getByteOffsetPhraseHelper(String field, org.apache.lucene.search.Query query, Set<org.apache.lucene.search.uhighlight.UnifiedHighlighter.HighlightFlag> highlightFlags)
protected FieldByteOffsetStrategy	getByteOffsetStrategy(org.apache.lucene.search.uhighlight.UnifiedHighlighter.OffsetSource offsetSource, OcrHComponents components)
Set<org.apache.lucene.search.uhighlight.UnifiedHighlighter.HighlightFlag>	getFlags(String field)
protected org.apache.lucene.search.uhighlight.PassageScorer	getScorer(String fieldName)
OcrHighlightResult[]	highlightOcrFields(String[] ocrFieldNames, org.apache.lucene.search.Query query, int[] docIDs, int[] maxPassagesOcr, BreakIterator breakIter, OcrPassageFormatter formatter, String pageId)
protected List<CharSequence[]>	loadFieldValues(String[] fields, org.apache.lucene.search.DocIdSetIterator docIter, int cacheCharsThreshold)
protected List<IterableCharSequence[]>	loadOcrFieldValues(String[] fields, org.apache.lucene.search.DocIdSetIterator docIter)

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

extractTerms, filterExtractedTerms, getAutomata, getBreakIterator, getCacheFieldValCharsThreshold, getFieldHighlighter, getFieldInfo, getFieldMatcher, getFormatter, getIndexAnalyzer, getIndexSearcher, getMaxLength, getMaxNoHighlightPassages, getOffsetSource, getOffsetStrategy, getOptimizedOffsetSource, getPhraseHelper, highlight, highlight, highlightFields, highlightFields, highlightFields, highlightFieldsAsObjects, highlightWithoutSearcher, newLimitedStoredFieldsVisitor, preSpanQueryRewrite, requiresRewrite, setBreakIterator, setCacheFieldValCharsThreshold, setFieldMatcher, setFormatter, setHandleMultiTermQuery, setHighlightPhrasesStrictly, setMaxLength, setMaxNoHighlightPassages, setScorer, shouldHandleMultiTermQuery, shouldHighlightPhrasesStrictly, shouldPreferPassageRelevancyOverSpeed

Methods inherited from class java.lang.Object

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

Constructor Detail

OcrHighlighter

public OcrHighlighter(org.apache.lucene.search.IndexSearcher indexSearcher,
                      org.apache.lucene.analysis.Analyzer indexAnalyzer,
                      ExternalFieldLoader fieldLoader,
                      org.apache.solr.common.params.SolrParams params)

Method Detail

getScorer

protected org.apache.lucene.search.uhighlight.PassageScorer getScorer(String fieldName)

Overrides:

getScorer in class org.apache.lucene.search.uhighlight.UnifiedHighlighter

getFlags

public Set<org.apache.lucene.search.uhighlight.UnifiedHighlighter.HighlightFlag> getFlags(String field)

Overrides:

getFlags in class org.apache.lucene.search.uhighlight.UnifiedHighlighter

highlightOcrFields

public OcrHighlightResult[] highlightOcrFields(String[] ocrFieldNames,
                                               org.apache.lucene.search.Query query,
                                               int[] docIDs,
                                               int[] maxPassagesOcr,
                                               BreakIterator breakIter,
                                               OcrPassageFormatter formatter,
                                               String pageId)
                                        throws IOException

Throws:

IOException

loadFieldValues

protected List<CharSequence[]> loadFieldValues(String[] fields,
                                               org.apache.lucene.search.DocIdSetIterator docIter,
                                               int cacheCharsThreshold)
                                        throws IOException

Overrides:

loadFieldValues in class org.apache.lucene.search.uhighlight.UnifiedHighlighter

Throws:

IOException

loadOcrFieldValues

protected List<IterableCharSequence[]> loadOcrFieldValues(String[] fields,
                                                          org.apache.lucene.search.DocIdSetIterator docIter)
                                                   throws IOException

Throws:

IOException

getByteOffsetPhraseHelper

protected ByteOffsetPhraseHelper getByteOffsetPhraseHelper(String field,
                                                           org.apache.lucene.search.Query query,
                                                           Set<org.apache.lucene.search.uhighlight.UnifiedHighlighter.HighlightFlag> highlightFlags)

getByteOffsetStrategy

protected FieldByteOffsetStrategy getByteOffsetStrategy(org.apache.lucene.search.uhighlight.UnifiedHighlighter.OffsetSource offsetSource,
                                                        OcrHComponents components)