org.apache.lucene.codecs.lucene86

## Class Lucene86PointsWriter

- java.lang.Object
- - org.apache.lucene.codecs.PointsWriter
  - - org.apache.lucene.codecs.lucene86.Lucene86PointsWriter

- All Implemented Interfaces:
    Closeable, AutoCloseable

      public class Lucene86PointsWriter
      extends PointsWriter
      implements Closeable

  Writes dimensional values

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected IndexOutput` | `dataOut` Outputs used to write the BKD tree data files.
    `protected IndexOutput` | `indexOut` Outputs used to write the BKD tree data files.
    `protected IndexOutput` | `metaOut` Outputs used to write the BKD tree data files.

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `Lucene86PointsWriter(SegmentWriteState writeState)` Uses the defaults values for `maxPointsInLeafNode` (1024) and `maxMBSortInHeap` (16.0)
    `Lucene86PointsWriter(SegmentWriteState writeState, int maxPointsInLeafNode, double maxMBSortInHeap)` Full constructor

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `close()`
    `void` | `finish()` Called once at the end before close
    `void` | `merge(MergeState mergeState)` Default merge implementation to merge incoming points readers by visiting all their points and adding to this writer
    `void` | `writeField(FieldInfo fieldInfo, PointsReader reader)` Write all values contained in the provided reader

    - ### Methods inherited from class org.apache.lucene.codecs.PointsWriter

      `mergeOneField`

    - ### Methods inherited from class java.lang.Object

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

- - ### Field Detail

    - #### metaOut

          protected final IndexOutput metaOut

      Outputs used to write the BKD tree data files.

    - #### indexOut

          protected final IndexOutput indexOut

      Outputs used to write the BKD tree data files.

    - #### dataOut

          protected final IndexOutput dataOut

      Outputs used to write the BKD tree data files.

  - ### Constructor Detail

    - #### Lucene86PointsWriter

          public Lucene86PointsWriter(SegmentWriteState writeState,
                                      int maxPointsInLeafNode,
                                      double maxMBSortInHeap)
                               throws IOException

      Full constructor
      Throws:
        `IOException`

    - #### Lucene86PointsWriter

          public Lucene86PointsWriter(SegmentWriteState writeState)
                               throws IOException

      Uses the defaults values for `maxPointsInLeafNode` (1024) and `maxMBSortInHeap` (16.0)
      Throws:
        `IOException`

  - ### Method Detail

    - #### writeField

          public void writeField(FieldInfo fieldInfo,
                                 PointsReader reader)
                          throws IOException

      Description copied from class: `PointsWriter`
      Write all values contained in the provided reader
      Specified by:
        `writeField` in class `PointsWriter`
      Throws:
        `IOException`

    - #### merge

          public void merge(MergeState mergeState)
                     throws IOException

      Description copied from class: `PointsWriter`
      Default merge implementation to merge incoming points readers by visiting all their points and adding to this writer
      Overrides:
        `merge` in class `PointsWriter`
      Throws:
        `IOException`

    - #### finish

          public void finish()
                      throws IOException

      Description copied from class: `PointsWriter`
      Called once at the end before close
      Specified by:
        `finish` in class `PointsWriter`
      Throws:
        `IOException`

    - #### close

          public void close()
                     throws IOException

      Specified by:
        `close` in interface `Closeable`
      Specified by:
        `close` in interface `AutoCloseable`
      Throws:
        `IOException`

Copyright © 2000-2024 Apache Software Foundation. All Rights Reserved.