Uses of Class org.apache.lucene.index.SegmentWriteState (Lucene 10.5.1 core API)
Description: use: package: org.apache.lucene.index, class: SegmentWriteState

# Uses of Class
org.apache.lucene.index.SegmentWriteState

Packages that use SegmentWriteState
Package
Description
org.apache.lucene.codecs
Codecs API: API for customization of the encoding and structure of the index.
org.apache.lucene.codecs.hnsw
HNSW vector helper classes.
org.apache.lucene.codecs.lucene103.blocktree
BlockTree terms dictionary.
org.apache.lucene.codecs.lucene104
Lucene 10.4 file format.
org.apache.lucene.codecs.lucene90
Lucene 9.0 file format.
org.apache.lucene.codecs.lucene99
Lucene 9.9 file format.
org.apache.lucene.codecs.perfield
Postings format that can delegate to different formats per-field.
org.apache.lucene.index
Code to maintain and access indices.
org.apache.lucene.util.quantization
Provides quantization methods for scaling vector values to smaller data types and possibly fewer dimensions

- ## Uses of SegmentWriteState in org.apache.lucene.codecs

  Methods in org.apache.lucene.codecs with parameters of type SegmentWriteState
  Modifier and Type
  Method
  Description
  `abstract DocValuesConsumer`
  DocValuesFormat.`fieldsConsumer(SegmentWriteState state)`
  Returns a `DocValuesConsumer` to write docvalues to the index.
  `abstract FieldsConsumer`
  PostingsFormat.`fieldsConsumer(SegmentWriteState state)`
  Writes a new segment
  `abstract KnnVectorsWriter`
  KnnVectorsFormat.`fieldsWriter(SegmentWriteState state)`
  Returns a `KnnVectorsWriter` to write the vectors to the index.
  `abstract PointsWriter`
  PointsFormat.`fieldsWriter(SegmentWriteState state)`
  Writes a new segment
  `abstract void`
  PostingsWriterBase.`init(IndexOutput termsOut, SegmentWriteState state)`
  Called once after startup, before any terms have been added.
  `abstract NormsConsumer`
  NormsFormat.`normsConsumer(SegmentWriteState state)`
  Returns a `NormsConsumer` to write norms to the index.

- ## Uses of SegmentWriteState in org.apache.lucene.codecs.hnsw

  Methods in org.apache.lucene.codecs.hnsw with parameters of type SegmentWriteState
  Modifier and Type
  Method
  Description
  `abstract FlatVectorsWriter`
  FlatVectorsFormat.`fieldsWriter(SegmentWriteState state)`
  Returns a `FlatVectorsWriter` to write the vectors to the index.

- ## Uses of SegmentWriteState in org.apache.lucene.codecs.lucene103.blocktree

  Constructors in org.apache.lucene.codecs.lucene103.blocktree with parameters of type SegmentWriteState
  Modifier
  Constructor
  Description
  ``
  `Lucene103BlockTreeTermsWriter(SegmentWriteState state, PostingsWriterBase postingsWriter, int minItemsInBlock, int maxItemsInBlock)`
  Create a new writer.
  ``
  `Lucene103BlockTreeTermsWriter(SegmentWriteState state, PostingsWriterBase postingsWriter, int minItemsInBlock, int maxItemsInBlock, int version)`
  Expert constructor that allows configuring the version, used for bw tests.

- ## Uses of SegmentWriteState in org.apache.lucene.codecs.lucene104

  Methods in org.apache.lucene.codecs.lucene104 with parameters of type SegmentWriteState
  Modifier and Type
  Method
  Description
  `FieldsConsumer`
  Lucene104PostingsFormat.`fieldsConsumer(SegmentWriteState state)`
  `KnnVectorsWriter`
  Lucene104HnswScalarQuantizedVectorsFormat.`fieldsWriter(SegmentWriteState state)`
  `FlatVectorsWriter`
  Lucene104ScalarQuantizedVectorsFormat.`fieldsWriter(SegmentWriteState state)`
  `CloseableRandomVectorScorerSupplier`
  Lucene104ScalarQuantizedVectorsReader.`getRandomVectorScorerSupplierForMerge(FieldInfo fieldInfo, SegmentWriteState segmentWriteState)`
  `void`
  Lucene104PostingsWriter.`init(IndexOutput termsOut, SegmentWriteState state)`
  Constructors in org.apache.lucene.codecs.lucene104 with parameters of type SegmentWriteState
  Modifier
  Constructor
  Description
  ``
  `Lucene104PostingsWriter(SegmentWriteState state)`
  Sole public constructor.
  ``
  `Lucene104ScalarQuantizedVectorsWriter(SegmentWriteState state, QuantizedByteVectorValues.ScalarEncoding encoding, FlatVectorsWriter rawVectorDelegate, Lucene104ScalarQuantizedVectorScorer vectorsScorer)`
  Sole constructor

- ## Uses of SegmentWriteState in org.apache.lucene.codecs.lucene90

  Methods in org.apache.lucene.codecs.lucene90 with parameters of type SegmentWriteState
  Modifier and Type
  Method
  Description
  `DocValuesConsumer`
  Lucene90DocValuesFormat.`fieldsConsumer(SegmentWriteState state)`
  `PointsWriter`
  Lucene90PointsFormat.`fieldsWriter(SegmentWriteState state)`
  `NormsConsumer`
  Lucene90NormsFormat.`normsConsumer(SegmentWriteState state)`
  Constructors in org.apache.lucene.codecs.lucene90 with parameters of type SegmentWriteState
  Modifier
  Constructor
  Description
  ``
  `Lucene90PointsWriter(SegmentWriteState writeState)`
  Uses the defaults values for `maxPointsInLeafNode` (512) and `maxMBSortInHeap` (16.0)
  ``
  `Lucene90PointsWriter(SegmentWriteState writeState, int maxPointsInLeafNode, double maxMBSortInHeap)`
  ``
  `Lucene90PointsWriter(SegmentWriteState writeState, int maxPointsInLeafNode, double maxMBSortInHeap, int version)`
  Full constructor

- ## Uses of SegmentWriteState in org.apache.lucene.codecs.lucene99

  Methods in org.apache.lucene.codecs.lucene99 with parameters of type SegmentWriteState
  Modifier and Type
  Method
  Description
  `FlatVectorsWriter`
  Lucene99FlatVectorsFormat.`fieldsWriter(SegmentWriteState state)`
  `KnnVectorsWriter`
  Lucene99HnswVectorsFormat.`fieldsWriter(SegmentWriteState state)`
  `CloseableRandomVectorScorerSupplier`
  Lucene99HnswVectorsReader.`getRandomVectorScorerSupplierForMerge(FieldInfo fieldInfo, SegmentWriteState segmentWriteState)`
  Constructors in org.apache.lucene.codecs.lucene99 with parameters of type SegmentWriteState
  Modifier
  Constructor
  Description
  ``
  `Lucene99FlatVectorsWriter(SegmentWriteState state, FlatVectorsScorer scorer)`
  Constructs a writer that uses the default factory to build per-field vector storage.
  ``
  `Lucene99FlatVectorsWriter(SegmentWriteState state, FlatVectorsScorer scorer, IOFunction<FieldInfo,FlatFieldVectorsWriter<?>> strategyFactory)`
  Constructs a writer that uses the supplied `strategyFactory` to build per-field vector storage.
  ``
  `Lucene99HnswVectorsWriter(SegmentWriteState state, int M, int beamWidth, FlatVectorsFormat flatVectorsFormat, FlatVectorsWriter flatVectorWriter, int numMergeWorkers, TaskExecutor mergeExec)`
  ``
  `Lucene99HnswVectorsWriter(SegmentWriteState state, int M, int beamWidth, FlatVectorsFormat flatVectorsFormat, FlatVectorsWriter flatVectorWriter, int numMergeWorkers, TaskExecutor mergeExec, int tinySegmentsThreshold)`

- ## Uses of SegmentWriteState in org.apache.lucene.codecs.perfield

  Methods in org.apache.lucene.codecs.perfield with parameters of type SegmentWriteState
  Modifier and Type
  Method
  Description
  `final DocValuesConsumer`
  PerFieldDocValuesFormat.`fieldsConsumer(SegmentWriteState state)`
  `final FieldsConsumer`
  PerFieldPostingsFormat.`fieldsConsumer(SegmentWriteState state)`
  `KnnVectorsWriter`
  PerFieldKnnVectorsFormat.`fieldsWriter(SegmentWriteState state)`

- ## Uses of SegmentWriteState in org.apache.lucene.index

  Constructors in org.apache.lucene.index with parameters of type SegmentWriteState
  Modifier
  Constructor
  Description
  ``
  `SegmentWriteState(SegmentWriteState state, String segmentSuffix)`
  Create a shallow copy of `SegmentWriteState` with a new segment suffix.

- ## Uses of SegmentWriteState in org.apache.lucene.util.quantization

  Methods in org.apache.lucene.util.quantization with parameters of type SegmentWriteState
  Modifier and Type
  Method
  Description
  `CloseableRandomVectorScorerSupplier`
  QuantizedVectorsReader.`getRandomVectorScorerSupplierForMerge(FieldInfo fieldInfo, SegmentWriteState segmentWriteState)`
  Provides a scorer for merging this quantized vector reader.