Module org.apache.arrow.format

Package org.apache.arrow.flatbuf

Class Schema

java.lang.Object

com.google.flatbuffers.Table

org.apache.arrow.flatbuf.Schema

public final class Schema
extends com.google.flatbuffers.Table

---------------------------------------------------------------------- A Schema describes the columns in a row batch

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Schema.Vector

Field Summary

Fields inherited from class com.google.flatbuffers.Table

bb, bb_pos

Constructor Summary

Constructors

Constructor	Description
Schema()

Method Summary

Modifier and Type	Method	Description
Schema	__assign(int _i, ByteBuffer _bb)
void	__init(int _i, ByteBuffer _bb)
static void	addCustomMetadata(com.google.flatbuffers.FlatBufferBuilder builder, int customMetadataOffset)
static void	addEndianness(com.google.flatbuffers.FlatBufferBuilder builder, short endianness)
static void	addFeatures(com.google.flatbuffers.FlatBufferBuilder builder, int featuresOffset)
static void	addFields(com.google.flatbuffers.FlatBufferBuilder builder, int fieldsOffset)
static int	createCustomMetadataVector(com.google.flatbuffers.FlatBufferBuilder builder, int[] data)
static int	createFeaturesVector(com.google.flatbuffers.FlatBufferBuilder builder, long[] data)
static int	createFieldsVector(com.google.flatbuffers.FlatBufferBuilder builder, int[] data)
static int	createSchema(com.google.flatbuffers.FlatBufferBuilder builder, short endianness, int fieldsOffset, int customMetadataOffset, int featuresOffset)
KeyValue	customMetadata(int j)
KeyValue	customMetadata(KeyValue obj, int j)
int	customMetadataLength()
KeyValue.Vector	customMetadataVector()
KeyValue.Vector	customMetadataVector(KeyValue.Vector obj)
short	endianness()	endianness of the buffer it is Little Endian by default if endianness doesn't match the underlying system then the vectors need to be converted
static int	endSchema(com.google.flatbuffers.FlatBufferBuilder builder)
long	features(int j)	Features used in the stream/file.
ByteBuffer	featuresAsByteBuffer()
ByteBuffer	featuresInByteBuffer(ByteBuffer _bb)
int	featuresLength()
com.google.flatbuffers.LongVector	featuresVector()
com.google.flatbuffers.LongVector	featuresVector(com.google.flatbuffers.LongVector obj)
Field	fields(int j)
Field	fields(Field obj, int j)
int	fieldsLength()
Field.Vector	fieldsVector()
Field.Vector	fieldsVector(Field.Vector obj)
static void	finishSchemaBuffer(com.google.flatbuffers.FlatBufferBuilder builder, int offset)
static void	finishSizePrefixedSchemaBuffer(com.google.flatbuffers.FlatBufferBuilder builder, int offset)
static Schema	getRootAsSchema(ByteBuffer _bb)
static Schema	getRootAsSchema(ByteBuffer _bb, Schema obj)
static void	startCustomMetadataVector(com.google.flatbuffers.FlatBufferBuilder builder, int numElems)
static void	startFeaturesVector(com.google.flatbuffers.FlatBufferBuilder builder, int numElems)
static void	startFieldsVector(com.google.flatbuffers.FlatBufferBuilder builder, int numElems)
static void	startSchema(com.google.flatbuffers.FlatBufferBuilder builder)
static void	ValidateVersion()

Methods inherited from class com.google.flatbuffers.Table

__has_identifier, __indirect, __indirect, __offset, __offset, __reset, __reset, __string, __string, __union, __union, __vector, __vector_as_bytebuffer, __vector_in_bytebuffer, __vector_len, compareStrings, compareStrings, getByteBuffer, keysCompare, sortTables

Methods inherited from class java.lang.Object

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

Constructor Details

Schema

public Schema()

Method Details

ValidateVersion

public static void ValidateVersion()

getRootAsSchema

public static Schema getRootAsSchema(ByteBuffer _bb)

getRootAsSchema

public static Schema getRootAsSchema(ByteBuffer _bb,
 Schema obj)

__init

public void __init(int _i,
 ByteBuffer _bb)

__assign

public Schema __assign(int _i,
 ByteBuffer _bb)

endianness

public short endianness()

endianness of the buffer it is Little Endian by default if endianness doesn't match the underlying system then the vectors need to be converted

fields

public Field fields(int j)

fields

public Field fields(Field obj,
 int j)

fieldsLength

public int fieldsLength()

fieldsVector

public Field.Vector fieldsVector()

fieldsVector

public Field.Vector fieldsVector(Field.Vector obj)

customMetadata

public KeyValue customMetadata(int j)

customMetadata

public KeyValue customMetadata(KeyValue obj,
 int j)

customMetadataLength

public int customMetadataLength()

customMetadataVector

public KeyValue.Vector customMetadataVector()

customMetadataVector

public KeyValue.Vector customMetadataVector(KeyValue.Vector obj)

features

public long features(int j)

Features used in the stream/file.

featuresLength

public int featuresLength()

featuresVector

public com.google.flatbuffers.LongVector featuresVector()

featuresVector

public com.google.flatbuffers.LongVector featuresVector(com.google.flatbuffers.LongVector obj)

featuresAsByteBuffer

public ByteBuffer featuresAsByteBuffer()

featuresInByteBuffer

public ByteBuffer featuresInByteBuffer(ByteBuffer _bb)

createSchema

public static int createSchema(com.google.flatbuffers.FlatBufferBuilder builder,
 short endianness,
 int fieldsOffset,
 int customMetadataOffset,
 int featuresOffset)

startSchema

public static void startSchema(com.google.flatbuffers.FlatBufferBuilder builder)

addEndianness

public static void addEndianness(com.google.flatbuffers.FlatBufferBuilder builder,
 short endianness)

addFields

public static void addFields(com.google.flatbuffers.FlatBufferBuilder builder,
 int fieldsOffset)

createFieldsVector

public static int createFieldsVector(com.google.flatbuffers.FlatBufferBuilder builder,
 int[] data)

startFieldsVector

public static void startFieldsVector(com.google.flatbuffers.FlatBufferBuilder builder,
 int numElems)

addCustomMetadata

public static void addCustomMetadata(com.google.flatbuffers.FlatBufferBuilder builder,
 int customMetadataOffset)

createCustomMetadataVector

public static int createCustomMetadataVector(com.google.flatbuffers.FlatBufferBuilder builder,
 int[] data)

startCustomMetadataVector

public static void startCustomMetadataVector(com.google.flatbuffers.FlatBufferBuilder builder,
 int numElems)

addFeatures

public static void addFeatures(com.google.flatbuffers.FlatBufferBuilder builder,
 int featuresOffset)

createFeaturesVector

public static int createFeaturesVector(com.google.flatbuffers.FlatBufferBuilder builder,
 long[] data)

startFeaturesVector

public static void startFeaturesVector(com.google.flatbuffers.FlatBufferBuilder builder,
 int numElems)

endSchema

public static int endSchema(com.google.flatbuffers.FlatBufferBuilder builder)

finishSchemaBuffer

public static void finishSchemaBuffer(com.google.flatbuffers.FlatBufferBuilder builder,
 int offset)

finishSizePrefixedSchemaBuffer

public static void finishSizePrefixedSchemaBuffer(com.google.flatbuffers.FlatBufferBuilder builder,
 int offset)