Package com.apple.foundationdb.record.lucene

Class LuceneIndexExpressions.DocumentFieldDerivation

java.lang.Object

com.apple.foundationdb.record.lucene.LuceneIndexExpressions.DocumentFieldDerivation

Enclosing class:

LuceneIndexExpressions

public static class LuceneIndexExpressions.DocumentFieldDerivation
extends Object

Information about how a document field is derived from a record field.

Constructor Summary

Constructors

Constructor	Description
DocumentFieldDerivation(String documentField, List<String> recordFieldPath, LuceneIndexExpressions.DocumentFieldType type, boolean fieldNameOverride, String namedFieldSuffix, boolean stored, boolean sorted)

Method Summary

Modifier and Type	Method	Description
String	getDocumentField()
String	getNamedFieldSuffix()
org.apache.lucene.queryparser.flexible.standard.config.PointsConfig	getPointsConfig()	Get the Point configuration that is used by the Lucene Parser to interpret the type of data stored for this field.
List<String>	getRecordFieldPath()
LuceneIndexExpressions.DocumentFieldType	getType()
boolean	isFieldNameOverride()
boolean	isSorted()
boolean	isStored()

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentFieldDerivation

public DocumentFieldDerivation(@Nonnull
 String documentField,
 @Nonnull
 List<String> recordFieldPath,
 @Nonnull
 LuceneIndexExpressions.DocumentFieldType type,
 boolean fieldNameOverride,
 @Nullable
 String namedFieldSuffix,
 boolean stored,
 boolean sorted)

Method Details

getDocumentField

@Nonnull
public String getDocumentField()

getRecordFieldPath

@Nonnull
public List<String> getRecordFieldPath()

getType

@Nonnull
public LuceneIndexExpressions.DocumentFieldType getType()

isFieldNameOverride

public boolean isFieldNameOverride()

getNamedFieldSuffix

@Nullable
public String getNamedFieldSuffix()

isStored

public boolean isStored()

isSorted

public boolean isSorted()

getPointsConfig

public org.apache.lucene.queryparser.flexible.standard.config.PointsConfig getPointsConfig()

Get the Point configuration that is used by the Lucene Parser to interpret the type of data stored for this field.

Returns:

the PointsConfig for this field.