org.bytedeco.arrow

Class ExtensionType

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.Fingerprintable

org.bytedeco.arrow.DataType

org.bytedeco.arrow.ExtensionType

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow")
 @NoOffset
 @Properties(inherit=arrow.class)
public class ExtensionType
extends DataType

\brief The base class for custom / user-defined types.

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	type_id

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
ExtensionType(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
DataTypeResult	Deserialize(DataType storage_type, BytePointer serialized_data)
DataTypeResult	Deserialize(DataType storage_type, String serialized_data) \brief Create an instance of the ExtensionType given the actual storage type and the serialized representation
String	extension_name() \brief Unique name of extension type used to identify type for serialization
boolean	ExtensionEquals(ExtensionType other) \brief Determine if two instances of the same extension types are equal.
DataTypeLayout	layout() \brief Return the data type layout.
Array	MakeArray(ArrayData data) \brief Wrap built-in Array type in a user-defined ExtensionArray instance
String	name() \brief A string name of the type, omitting any child fields
String	Serialize() \brief Create a serialized representation of the extension type's metadata.
DataType	storage_type() \brief The type of array used to represent this extension type's data
String	ToString() \brief A string representation of the type, including any children
static int	type_id()
static String	type_name()
static Array	WrapArray(DataType ext_type, Array storage) \brief Wrap the given storage array as an extension array
static ChunkedArray	WrapArray(DataType ext_type, ChunkedArray storage) \brief Wrap the given chunked storage array as a chunked extension array

Methods inherited from class org.bytedeco.arrow.DataType

Accept, Equals, Equals, field, fields, Hash, id, num_fields

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

Field Detail

type_id

public static final int type_id

Constructor Detail

ExtensionType

public ExtensionType(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

type_id

@MemberGetter
 @Cast(value="const arrow::Type::type")
public static int type_id()

type_name

public static String type_name()

storage_type

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

\brief The type of array used to represent this extension type's data

layout

@ByVal
public DataTypeLayout layout()

Description copied from class: DataType

\brief Return the data type layout. Children are not included. \note Experimental API

Overrides:

layout in class DataType

ToString

@StdString
public String ToString()

Description copied from class: DataType

\brief A string representation of the type, including any children

Overrides:

ToString in class DataType

name

@StdString
public String name()

Description copied from class: DataType

\brief A string name of the type, omitting any child fields

Overrides:

name in class DataType

extension_name

@StdString
public String extension_name()

\brief Unique name of extension type used to identify type for serialization

Returns:

the string name of the extension

ExtensionEquals

@Cast(value="bool")
public boolean ExtensionEquals(@Const @ByRef
                                                    ExtensionType other)

\brief Determine if two instances of the same extension types are equal. Invoked from ExtensionType::Equals

Parameters:

other - [in] the type to compare this type with

Returns:

bool true if type instances are equal

MakeArray

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::Array>"})
public Array MakeArray(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::ArrayData>"})
                                                                                       ArrayData data)

\brief Wrap built-in Array type in a user-defined ExtensionArray instance

Parameters:

data - [in] the physical storage for the extension type

Deserialize

@ByVal
public DataTypeResult Deserialize(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                                          DataType storage_type,
                                          @StdString
                                          String serialized_data)

\brief Create an instance of the ExtensionType given the actual storage type and the serialized representation

Parameters:

storage_type - [in] the physical storage type of the extension

serialized_data - [in] the serialized representation produced by Serialize

Deserialize

@ByVal
public DataTypeResult Deserialize(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                                          DataType storage_type,
                                          @StdString
                                          BytePointer serialized_data)

Serialize

@StdString
public String Serialize()

\brief Create a serialized representation of the extension type's metadata. The storage type will be handled automatically in IPC code paths

Returns:

the serialized representation

WrapArray

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::Array>"})
public static Array WrapArray(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                                                                                              DataType ext_type,
                                                                                              @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                                                                                              Array storage)

\brief Wrap the given storage array as an extension array

WrapArray

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::ChunkedArray>"})
public static ChunkedArray WrapArray(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                                                                                                            DataType ext_type,
                                                                                                            @SharedPtr @Cast(value={"","std::shared_ptr<arrow::ChunkedArray>"})
                                                                                                            ChunkedArray storage)

\brief Wrap the given chunked storage array as a chunked extension array