org.bytedeco.arrow

Class ConvertOptions

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.ConvertOptions

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow::csv")
 @Properties(inherit=arrow.class)
public class ConvertOptions
extends Pointer

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
ConvertOptions() Default native constructor.
ConvertOptions(long size) Native array allocator.
ConvertOptions(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
boolean	auto_dict_encode() Whether to try to automatically dict-encode string / binary data.
ConvertOptions	auto_dict_encode(boolean setter)
int	auto_dict_max_cardinality()
ConvertOptions	auto_dict_max_cardinality(int setter)
boolean	check_utf8() Whether to check UTF8 validity of string columns
ConvertOptions	check_utf8(boolean setter)
StringDataTypeMap	column_types() Optional per-column types (disabling type inference on those columns)
ConvertOptions	column_types(StringDataTypeMap setter)
byte	decimal_point() Decimal point character for floating-point and decimal data
ConvertOptions	decimal_point(byte setter)
static ConvertOptions	Defaults() Create conversion options with default values, including conventional values for null_values, true_values and false_values
StringVector	false_values() Recognized spellings for boolean false values
ConvertOptions	false_values(StringVector setter)
ConvertOptions	getPointer(long i)
StringVector	include_columns() If non-empty, indicates the names of columns from the CSV file that should be actually read and converted (in the vector's order).
ConvertOptions	include_columns(StringVector setter)
boolean	include_missing_columns() If false, columns in include_columns but not in the CSV file will error out.
ConvertOptions	include_missing_columns(boolean setter)
StringVector	null_values() Recognized spellings for null values
ConvertOptions	null_values(StringVector setter)
ConvertOptions	position(long position)
boolean	quoted_strings_can_be_null() Whether quoted values can be null.
ConvertOptions	quoted_strings_can_be_null(boolean setter)
boolean	strings_can_be_null() Whether string / binary columns can have null values.
ConvertOptions	strings_can_be_null(boolean setter)
StringVector	true_values() Recognized spellings for boolean true values
ConvertOptions	true_values(StringVector setter)
Status	Validate() \brief Test that all set options are valid

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, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, 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

ConvertOptions

public ConvertOptions()

Default native constructor.

ConvertOptions

public ConvertOptions(long size)

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

ConvertOptions

public ConvertOptions(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

position

public ConvertOptions position(long position)

Overrides:

position in class Pointer

getPointer

public ConvertOptions getPointer(long i)

Overrides:

getPointer in class Pointer

check_utf8

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

Whether to check UTF8 validity of string columns

check_utf8

public ConvertOptions check_utf8(boolean setter)

column_types

@ByRef
public StringDataTypeMap column_types()

Optional per-column types (disabling type inference on those columns)

column_types

public ConvertOptions column_types(StringDataTypeMap setter)

null_values

@ByRef
public StringVector null_values()

Recognized spellings for null values

null_values

public ConvertOptions null_values(StringVector setter)

true_values

@ByRef
public StringVector true_values()

Recognized spellings for boolean true values

true_values

public ConvertOptions true_values(StringVector setter)

false_values

@ByRef
public StringVector false_values()

Recognized spellings for boolean false values

false_values

public ConvertOptions false_values(StringVector setter)

strings_can_be_null

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

Whether string / binary columns can have null values. If true, then strings in "null_values" are considered null for string columns. If false, then all strings are valid string values.

strings_can_be_null

public ConvertOptions strings_can_be_null(boolean setter)

quoted_strings_can_be_null

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

Whether quoted values can be null. If true, then strings in "null_values" are also considered null when they appear quoted in the CSV file. Otherwise, quoted values are never considered null.

quoted_strings_can_be_null

public ConvertOptions quoted_strings_can_be_null(boolean setter)

auto_dict_encode

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

Whether to try to automatically dict-encode string / binary data. If true, then when type inference detects a string or binary column, it is dict-encoded up to auto_dict_max_cardinality distinct values (per chunk), after which it switches to regular encoding. This setting is ignored for non-inferred columns (those in column_types).

auto_dict_encode

public ConvertOptions auto_dict_encode(boolean setter)

auto_dict_max_cardinality

public int auto_dict_max_cardinality()

auto_dict_max_cardinality

public ConvertOptions auto_dict_max_cardinality(int setter)

decimal_point

@Cast(value="char")
public byte decimal_point()

Decimal point character for floating-point and decimal data

decimal_point

public ConvertOptions decimal_point(byte setter)

include_columns

@ByRef
public StringVector include_columns()

If non-empty, indicates the names of columns from the CSV file that should be actually read and converted (in the vector's order). Columns not in this vector will be ignored.

include_columns

public ConvertOptions include_columns(StringVector setter)

include_missing_columns

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

If false, columns in include_columns but not in the CSV file will error out. If true, columns in include_columns but not in the CSV file will produce a column of nulls (whose type is selected using column_types, or null by default) This option is ignored if include_columns is empty.

include_missing_columns

public ConvertOptions include_missing_columns(boolean setter)

Defaults

@ByVal
public static ConvertOptions Defaults()

Create conversion options with default values, including conventional values for null_values, true_values and false_values

Validate

@ByVal
public Status Validate()

\brief Test that all set options are valid