Package org.elasticsearch.xpack.esql.datasources.spi

Record Class FrameIndex

java.lang.Object

java.lang.Record

org.elasticsearch.xpack.esql.datasources.spi.FrameIndex

public record FrameIndex(List<FrameIndex.FrameEntry> frames)
extends Record

Index of independently decompressible frames within a compressed file. Used by IndexedDecompressionCodec to enable random access to compressed data without scanning the entire file.

Each frame entry describes a contiguous region of compressed data that can be decompressed independently. The decompressed sizes enable the split provider to create splits targeting a specific decompressed data volume.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	FrameIndex.FrameEntry

Constructor Summary

Constructors

Constructor	Description
FrameIndex(List<FrameIndex.FrameEntry> frames)	Creates an instance of a FrameIndex record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<FrameIndex.FrameEntry>	frames()	Returns the value of the frames record component.
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

FrameIndex

public FrameIndex(List<FrameIndex.FrameEntry> frames)

Creates an instance of a FrameIndex record class.

Parameters:

frames - the value for the frames record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

frames

public List<FrameIndex.FrameEntry> frames()

Returns the value of the frames record component.

Returns:

the value of the frames record component