org.bytedeco.arrow

Class TimestampType

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.Fingerprintable

org.bytedeco.arrow.DataType

org.bytedeco.arrow.FixedWidthType

org.bytedeco.arrow.TemporalType

org.bytedeco.arrow.TimestampType

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow")
 @NoOffset
 @Properties(inherit=arrow.class)
public class TimestampType
extends TemporalType

\brief Concrete type class for datetime data (as number of seconds, milliseconds, microseconds or nanoseconds since UNIX epoch) If supplied, the timezone string should take either the form (i) "Area/Location", with values drawn from the names in the IANA Time Zone Database (such as "Europe/Zurich"); or (ii) "(+|-)HH:MM" indicating an absolute offset from GMT (such as "-08:00"). To indicate a native UTC timestamp, one of the strings "UTC", "Etc/UTC" or "+00:00" should be used. If any non-empty string is supplied as the timezone for a TimestampType, then the Arrow field containing that timestamp type (and by extension the column associated with such a field) is considered "timezone-aware". The integer arrays that comprise a timezone-aware column must contain UTC normalized datetime values, regardless of the contents of their timezone string. More precisely, (i) the producer of a timezone-aware column must populate its constituent arrays with valid UTC values (performing offset conversions from non-UTC values if necessary); and (ii) the consumer of a timezone-aware column may assume that the column's values are directly comparable (that is, with no offset adjustment required) to the values of any other timezone-aware column or to any other valid UTC datetime value (provided all values are expressed in the same units). If a TimestampType is constructed without a timezone (or, equivalently, if the timezone supplied is an empty string) then the resulting Arrow field (column) is considered "timezone-naive". The producer of a timezone-naive column may populate its constituent integer arrays with datetime values from any timezone; the consumer of a timezone-naive column should make no assumptions about the interoperability or comparability of the values of such a column with those of any other timestamp column or datetime value. If a timezone-aware field contains a recognized timezone, its values may be localized to that locale upon display; the values of timezone-naive fields must always be displayed "as is", with no localization performed on them.

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
TimestampType()
TimestampType(int unit)
TimestampType(int unit, BytePointer timezone)
TimestampType(long size) Native array allocator.
TimestampType(Pointer p) Pointer cast constructor.
TimestampType(TimeUnit.type unit)
TimestampType(TimeUnit.type unit, String timezone)

Method Summary

Modifier and Type	Method and Description
ParametricType	asParametricType()
static ParametricType	asParametricType(TimestampType pointer)
int	bit_width()
TimestampType	getPointer(long i)
String	name() \brief A string name of the type, omitting any child fields \note Experimental API
TimestampType	position(long position)
String	timezone()
String	ToString() \brief A string representation of the type, including any children
static int	type_id()
static String	type_name()
TimeUnit.type	unit()

Methods inherited from class org.bytedeco.arrow.TemporalType

layout

Methods inherited from class org.bytedeco.arrow.DataType

Accept, child, children, Equals, Equals, field, fields, Hash, id, num_children, 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, hashCode, 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

Field Detail

type_id

public static final int type_id

Constructor Detail

TimestampType

public TimestampType(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

TimestampType

public TimestampType(long size)

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

TimestampType

public TimestampType(TimeUnit.type unit)

TimestampType

public TimestampType()

TimestampType

public TimestampType(@Cast(value="arrow::TimeUnit::type")
                     int unit)

TimestampType

public TimestampType(TimeUnit.type unit,
                     @StdString
                     String timezone)

TimestampType

public TimestampType(@Cast(value="arrow::TimeUnit::type")
                     int unit,
                     @StdString
                     BytePointer timezone)

Method Detail

position

public TimestampType position(long position)

Overrides:

position in class Pointer

getPointer

public TimestampType getPointer(long i)

Overrides:

getPointer in class Pointer

asParametricType

public ParametricType asParametricType()

asParametricType

@Namespace
 @Name(value="static_cast<arrow::ParametricType*>")
public static ParametricType asParametricType(TimestampType pointer)

type_id

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

type_name

public static String type_name()

bit_width

public int bit_width()

Overrides:

bit_width in class FixedWidthType

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 \note Experimental API

Overrides:

name in class DataType

unit

public TimeUnit.type unit()

timezone

@StdString
public String timezone()