Package com.apple.foundationdb.record.lucene

Class LuceneIndexKeyValueToPartialRecordUtils

java.lang.Object

com.apple.foundationdb.record.lucene.LuceneIndexKeyValueToPartialRecordUtils

public class LuceneIndexKeyValueToPartialRecordUtils
extends Object

A utility class to build a partial record for an auto-complete suggestion value, with grouping keys if there exist.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LuceneIndexKeyValueToPartialRecordUtils.LuceneSpellCheckCopier	The copier to populate the lucene auto complete suggestion as a value for the field where it is indexed from.

Method Summary

Modifier and Type	Method	Description
static void	buildPartialRecord(KeyExpression root, Descriptors.Descriptor descriptor, Message.Builder builder, String luceneField, String suggestion)
static void	buildPartialRecord(KeyExpression root, Descriptors.Descriptor descriptor, Message.Builder builder, String luceneField, String suggestion, Tuple groupingKey)
static IndexKeyValueToPartialRecord	getToPartialRecord(Index index, RecordType recordType, IndexScanType scanType)	Get the IndexKeyValueToPartialRecord instance for an IndexEntry representing a result of Lucene auto-complete suggestion.
static void	populatePrimaryKey(KeyExpression primaryKey, Descriptors.Descriptor descriptor, Message.Builder builder, Tuple tuple)

Methods inherited from class java.lang.Object

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

Method Details

buildPartialRecord

public static void buildPartialRecord(@Nonnull
 KeyExpression root,
 @Nonnull
 Descriptors.Descriptor descriptor,
 @Nonnull
 Message.Builder builder,
 @Nonnull
 String luceneField,
 @Nonnull
 String suggestion)

buildPartialRecord

public static void buildPartialRecord(@Nonnull
 KeyExpression root,
 @Nonnull
 Descriptors.Descriptor descriptor,
 @Nonnull
 Message.Builder builder,
 @Nonnull
 String luceneField,
 @Nonnull
 String suggestion,
 @Nonnull
 Tuple groupingKey)

populatePrimaryKey

public static void populatePrimaryKey(@Nonnull
 KeyExpression primaryKey,
 @Nonnull
 Descriptors.Descriptor descriptor,
 @Nonnull
 Message.Builder builder,
 @Nonnull
 Tuple tuple)

getToPartialRecord

@Nonnull
public static IndexKeyValueToPartialRecord getToPartialRecord(@Nonnull
 Index index,
 @Nonnull
 RecordType recordType,
 @Nonnull
 IndexScanType scanType)

Get the IndexKeyValueToPartialRecord instance for an IndexEntry representing a result of Lucene auto-complete suggestion. The partial record contains the suggestion in the field where it is indexed from, and the grouping keys if there are any.

Parameters:

index - the index being scanned

recordType - the record type for indexed records

scanType - the type of scan

Returns:

a partial record generator