XYShapeDocValuesField

Concrete implementation of a ShapeDocValuesField for cartesian geometries.

This field should be instantiated through XYShape.createDocValueField with XYLine

Properties

Link copied to clipboard
open override val charSequenceValue: CharSequence?

Functions

Link copied to clipboard
open override fun binaryValue(): BytesRef?

Non-null if this field has a binary value

Link copied to clipboard
open override fun fieldType(): IndexableFieldType

Gets the IndexableFieldType for this ShapeDocValue field

Link copied to clipboard
open override fun getBoundingBox(): XYRectangle

retrieves the bounding box for the geometry

Link copied to clipboard
open override fun getCentroid(): XYPoint

retrieves the centroid location for the geometry

Link copied to clipboard

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

Link copied to clipboard
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.

Link copied to clipboard
open override fun name(): String

The name of the field

Link copied to clipboard

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

Link copied to clipboard
open override fun numericValue(): Number?

Non-null if this field has a numeric value

Link copied to clipboard
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.

Link copied to clipboard
open fun setBytesValue(value: BytesRef)

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

Link copied to clipboard
fun setByteValue(value: Byte)

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

Link copied to clipboard
open fun setDoubleValue(value: Double)

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

Link copied to clipboard
open fun setFloatValue(value: Float)

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

Link copied to clipboard
open fun setIntValue(value: Int)

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

Link copied to clipboard
open fun setLongValue(value: Long)

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

Link copied to clipboard

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

Link copied to clipboard
fun setShortValue(value: Short)

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

Link copied to clipboard
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.

Link copied to clipboard
fun setTokenStream(tokenStream: TokenStream)

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

Link copied to clipboard
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.

Link copied to clipboard
open override fun stringValue(): String?

Currently there is no string representation for the ShapeDocValueField

Link copied to clipboard
open override fun tokenStream(analyzer: Analyzer, reuse: TokenStream?): TokenStream?

TokenStreams are not yet supported

Link copied to clipboard

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.

Link copied to clipboard
open override fun toString(): String

Prints a Field for human consumption.