org.bytedeco.arrow

Class DataType

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.Fingerprintable

org.bytedeco.arrow.DataType

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

BaseBinaryType, ExtensionType, FixedWidthType, NestedType, NullType

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

\brief Base class for all data types Data types in this library are all *logical*. They can be expressed as either a primitive physical type (bytes or bits of some fixed size), a nested type consisting of other data types, or another data type (e.g. a timestamp encoded as an int64). Simple datatypes may be entirely described by their Type::type id, but complex datatypes are usually parametric.

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
DataType(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Status	Accept(TypeVisitor visitor)
Field	child(int i) Deprecated.
FieldVector	children() Deprecated.
boolean	Equals(DataType other)
boolean	Equals(DataType other, boolean check_metadata) \brief Return whether the types are equal Types that are logically convertible from one to another (e.g.
Field	field(int i) Returns the child-field at index i.
FieldVector	fields() \brief Returns the children fields associated with this type.
long	Hash() \brief Return hash value (excluding metadata in child fields)
int	id() \brief Return the type category
DataTypeLayout	layout() \brief Return the data type layout.
String	name() \brief A string name of the type, omitting any child fields \note Experimental API
int	num_children() Deprecated.
int	num_fields() \brief Returns the number of children fields associated with this type.
String	ToString() \brief A string representation of the type, including any children

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, 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

Constructor Detail

DataType

public DataType(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

Equals

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

\brief Return whether the types are equal Types that are logically convertible from one to another (e.g. List and Binary) are NOT equal.

Equals

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

child

@Deprecated
 @SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::Field>"})
public Field child(int i)

Deprecated.

\brief Return whether the types are equal

field

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

Returns the child-field at index i.

children

@Const
 @Deprecated
 @ByRef
public FieldVector children()

Deprecated.

fields

@Const
 @ByRef
public FieldVector fields()

\brief Returns the children fields associated with this type.

num_children

@Deprecated
public int num_children()

Deprecated.

num_fields

public int num_fields()

\brief Returns the number of children fields associated with this type.

Accept

@ByVal
public Status Accept(TypeVisitor visitor)

ToString

@StdString
public String ToString()

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

Hash

@Cast(value="size_t")
public long Hash()

\brief Return hash value (excluding metadata in child fields)

name

@StdString
public String name()

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

Since:

0.7.0

layout

@ByVal
public DataTypeLayout layout()

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

id

@Cast(value="arrow::Type::type")
public int id()

\brief Return the type category