Package com.apple.foundationdb.record.lucene

Class LuceneScanQuery

java.lang.Object

com.apple.foundationdb.record.lucene.LuceneScanBounds

com.apple.foundationdb.record.lucene.LuceneScanQuery

All Implemented Interfaces:

IndexScanBounds

@API(UNSTABLE)
public class LuceneScanQuery
extends LuceneScanBounds

Scan a LUCENE index using a Lucene Query.

Field Summary

Fields inherited from class com.apple.foundationdb.record.lucene.LuceneScanBounds

groupKey, scanType

Constructor Summary

Constructors

Constructor	Description
LuceneScanQuery(IndexScanType scanType, Tuple groupKey, org.apache.lucene.search.Query query, org.apache.lucene.search.Sort sort, List<String> storedFields, List<LuceneIndexExpressions.DocumentFieldType> storedFieldTypes, LuceneScanQueryParameters.LuceneQueryHighlightParameters luceneQueryHighlightParameters, Map<String,Set<String>> termMap)

Method Summary

Modifier and Type	Method	Description
LuceneScanQueryParameters.LuceneQueryHighlightParameters	getLuceneQueryHighlightParameters()
org.apache.lucene.search.Query	getQuery()
org.apache.lucene.search.Sort	getSort()
List<String>	getStoredFields()
List<LuceneIndexExpressions.DocumentFieldType>	getStoredFieldTypes()
Map<String,Set<String>>	getTermMap()
String	toString()

Methods inherited from class com.apple.foundationdb.record.lucene.LuceneScanBounds

getGroupKey, getScanType

Methods inherited from class java.lang.Object

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

Constructor Details

LuceneScanQuery

public LuceneScanQuery(@Nonnull
 IndexScanType scanType,
 @Nonnull
 Tuple groupKey,
 @Nonnull
 org.apache.lucene.search.Query query,
 @Nullable
 org.apache.lucene.search.Sort sort,
 @Nullable
 List<String> storedFields,
 @Nullable
 List<LuceneIndexExpressions.DocumentFieldType> storedFieldTypes,
 @Nullable
 LuceneScanQueryParameters.LuceneQueryHighlightParameters luceneQueryHighlightParameters,
 @Nullable
 Map<String,Set<String>> termMap)

Method Details

getQuery

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

getSort

@Nullable
public org.apache.lucene.search.Sort getSort()

getStoredFields

@Nullable
public List<String> getStoredFields()

getStoredFieldTypes

@Nullable
public List<LuceneIndexExpressions.DocumentFieldType> getStoredFieldTypes()

getLuceneQueryHighlightParameters

@Nullable
public LuceneScanQueryParameters.LuceneQueryHighlightParameters getLuceneQueryHighlightParameters()

getTermMap

@Nullable
public Map<String,Set<String>> getTermMap()

toString

public String toString()

Overrides:

toString in class LuceneScanBounds