core/org.gnit.lucenekmp.document/ShapeDocValuesField

ShapeDocValuesField

abstract class ShapeDocValuesField(name: String, shapeDocValues: ShapeDocValues) : Field

A doc values field for LatLonShape and XYShape that uses ShapeDocValues as the underlying binary doc value format.

Inheritors

LatLonShapeDocValuesField

XYShapeDocValuesField

Constructors

ShapeDocValuesField

constructor(name: String, shapeDocValues: ShapeDocValues)

Types

object Companion

Creates a geometry query for shape docvalues

Properties

charSequenceValue

open override val charSequenceValue: CharSequence?

Functions

open override fun binaryValue(): BytesRef?

Non-null if this field has a binary value

open override fun fieldType(): IndexableFieldType

Gets the IndexableFieldType for this ShapeDocValue field

abstract fun getBoundingBox(): Geometry

retrieves the bounding box for the geometry

abstract fun getCentroid(): Geometry

retrieves the centroid location for the geometry

getHighestDimensionType

fun getHighestDimensionType(): ShapeField.DecodedTriangle.TYPE

Retrieves the highest dimensional type (POINT, LINE, TRIANGLE) for computing the geometry(s) centroid.

open override fun invertableType(): InvertableType

Describes how this field should be inverted. This must return a non-null value if the field indexes terms and postings.

open override fun name(): String

The name of the field

fun numberOfTerms(): Int

Returns the number of terms (tessellated triangles) for this shape

open override fun numericValue(): Number?

Non-null if this field has a numeric value

open override fun readerValue(): Reader?

The value of the field as a Reader, or null. If null, the String value or binary value is used. Exactly one of stringValue(), readerValue(), and binaryValue() must be set.

fun setBytesValue(value: ByteArray)

open fun setBytesValue(value: BytesRef)

Expert: change the value of this field. See .setStringValue.

fun setByteValue(value: Byte)

Expert: change the value of this field. See .setStringValue.

open fun setDoubleValue(value: Double)

Expert: change the value of this field. See .setStringValue.

open fun setFloatValue(value: Float)

Expert: change the value of this field. See .setStringValue.

open fun setIntValue(value: Int)

Expert: change the value of this field. See .setStringValue.

open fun setLongValue(value: Long)

Expert: change the value of this field. See .setStringValue.

fun setReaderValue(value: Reader)

Expert: change the value of this field. See .setStringValue.

fun setShortValue(value: Short)

Expert: change the value of this field. See .setStringValue.

open fun setStringValue(value: String)

Expert: change the value of this field. This can be used during indexing to re-use a single Field instance to improve indexing speed by avoiding GC cost of new'ing and reclaiming Field instances. Typically a single Document instance is re-used as well. This helps most on small documents.

fun setTokenStream(tokenStream: TokenStream)

Expert: sets the token stream to be used for indexing.

open override fun storedValue(): StoredValue?

Stored value. This method is called to populate stored fields and must return a non-null value if the field stored.

open override fun stringValue(): String?

Currently there is no string representation for the ShapeDocValueField

open override fun tokenStream(analyzer: Analyzer, reuse: TokenStream?): TokenStream?

TokenStreams are not yet supported

tokenStreamValue

fun tokenStreamValue(): TokenStream?

The TokenStream for this field to be used when indexing, or null. If null, the Reader value or String value is analyzed to produce the indexed tokens.

open override fun toString(): String

Prints a Field for human consumption.