org.bytedeco.arrow

Class SchemaBuilder

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.SchemaBuilder

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow")
 @NoOffset
 @Properties(inherit=arrow.class)
public class SchemaBuilder
extends Pointer

\brief Convenience class to incrementally construct/merge schemas. This class amortizes the cost of validating field name conflicts by maintaining the mapping. The caller also controls the conflict resolution scheme.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SchemaBuilder.ConflictPolicy

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
SchemaBuilder()
SchemaBuilder(FieldVector fields)
SchemaBuilder(FieldVector fields, int conflict_policy, Field.MergeOptions field_merge_options)
SchemaBuilder(FieldVector fields, SchemaBuilder.ConflictPolicy conflict_policy, Field.MergeOptions field_merge_options) \brief Construct a SchemaBuilder from a list of fields field_merge_options is only effective when conflict_policy == CONFLICT_MERGE.
SchemaBuilder(int conflict_policy, Field.MergeOptions field_merge_options)
SchemaBuilder(long size) Native array allocator.
SchemaBuilder(Pointer p) Pointer cast constructor.
SchemaBuilder(Schema schema)
SchemaBuilder(SchemaBuilder.ConflictPolicy conflict_policy, Field.MergeOptions field_merge_options) \brief Construct an empty SchemaBuilder field_merge_options is only effective when conflict_policy == CONFLICT_MERGE.
SchemaBuilder(Schema schema, int conflict_policy, Field.MergeOptions field_merge_options)
SchemaBuilder(Schema schema, SchemaBuilder.ConflictPolicy conflict_policy, Field.MergeOptions field_merge_options) \brief Construct a SchemaBuilder from a schema, preserving the metadata field_merge_options is only effective when conflict_policy == CONFLICT_MERGE.

Method Summary

Modifier and Type	Method and Description
Status	AddField(Field field) \brief Add a field to the constructed schema.
Status	AddFields(FieldVector fields) \brief Add multiple fields to the constructed schema.
Status	AddMetadata(KeyValueMetadata metadata)
Status	AddSchema(Schema schema) \brief Add fields of a Schema to the constructed Schema.
Status	AddSchemas(SchemaVector schemas) \brief Add fields of multiple Schemas to the constructed Schema.
static Status	AreCompatible(SchemaVector schemas)
static Status	AreCompatible(SchemaVector schemas, int policy)
static Status	AreCompatible(SchemaVector schemas, SchemaBuilder.ConflictPolicy policy) \brief Indicate if schemas are compatible to merge according to policy.
SchemaResult	Finish() \brief Return the constructed Schema.
SchemaBuilder	getPointer(long i)
static SchemaResult	Merge(SchemaVector schemas)
static SchemaResult	Merge(SchemaVector schemas, int policy)
static SchemaResult	Merge(SchemaVector schemas, SchemaBuilder.ConflictPolicy policy) \brief Merge schemas in a unified schema according to policy.
SchemaBuilder.ConflictPolicy	policy() \brief Return the conflict resolution method.
SchemaBuilder	position(long position)
void	Reset() \brief Reset internal state with an empty schema (and metadata).
void	SetPolicy(int resolution)
void	SetPolicy(SchemaBuilder.ConflictPolicy resolution) \brief Set the conflict resolution method.

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, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, offsetof, parseBytes, physicalBytes, 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

SchemaBuilder

public SchemaBuilder(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

SchemaBuilder

public SchemaBuilder(long size)

Native array allocator. Access with Pointer.position(long).

SchemaBuilder

public SchemaBuilder(SchemaBuilder.ConflictPolicy conflict_policy,
                     @ByVal(nullValue="arrow::Field::MergeOptions::Defaults()")
                     Field.MergeOptions field_merge_options)

\brief Construct an empty SchemaBuilder field_merge_options is only effective when conflict_policy == CONFLICT_MERGE.

SchemaBuilder

public SchemaBuilder()

SchemaBuilder

public SchemaBuilder(@Cast(value="arrow::SchemaBuilder::ConflictPolicy")
                     int conflict_policy,
                     @ByVal(nullValue="arrow::Field::MergeOptions::Defaults()")
                     Field.MergeOptions field_merge_options)

SchemaBuilder

public SchemaBuilder(@ByVal
                     FieldVector fields,
                     SchemaBuilder.ConflictPolicy conflict_policy,
                     @ByVal(nullValue="arrow::Field::MergeOptions::Defaults()")
                     Field.MergeOptions field_merge_options)

\brief Construct a SchemaBuilder from a list of fields field_merge_options is only effective when conflict_policy == CONFLICT_MERGE.

SchemaBuilder

public SchemaBuilder(@ByVal
                     FieldVector fields)

SchemaBuilder

public SchemaBuilder(@ByVal
                     FieldVector fields,
                     @Cast(value="arrow::SchemaBuilder::ConflictPolicy")
                     int conflict_policy,
                     @ByVal(nullValue="arrow::Field::MergeOptions::Defaults()")
                     Field.MergeOptions field_merge_options)

SchemaBuilder

public SchemaBuilder(@Const @SharedPtr @ByRef
                     Schema schema,
                     SchemaBuilder.ConflictPolicy conflict_policy,
                     @ByVal(nullValue="arrow::Field::MergeOptions::Defaults()")
                     Field.MergeOptions field_merge_options)

\brief Construct a SchemaBuilder from a schema, preserving the metadata field_merge_options is only effective when conflict_policy == CONFLICT_MERGE.

SchemaBuilder

public SchemaBuilder(@Const @SharedPtr @ByRef
                     Schema schema)

SchemaBuilder

public SchemaBuilder(@Const @SharedPtr @ByRef
                     Schema schema,
                     @Cast(value="arrow::SchemaBuilder::ConflictPolicy")
                     int conflict_policy,
                     @ByVal(nullValue="arrow::Field::MergeOptions::Defaults()")
                     Field.MergeOptions field_merge_options)

Method Detail

position

public SchemaBuilder position(long position)

Overrides:

position in class Pointer

getPointer

public SchemaBuilder getPointer(long i)

Overrides:

getPointer in class Pointer

policy

public SchemaBuilder.ConflictPolicy policy()

\brief Return the conflict resolution method.

SetPolicy

public void SetPolicy(SchemaBuilder.ConflictPolicy resolution)

\brief Set the conflict resolution method.

SetPolicy

public void SetPolicy(@Cast(value="arrow::SchemaBuilder::ConflictPolicy")
                      int resolution)

AddField

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

\brief Add a field to the constructed schema.

Parameters:

field - [in] to add to the constructed Schema.

Returns:

A failure if encountered.

AddFields

@ByVal
public Status AddFields(@Const @ByRef
                                FieldVector fields)

\brief Add multiple fields to the constructed schema.

Parameters:

fields - [in] to add to the constructed Schema.

Returns:

The first failure encountered, if any.

AddSchema

@ByVal
public Status AddSchema(@Const @SharedPtr @ByRef
                                Schema schema)

\brief Add fields of a Schema to the constructed Schema.

Parameters:

schema - [in] to take fields to add to the constructed Schema.

Returns:

The first failure encountered, if any.

AddSchemas

@ByVal
public Status AddSchemas(@Const @ByRef
                                 SchemaVector schemas)

\brief Add fields of multiple Schemas to the constructed Schema.

Parameters:

schemas - [in] to take fields to add to the constructed Schema.

Returns:

The first failure encountered, if any.

AddMetadata

@ByVal
public Status AddMetadata(@Const @ByRef
                                  KeyValueMetadata metadata)

Finish

@ByVal
public SchemaResult Finish()

\brief Return the constructed Schema. The builder internal state is not affected by invoking this method, i.e. a single builder can yield multiple incrementally constructed schemas.

Returns:

the constructed schema.

Merge

@ByVal
public static SchemaResult Merge(@Const @ByRef
                                         SchemaVector schemas,
                                         SchemaBuilder.ConflictPolicy policy)

\brief Merge schemas in a unified schema according to policy.

Merge

@ByVal
public static SchemaResult Merge(@Const @ByRef
                                         SchemaVector schemas)

Merge

@ByVal
public static SchemaResult Merge(@Const @ByRef
                                         SchemaVector schemas,
                                         @Cast(value="arrow::SchemaBuilder::ConflictPolicy")
                                         int policy)

AreCompatible

@ByVal
public static Status AreCompatible(@Const @ByRef
                                           SchemaVector schemas,
                                           SchemaBuilder.ConflictPolicy policy)

\brief Indicate if schemas are compatible to merge according to policy.

AreCompatible

@ByVal
public static Status AreCompatible(@Const @ByRef
                                           SchemaVector schemas)

AreCompatible

@ByVal
public static Status AreCompatible(@Const @ByRef
                                           SchemaVector schemas,
                                           @Cast(value="arrow::SchemaBuilder::ConflictPolicy")
                                           int policy)

Reset

public void Reset()

\brief Reset internal state with an empty schema (and metadata).