Package dev.vortex.api

Class VortexColumnStatistics

java.lang.Object

dev.vortex.api.VortexColumnStatistics

public final class VortexColumnStatistics
extends Object

Statistics and physical size of one top-level column of a Vortex file, as stored in the file footer.

Constructor Summary

Constructors

Constructor	Description
VortexColumnStatistics(int columnIndex, long compressedSize, long valueCount, long nullValueCount, long nanValueCount, Object lowerBound, Object upperBound)	Construct native column statistics.

Method Summary

Modifier and Type	Method	Description
int	columnIndex()	Zero-based position of this column in the writer's Arrow schema.
long	compressedSize()	Compressed bytes referenced by this column's physical layout.
Optional<Object>	lowerBound()	Lower bound represented using the corresponding Arrow scalar's Java type.
OptionalLong	nanValueCount()	Exact NaN count, or empty for non-floating-point columns.
OptionalLong	nullValueCount()	Exact null count, or empty when Vortex did not compute one for this data type.
Optional<Object>	upperBound()	Upper bound represented using the corresponding Arrow scalar's Java type.
long	valueCount()	Number of values in this top-level column.

Methods inherited from class java.lang.Object

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

Constructor Details

VortexColumnStatistics

public VortexColumnStatistics(int columnIndex,
 long compressedSize,
 long valueCount,
 long nullValueCount,
 long nanValueCount,
 Object lowerBound,
 Object upperBound)

Construct native column statistics.

This constructor is public so the JNI implementation can instantiate the value without reflective access. Applications should obtain instances from VortexWriteSummary.columnStatistics() or NativeFiles.readStatistics(Session, String, java.util.Map).

Method Details

columnIndex

public int columnIndex()

Zero-based position of this column in the writer's Arrow schema.

compressedSize

public long compressedSize()

Compressed bytes referenced by this column's physical layout.

valueCount

public long valueCount()

Number of values in this top-level column.

nullValueCount

public OptionalLong nullValueCount()

Exact null count, or empty when Vortex did not compute one for this data type.

nanValueCount

public OptionalLong nanValueCount()

Exact NaN count, or empty for non-floating-point columns.

lowerBound

public Optional<Object> lowerBound()

Lower bound represented using the corresponding Arrow scalar's Java type.

Integers use Integer, Long, or BigInteger; floating-point values use Float or Double; decimal values use BigDecimal; strings use String; and binary values use byte[].

upperBound

public Optional<Object> upperBound()

Upper bound represented using the corresponding Arrow scalar's Java type.