com.mapr.db.index

Interface IndexFieldDesc

All Superinterfaces:

org.ojai.JsonString

public interface IndexFieldDesc
extends org.ojai.JsonString

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IndexFieldDesc.Order

Method Summary

Modifier and Type	Method and Description
org.ojai.FieldPath	getFieldPath() Returns the canonical field name of this field descriptor.
java.lang.String	getFunctionName() Returns functional indexing function represented by string, null if no function
IndexFieldDesc.Order	getSortOrder() Returns the ordering scheme of this field in the Index.
boolean	isFunctional() Return true if this is a functional index field.
boolean	isOnMTime() Return true if this fields is on system modified time.

Methods inherited from interface org.ojai.JsonString

asJsonString, asJsonString

Method Detail

getFieldPath

org.ojai.FieldPath getFieldPath()

Returns the canonical field name of this field descriptor.

getSortOrder

IndexFieldDesc.Order getSortOrder()

Returns the ordering scheme of this field in the Index.

isFunctional

boolean isFunctional()

Return true if this is a functional index field.

getFunctionName

java.lang.String getFunctionName()

Returns functional indexing function represented by string, null if no function

isOnMTime

boolean isOnMTime()

Return true if this fields is on system modified time.