org.bytedeco.arrow

Class Schema

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.Fingerprintable

org.bytedeco.arrow.Schema

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow")
 @NoOffset
 @Properties(inherit=arrow.class)
public class Schema
extends Fingerprintable

\class Schema \brief Sequence of arrow::Field objects describing the columns of a record batch or table data structure

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
Schema(FieldVector fields)
Schema(FieldVector fields, KeyValueMetadata metadata)
Schema(Pointer p) Pointer cast constructor.
Schema(Schema arg0)

Method Summary

Modifier and Type	Method and Description
SchemaResult	AddField(int i, Field field)
Status	CanReferenceFieldsByNames(StringVector names) Indicate if fields named names can be found unambiguously in the schema.
boolean	Equals(Schema other)
boolean	Equals(Schema other, boolean check_metadata) Returns true if all of the schema fields are equal
StringVector	field_names()
Field	field(int i) Return the ith schema element.
FieldVector	fields()
IntBuffer	GetAllFieldIndices(BytePointer name)
IntPointer	GetAllFieldIndices(String name) Return the indices of all fields having this name
FieldVector	GetAllFieldsByName(BytePointer name)
FieldVector	GetAllFieldsByName(String name) \brief Return the indices of all fields having this name in sorted order
Field	GetFieldByName(BytePointer name)
Field	GetFieldByName(String name) Returns null if name not found
int	GetFieldIndex(BytePointer name)
int	GetFieldIndex(String name) Returns -1 if name not found
boolean	HasDistinctFieldNames() \brief Indicate that the Schema has distinct field names.
boolean	HasMetadata() \brief Indicate that the Schema has non-empty KevValueMetadata
KeyValueMetadata	metadata() \brief The custom key-value metadata, if any
int	num_fields() \brief Return the number of fields (columns) in the schema
SchemaResult	RemoveField(int i)
Schema	RemoveMetadata() \brief Return copy of Schema without the KeyValueMetadata
SchemaResult	SetField(int i, Field field)
String	ToString()
String	ToString(boolean show_metadata) \brief Render a string representation of the schema suitable for debugging
Schema	WithMetadata(KeyValueMetadata metadata) \brief Replace key-value metadata with new metadata

Methods inherited from class org.bytedeco.arrow.Fingerprintable

fingerprint, metadata_fingerprint

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getPointer, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, offsetof, parseBytes, physicalBytes, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

Schema

public Schema(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Schema

public Schema(@ByVal
              FieldVector fields,
              @Cast(value="const arrow::KeyValueMetadata*") @SharedPtr @ByVal(nullValue="std::shared_ptr<const arrow::KeyValueMetadata>(nullptr)")
              KeyValueMetadata metadata)

Schema

public Schema(@ByVal
              FieldVector fields)

Schema

public Schema(@Const @ByRef
              Schema arg0)

Method Detail

Equals

@Cast(value="bool")
public boolean Equals(@Const @ByRef
                                           Schema other,
                                           @Cast(value="bool")
                                           boolean check_metadata)

Returns true if all of the schema fields are equal

Equals

@Cast(value="bool")
public boolean Equals(@Const @ByRef
                                           Schema other)

num_fields

public int num_fields()

\brief Return the number of fields (columns) in the schema

field

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::Field>"})
public Field field(int i)

Return the ith schema element. Does not boundscheck

fields

@Const
 @ByRef
public FieldVector fields()

field_names

@ByVal
public StringVector field_names()

GetFieldByName

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::Field>"})
public Field GetFieldByName(@StdString
                                                                                            String name)

Returns null if name not found

GetFieldByName

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::Field>"})
public Field GetFieldByName(@StdString
                                                                                            BytePointer name)

GetAllFieldsByName

@ByVal
public FieldVector GetAllFieldsByName(@StdString
                                              String name)

\brief Return the indices of all fields having this name in sorted order

GetAllFieldsByName

@ByVal
public FieldVector GetAllFieldsByName(@StdString
                                              BytePointer name)

GetFieldIndex

public int GetFieldIndex(@StdString
                         String name)

Returns -1 if name not found

GetFieldIndex

public int GetFieldIndex(@StdString
                         BytePointer name)

GetAllFieldIndices

@StdVector
public IntPointer GetAllFieldIndices(@StdString
                                                 String name)

Return the indices of all fields having this name

GetAllFieldIndices

@StdVector
public IntBuffer GetAllFieldIndices(@StdString
                                                BytePointer name)

CanReferenceFieldsByNames

@ByVal
public Status CanReferenceFieldsByNames(@Const @ByRef
                                                StringVector names)

Indicate if fields named names can be found unambiguously in the schema.

metadata

@Const
 @Cast(value="const arrow::KeyValueMetadata*")
 @SharedPtr
 @ByRef
public KeyValueMetadata metadata()

\brief The custom key-value metadata, if any

Returns:

metadata may be null

ToString

@StdString
public String ToString(@Cast(value="bool")
                                   boolean show_metadata)

\brief Render a string representation of the schema suitable for debugging

Parameters:

show_metadata - [in] when true, if KeyValueMetadata is non-empty, print keys and values in the output

ToString

@StdString
public String ToString()

AddField

@ByVal
public SchemaResult AddField(int i,
                                     @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Field>"})
                                     Field field)

RemoveField

@ByVal
public SchemaResult RemoveField(int i)

SetField

@ByVal
public SchemaResult SetField(int i,
                                     @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Field>"})
                                     Field field)

WithMetadata

@SharedPtr
 @ByVal
public Schema WithMetadata(@Const @Cast(value="const arrow::KeyValueMetadata*") @SharedPtr @ByRef
                                                KeyValueMetadata metadata)

\brief Replace key-value metadata with new metadata

Parameters:

metadata - [in] new KeyValueMetadata

Returns:

new Schema

RemoveMetadata

@SharedPtr
 @ByVal
public Schema RemoveMetadata()

\brief Return copy of Schema without the KeyValueMetadata

HasMetadata

@Cast(value="bool")
public boolean HasMetadata()

\brief Indicate that the Schema has non-empty KevValueMetadata

HasDistinctFieldNames

@Cast(value="bool")
public boolean HasDistinctFieldNames()

\brief Indicate that the Schema has distinct field names.