Package com.apple.foundationdb.record.lucene

Class LuceneScanQueryParameters.LuceneQueryHighlightParameters

java.lang.Object

com.apple.foundationdb.record.lucene.LuceneScanQueryParameters.LuceneQueryHighlightParameters

Enclosing class:

LuceneScanQueryParameters

public static class LuceneScanQueryParameters.LuceneQueryHighlightParameters
extends Object

The parameters for highlighting matching terms of a Lucene search.

Constructor Summary

Constructors

Constructor	Description
LuceneQueryHighlightParameters(int snippetSize, int maxMatchCount)	Create parameter for lucene query highlights.
LuceneQueryHighlightParameters(int snippetSize, int maxMatchCount, org.apache.lucene.search.Query theQuery)

Method Summary

Modifier and Type	Method	Description
int	getMaxMatchCount()
org.apache.lucene.search.Query	getQuery()
int	getSnippedSize()
boolean	isCutSnippets()

Methods inherited from class java.lang.Object

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

Constructor Details

LuceneQueryHighlightParameters

public LuceneQueryHighlightParameters(int snippetSize,
 int maxMatchCount)

Create parameter for lucene query highlights.

Parameters:

snippetSize - The size of the snippets that should be returned by the query. If zero or less, return the entire text

maxMatchCount - The maximum number of times a query will match during highlighting before the highlighter stops

LuceneQueryHighlightParameters

public LuceneQueryHighlightParameters(int snippetSize,
 int maxMatchCount,
 org.apache.lucene.search.Query theQuery)

Method Details

getQuery

public org.apache.lucene.search.Query getQuery()

isCutSnippets

public boolean isCutSnippets()

getSnippedSize

public int getSnippedSize()

getMaxMatchCount

public int getMaxMatchCount()