org.bytedeco.arrow

Class BooleanBuilder

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.ArrayBuilder

org.bytedeco.arrow.BooleanBuilder

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow")
 @NoOffset
 @Properties(inherit=arrow.class)
public class BooleanBuilder
extends ArrayBuilder

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
BooleanBuilder()
BooleanBuilder(DataType type)
BooleanBuilder(DataType type, MemoryPool pool)
BooleanBuilder(long size) Native array allocator.
BooleanBuilder(MemoryPool pool)
BooleanBuilder(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Status	Append(boolean val) Scalar append
Status	Append(byte val)
Status	AppendEmptyValue() \brief Append a non-null value to builder The appended value is an implementation detail, but the corresponding memory slot is guaranteed to be initialized.
Status	AppendEmptyValues(long length) \brief Append a number of non-null values to builder The appended values are an implementation detail, but the corresponding memory slot is guaranteed to be initialized.
Status	AppendNull() \brief Append a null value to builder
Status	AppendNulls(long length) Write nulls as uint8_t* (0 value indicates null) into pre-allocated memory
Status	AppendValues(BoolVector values) \brief Append a sequence of elements in one shot
Status	AppendValues(BoolVector values, BoolVector is_valid) \brief Append a sequence of elements in one shot
Status	AppendValues(byte[] values)
Status	AppendValues(byte[] values, BoolVector is_valid)
Status	AppendValues(byte[] values, long length)
Status	AppendValues(byte[] values, long length, BoolVector is_valid)
Status	AppendValues(byte[] values, long length, byte[] valid_bytes)
Status	AppendValues(ByteBuffer values)
Status	AppendValues(ByteBuffer values, BoolVector is_valid)
Status	AppendValues(ByteBuffer values, long length)
Status	AppendValues(ByteBuffer values, long length, BoolVector is_valid)
Status	AppendValues(ByteBuffer values, long length, ByteBuffer valid_bytes)
Status	AppendValues(BytePointer values) \brief Append a sequence of elements in one shot
Status	AppendValues(BytePointer values, BoolVector is_valid) \brief Append a sequence of elements in one shot
Status	AppendValues(BytePointer values, long length)
Status	AppendValues(BytePointer values, long length, BoolVector is_valid) \brief Append a sequence of elements in one shot
Status	AppendValues(BytePointer values, long length, BytePointer valid_bytes) \brief Append a sequence of elements in one shot
Status	AppendValues(long length, boolean value) \brief Append a sequence of elements in one shot, with a specified nullmap
Status	Finish(BooleanArray out) \endcond
Status	FinishInternal(ArrayData out) \brief Return result of builder as an internal generic ArrayData object.
BooleanBuilder	getPointer(long i)
BooleanBuilder	position(long position)
void	Reset() Reset the builder.
Status	Resize(long _capacity) \brief Ensure that enough memory has been allocated to fit the indicated number of total elements in the builder, including any that have already been appended.
DataType	type() \brief Return the type of the built Array
void	UnsafeAppend(boolean val) Scalar append, without checking for capacity
void	UnsafeAppend(byte val)
void	UnsafeAppendNull()

Methods inherited from class org.bytedeco.arrow.ArrayBuilder

_capacity, Advance, child_builder, child, Finish, Finish, length, null_count, num_children, Reserve

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

BooleanBuilder

public BooleanBuilder(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

BooleanBuilder

public BooleanBuilder(long size)

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

BooleanBuilder

public BooleanBuilder(MemoryPool pool)

BooleanBuilder

public BooleanBuilder()

BooleanBuilder

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

BooleanBuilder

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

Method Detail

position

public BooleanBuilder position(long position)

Overrides:

position in class Pointer

getPointer

public BooleanBuilder getPointer(long i)

Overrides:

getPointer in class Pointer

AppendNulls

@ByVal
public Status AppendNulls(@Cast(value="int64_t")
                                  long length)

Write nulls as uint8_t* (0 value indicates null) into pre-allocated memory

Overrides:

AppendNulls in class ArrayBuilder

AppendNull

@ByVal
public Status AppendNull()

Description copied from class: ArrayBuilder

\brief Append a null value to builder

Overrides:

AppendNull in class ArrayBuilder

AppendEmptyValue

@ByVal
public Status AppendEmptyValue()

Description copied from class: ArrayBuilder

\brief Append a non-null value to builder The appended value is an implementation detail, but the corresponding memory slot is guaranteed to be initialized. This method is useful when appending a null value to a parent nested type.

Overrides:

AppendEmptyValue in class ArrayBuilder

AppendEmptyValues

@ByVal
public Status AppendEmptyValues(@Cast(value="int64_t")
                                        long length)

Description copied from class: ArrayBuilder

\brief Append a number of non-null values to builder The appended values are an implementation detail, but the corresponding memory slot is guaranteed to be initialized. This method is useful when appending null values to a parent nested type.

Overrides:

AppendEmptyValues in class ArrayBuilder

Append

@ByVal
public Status Append(@Cast(value="const bool")
                             boolean val)

Scalar append

Append

@ByVal
public Status Append(@Cast(value="const uint8_t")
                             byte val)

UnsafeAppend

public void UnsafeAppend(@Cast(value="const bool")
                         boolean val)

Scalar append, without checking for capacity

UnsafeAppendNull

public void UnsafeAppendNull()

UnsafeAppend

public void UnsafeAppend(@Cast(value="const uint8_t")
                         byte val)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const uint8_t*")
                                   BytePointer values,
                                   @Cast(value="int64_t")
                                   long length,
                                   @Cast(value="const uint8_t*")
                                   BytePointer valid_bytes)

\brief Append a sequence of elements in one shot

Parameters:

values - [in] a contiguous array of bytes (non-zero is 1)

length - [in] the number of values to append

valid_bytes - [in] an optional sequence of bytes where non-zero indicates a valid (non-null) value

Returns:

Status

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const uint8_t*")
                                   BytePointer values,
                                   @Cast(value="int64_t")
                                   long length)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const uint8_t*")
                                   ByteBuffer values,
                                   @Cast(value="int64_t")
                                   long length,
                                   @Cast(value="const uint8_t*")
                                   ByteBuffer valid_bytes)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const uint8_t*")
                                   ByteBuffer values,
                                   @Cast(value="int64_t")
                                   long length)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const uint8_t*")
                                   byte[] values,
                                   @Cast(value="int64_t")
                                   long length,
                                   @Cast(value="const uint8_t*")
                                   byte[] valid_bytes)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const uint8_t*")
                                   byte[] values,
                                   @Cast(value="int64_t")
                                   long length)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const uint8_t*")
                                   BytePointer values,
                                   @Cast(value="int64_t")
                                   long length,
                                   @Const @ByRef
                                   BoolVector is_valid)

\brief Append a sequence of elements in one shot

Parameters:

values - [in] a contiguous C array of values

length - [in] the number of values to append

is_valid - [in] an std::vector indicating valid (1) or null (0). Equal in length to values

Returns:

Status

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const uint8_t*")
                                   ByteBuffer values,
                                   @Cast(value="int64_t")
                                   long length,
                                   @Const @ByRef
                                   BoolVector is_valid)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const uint8_t*")
                                   byte[] values,
                                   @Cast(value="int64_t")
                                   long length,
                                   @Const @ByRef
                                   BoolVector is_valid)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="uint8_t*") @StdVector
                                   BytePointer values,
                                   @Const @ByRef
                                   BoolVector is_valid)

\brief Append a sequence of elements in one shot

Parameters:

values - [in] a std::vector of bytes

is_valid - [in] an std::vector indicating valid (1) or null (0). Equal in length to values

Returns:

Status

AppendValues

@ByVal
public Status AppendValues(@Cast(value="uint8_t*") @StdVector
                                   ByteBuffer values,
                                   @Const @ByRef
                                   BoolVector is_valid)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="uint8_t*") @StdVector
                                   byte[] values,
                                   @Const @ByRef
                                   BoolVector is_valid)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="uint8_t*") @StdVector
                                   BytePointer values)

\brief Append a sequence of elements in one shot

Parameters:

values - [in] a std::vector of bytes

Returns:

Status

AppendValues

@ByVal
public Status AppendValues(@Cast(value="uint8_t*") @StdVector
                                   ByteBuffer values)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="uint8_t*") @StdVector
                                   byte[] values)

AppendValues

@ByVal
public Status AppendValues(@Const @ByRef
                                   BoolVector values,
                                   @Const @ByRef
                                   BoolVector is_valid)

\brief Append a sequence of elements in one shot

Parameters:

values - [in] an std::vector indicating true (1) or false

is_valid - [in] an std::vector indicating valid (1) or null (0). Equal in length to values

Returns:

Status

AppendValues

@ByVal
public Status AppendValues(@Const @ByRef
                                   BoolVector values)

\brief Append a sequence of elements in one shot

Parameters:

values - [in] an std::vector indicating true (1) or false

Returns:

Status

AppendValues

@ByVal
public Status AppendValues(@Cast(value="int64_t")
                                   long length,
                                   @Cast(value="bool")
                                   boolean value)

\brief Append a sequence of elements in one shot, with a specified nullmap

Parameters:

values_begin - [in] InputIterator to the beginning of the values

values_end - [in] InputIterator pointing to the end of the values

valid_begin - [in] InputIterator with elements indication valid(1) or null(0) values

Returns:

Status

FinishInternal

@ByVal
public Status FinishInternal(@SharedPtr
                                     ArrayData out)

Description copied from class: ArrayBuilder

\brief Return result of builder as an internal generic ArrayData object. Resets builder except for dictionary builder

Overrides:

FinishInternal in class ArrayBuilder

Parameters:

out - [out] the finalized ArrayData object

Returns:

Status

Finish

@ByVal
public Status Finish(@SharedPtr
                             BooleanArray out)

\endcond

Reset

public void Reset()

Description copied from class: ArrayBuilder

Reset the builder.

Overrides:

Reset in class ArrayBuilder

Resize

@ByVal
public Status Resize(@Cast(value="int64_t")
                             long _capacity)

Description copied from class: ArrayBuilder

\brief Ensure that enough memory has been allocated to fit the indicated number of total elements in the builder, including any that have already been appended. Does not account for reallocations that may be due to variable size data, like binary values. To make space for incremental appends, use Reserve instead.

Overrides:

Resize in class ArrayBuilder

Returns:

Status

type

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

Description copied from class: ArrayBuilder

\brief Return the type of the built Array

Overrides:

type in class ArrayBuilder