org.bytedeco.arrow

Class Field

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.Fingerprintable

org.bytedeco.arrow.Field

All Implemented Interfaces:

AutoCloseable

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

\brief The combination of a field name and data type, with optional metadata Fields are used to describe the individual constituents of a nested DataType or a Schema. A field's metadata is represented by a KeyValueMetadata instance, which holds arbitrary key-value pairs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Field.MergeOptions \brief Options that control the behavior of MergeWith.

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
Field(BytePointer name, DataType type)
Field(BytePointer name, DataType type, boolean nullable, KeyValueMetadata metadata)
Field(Pointer p) Pointer cast constructor.
Field(String name, DataType type)
Field(String name, DataType type, boolean nullable, KeyValueMetadata metadata)

Method Summary

Modifier and Type	Method and Description
Field	Copy()
boolean	Equals(Field other)
boolean	Equals(Field other, boolean check_metadata) \brief Indicate if fields are equals.
FieldVector	Flatten()
boolean	HasMetadata() \brief Return whether the field has non-empty metadata
boolean	IsCompatibleWith(Field other) \brief Indicate if fields are compatibles.
FieldResult	MergeWith(Field other)
FieldResult	MergeWith(Field other, Field.MergeOptions options) \brief Merge the current field with a field of the same name.
KeyValueMetadata	metadata() \brief Return the field's attached metadata
String	name() \brief Return the field name
boolean	nullable() \brief Return whether the field is nullable
Field	RemoveMetadata() \brief Return a copy of this field without any metadata attached to it
String	ToString()
String	ToString(boolean show_metadata) \brief Return a string representation ot the field
DataType	type() \brief Return the field data type
Field	WithMergedMetadata(KeyValueMetadata metadata) \brief EXPERIMENTAL: Return a copy of this field with the given metadata merged with existing metadata (any colliding keys will be overridden by the passed metadata)
Field	WithMetadata(KeyValueMetadata metadata) \brief Return a copy of this field with the given metadata attached to it
Field	WithName(BytePointer name)
Field	WithName(String name) \brief Return a copy of this field with the replaced name.
Field	WithNullable(boolean nullable) \brief Return a copy of this field with the replaced nullability.
Field	WithType(DataType type) \brief Return a copy of this field with the replaced type.

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

Field

public Field(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Field

public Field(@StdString
             String name,
             @SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
             DataType type,
             @Cast(value="bool")
             boolean nullable,
             @Cast(value="const arrow::KeyValueMetadata*") @SharedPtr @ByVal(nullValue="std::shared_ptr<const arrow::KeyValueMetadata>(nullptr)")
             KeyValueMetadata metadata)

Field

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

Field

public Field(@StdString
             BytePointer name,
             @SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
             DataType type,
             @Cast(value="bool")
             boolean nullable,
             @Cast(value="const arrow::KeyValueMetadata*") @SharedPtr @ByVal(nullValue="std::shared_ptr<const arrow::KeyValueMetadata>(nullptr)")
             KeyValueMetadata metadata)

Field

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

Method Detail

metadata

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

\brief Return the field's attached metadata

HasMetadata

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

\brief Return whether the field has non-empty metadata

WithMetadata

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::Field>"})
public Field WithMetadata(@Const @Cast(value="const arrow::KeyValueMetadata*") @SharedPtr @ByRef
                                                                                          KeyValueMetadata metadata)

\brief Return a copy of this field with the given metadata attached to it

WithMergedMetadata

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::Field>"})
public Field WithMergedMetadata(@Const @Cast(value="const arrow::KeyValueMetadata*") @SharedPtr @ByRef
                                                                                                KeyValueMetadata metadata)

\brief EXPERIMENTAL: Return a copy of this field with the given metadata merged with existing metadata (any colliding keys will be overridden by the passed metadata)

RemoveMetadata

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

\brief Return a copy of this field without any metadata attached to it

WithType

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::Field>"})
public Field WithType(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                                                                                      DataType type)

\brief Return a copy of this field with the replaced type.

WithName

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

\brief Return a copy of this field with the replaced name.

WithName

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

WithNullable

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::Field>"})
public Field WithNullable(@Cast(value="bool")
                                                                                          boolean nullable)

\brief Return a copy of this field with the replaced nullability.

MergeWith

@ByVal
public FieldResult MergeWith(@Const @ByRef
                                     Field other,
                                     @ByVal(nullValue="arrow::Field::MergeOptions::Defaults()")
                                     Field.MergeOptions options)

\brief Merge the current field with a field of the same name. The two fields must be compatible, i.e: - have the same name - have the same type, or of compatible types according to options. The metadata of the current field is preserved; the metadata of the other field is discarded.

MergeWith

@ByVal
public FieldResult MergeWith(@Const @ByRef
                                     Field other)

Flatten

@ByVal
public FieldVector Flatten()

Equals

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

\brief Indicate if fields are equals.

Parameters:

other - [in] field to check equality with.

check_metadata - [in] controls if it should check for metadata equality.

Returns:

true if fields are equal, false otherwise.

Equals

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

IsCompatibleWith

@Cast(value="bool")
public boolean IsCompatibleWith(@Const @ByRef
                                                     Field other)

\brief Indicate if fields are compatibles. See the criteria of MergeWith.

Returns:

true if fields are compatible, false otherwise.

ToString

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

\brief Return a string representation ot the field

Parameters:

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

ToString

@StdString
public String ToString()

name

@StdString
public String name()

\brief Return the field name

type

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::DataType>"})
public DataType type()

\brief Return the field data type

nullable

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

\brief Return whether the field is nullable

Copy

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