Module org.elasticsearch.compute

Package org.elasticsearch.compute.data

Class ConstantNullBlock.Builder

java.lang.Object

org.elasticsearch.compute.data.ConstantNullBlock.Builder

All Implemented Interfaces:

Closeable, AutoCloseable, Block.Builder, org.elasticsearch.core.Releasable, BlockLoader.Builder

Enclosing class:

ConstantNullBlock

public static class ConstantNullBlock.Builder
extends Object
implements Block.Builder

Constructor Summary

Constructors

Constructor	Description
Builder(BlockFactory blockFactory)

Method Summary

Modifier and Type	Method	Description
ConstantNullBlock.Builder	appendNull()	Appends a null value to the block.
ConstantNullBlock.Builder	beginPositionEntry()	Begins a multivalued entry.
Block	build()	Builds the block.
void	close()
ConstantNullBlock.Builder	copyFrom(Block block, int beginInclusive, int endExclusive)	Copy the values in block from beginInclusive to endExclusive into this builder.
ConstantNullBlock.Builder	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

Builder

public Builder(BlockFactory blockFactory)

Method Details

appendNull

public ConstantNullBlock.Builder 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

beginPositionEntry

public ConstantNullBlock.Builder 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 ConstantNullBlock.Builder 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

copyFrom

public ConstantNullBlock.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

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 Block 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 org.elasticsearch.core.Releasable