PointValue (Lucene 10.5.0 core API)
Description: declaration: package: org.apache.lucene.util.bkd, interface: PointValue

Package org.apache.lucene.util.bkd

# Interface PointValue

public interface PointValue
Represents a dimensional point value written in the BKD tree.

NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `int`
  `docID()`
  Returns the docID
  `BytesRef`
  `packedValue()`
  Returns the packed values for the dimensions
  `BytesRef`
  `packedValueDocIDBytes()`
  Returns the byte representation of the packed value together with the docID

- ## Method Details

  - ### packedValue

    BytesRef packedValue()
    Returns the packed values for the dimensions

  - ### docID

    int docID()
    Returns the docID

  - ### packedValueDocIDBytes

    BytesRef packedValueDocIDBytes()
    Returns the byte representation of the packed value together with the docID