Module org.elasticsearch.compute

Package org.elasticsearch.compute.lucene.read

Class SingletonOrdinalsBuilder

java.lang.Object

org.elasticsearch.compute.lucene.read.SingletonOrdinalsBuilder

All Implemented Interfaces:

Closeable, AutoCloseable, Block.Builder, Releasable, BlockLoader.Builder, BlockLoader.SingletonOrdinalsBuilder

public class SingletonOrdinalsBuilder
extends Object
implements BlockLoader.SingletonOrdinalsBuilder, Releasable, Block.Builder

Constructor Summary

Constructors

Constructor	Description
SingletonOrdinalsBuilder(BlockFactory blockFactory, org.apache.lucene.index.SortedDocValues docValues, int count, boolean isDense)

Method Summary

Modifier and Type	Method	Description
SingletonOrdinalsBuilder	appendNull()	Appends a null value to the block.
SingletonOrdinalsBuilder	appendOrd(int ord)
BlockLoader.SingletonOrdinalsBuilder	appendOrds(int[] values, int from, int length, int minOrd, int maxOrd)
BlockLoader.SingletonOrdinalsBuilder	appendOrds(int ord, int length)
SingletonOrdinalsBuilder	beginPositionEntry()	Begins a multivalued entry.
BytesRefBlock	build()	Builds the block.
void	close()
Block.Builder	copyFrom(Block block, int beginInclusive, int endExclusive)	Copy the values in block from beginInclusive to endExclusive into this builder.
SingletonOrdinalsBuilder	endPositionEntry()	Ends the current multi-value entry.
long	estimatedBytes()	An estimate of the number of bytes the Block created by Block.Builder.build() will use.
Block.Builder	mvOrdering(Block.MvOrdering mvOrdering)	How are multivalued fields ordered? This defaults to Block.MvOrdering.UNORDERED but when you set it to Block.MvOrdering.DEDUPLICATED_AND_SORTED_ASCENDING some operators can optimize themselves.

Methods inherited from class java.lang.Object

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

Constructor Details

SingletonOrdinalsBuilder

public SingletonOrdinalsBuilder(BlockFactory blockFactory,
 org.apache.lucene.index.SortedDocValues docValues,
 int count,
 boolean isDense)

Method Details

appendNull

public SingletonOrdinalsBuilder appendNull()

Description copied from interface: Block.Builder

Appends a null value to the block.

Specified by:

appendNull in interface Block.Builder

Specified by:

appendNull in interface BlockLoader.Builder

appendOrd

public SingletonOrdinalsBuilder appendOrd(int ord)

Specified by:

appendOrd in interface BlockLoader.SingletonOrdinalsBuilder

appendOrds

public BlockLoader.SingletonOrdinalsBuilder appendOrds(int[] values,
 int from,
 int length,
 int minOrd,
 int maxOrd)

Specified by:

appendOrds in interface BlockLoader.SingletonOrdinalsBuilder

appendOrds

public BlockLoader.SingletonOrdinalsBuilder appendOrds(int ord,
 int length)

Specified by:

appendOrds in interface BlockLoader.SingletonOrdinalsBuilder

beginPositionEntry

public SingletonOrdinalsBuilder beginPositionEntry()

Description copied from interface: Block.Builder

Begins a multivalued entry. Calling this for the first time will put the builder into a mode that generates Blocks that return true from Block.mayHaveMultivaluedFields() which can force less optimized code paths. So don't call this unless you are sure you are emitting more than one value for this position.

Specified by:

beginPositionEntry in interface Block.Builder

Specified by:

beginPositionEntry in interface BlockLoader.Builder

endPositionEntry

public SingletonOrdinalsBuilder endPositionEntry()

Description copied from interface: Block.Builder

Ends the current multi-value entry.

Specified by:

endPositionEntry in interface Block.Builder

Specified by:

endPositionEntry in interface BlockLoader.Builder

estimatedBytes

public long estimatedBytes()

Description copied from interface: Block.Builder

An estimate of the number of bytes the Block created by Block.Builder.build() will use. This may overestimate the size but shouldn't underestimate it.

Specified by:

estimatedBytes in interface Block.Builder

build

public BytesRefBlock build()

Description copied from interface: Block.Builder

Builds the block. This method can be called multiple times.

Specified by:

build in interface Block.Builder

Specified by:

build in interface BlockLoader.Builder

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Releasable

copyFrom

public Block.Builder copyFrom(Block block,
 int beginInclusive,
 int endExclusive)

Description copied from interface: Block.Builder

Copy the values in block from beginInclusive to endExclusive into this builder.

For single position copies use the faster IntBlock.Builder.copyFrom(IntBlock, int), LongBlock.Builder.copyFrom(LongBlock, int), etc.

Specified by:

copyFrom in interface Block.Builder

mvOrdering

public Block.Builder mvOrdering(Block.MvOrdering mvOrdering)

Description copied from interface: Block.Builder

How are multivalued fields ordered? This defaults to Block.MvOrdering.UNORDERED but when you set it to Block.MvOrdering.DEDUPLICATED_AND_SORTED_ASCENDING some operators can optimize themselves. This is a promise that is never checked. If you set this to anything other than Block.MvOrdering.UNORDERED be sure the values are in that order or other operators will make mistakes. The actual ordering isn't checked at runtime.

Specified by:

mvOrdering in interface Block.Builder