Package org.apache.arrow.vector.ipc.message

Class ArrowFooter

java.lang.Object

org.apache.arrow.vector.ipc.message.ArrowFooter

All Implemented Interfaces:

FBSerializable

public class ArrowFooter
extends Object
implements FBSerializable

Footer metadata for the arrow file format.

Constructor Summary

Constructors

Constructor	Description
ArrowFooter(Footer footer)	Constructs from the corresponding Flatbuffer message.
ArrowFooter(Schema schema, List<ArrowBlock> dictionaries, List<ArrowBlock> recordBatches)
ArrowFooter(Schema schema, List<ArrowBlock> dictionaries, List<ArrowBlock> recordBatches, Map<String,String> metaData)	Constructs a new instance.
ArrowFooter(Schema schema, List<ArrowBlock> dictionaries, List<ArrowBlock> recordBatches, Map<String,String> metaData, MetadataVersion metadataVersion)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
List<ArrowBlock>	getDictionaries()
Map<String,String>	getMetaData()
MetadataVersion	getMetadataVersion()
List<ArrowBlock>	getRecordBatches()
Schema	getSchema()
int	hashCode()
int	writeTo(com.google.flatbuffers.FlatBufferBuilder builder)	Returns the number of bytes taken to serialize the data in builder after writing to it.

Methods inherited from class java.lang.Object

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

Constructor Details

ArrowFooter

public ArrowFooter(Schema schema,
 List<ArrowBlock> dictionaries,
 List<ArrowBlock> recordBatches)

ArrowFooter

public ArrowFooter(Schema schema,
 List<ArrowBlock> dictionaries,
 List<ArrowBlock> recordBatches,
 Map<String,String> metaData)

Constructs a new instance.

Parameters:

schema - The schema for record batches in the file.

dictionaries - The dictionaries relevant to the file.

recordBatches - The recordBatches written to the file.

metaData - user-defined k-v meta data.

ArrowFooter

public ArrowFooter(Schema schema,
 List<ArrowBlock> dictionaries,
 List<ArrowBlock> recordBatches,
 Map<String,String> metaData,
 MetadataVersion metadataVersion)

Constructs a new instance.

Parameters:

schema - The schema for record batches in the file.

dictionaries - The dictionaries relevant to the file.

recordBatches - The recordBatches written to the file.

metaData - user-defined k-v meta data.

metadataVersion - The Arrow metadata version.

ArrowFooter

public ArrowFooter(Footer footer)

Constructs from the corresponding Flatbuffer message.

Method Details

getSchema

public Schema getSchema()

getDictionaries

public List<ArrowBlock> getDictionaries()

getRecordBatches

public List<ArrowBlock> getRecordBatches()

getMetaData

public Map<String,String> getMetaData()

getMetadataVersion

public MetadataVersion getMetadataVersion()

writeTo

public int writeTo(com.google.flatbuffers.FlatBufferBuilder builder)

Description copied from interface: FBSerializable

Returns the number of bytes taken to serialize the data in builder after writing to it.

Specified by:

writeTo in interface FBSerializable

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object