org.bytedeco.parquet

Class LogicalType

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.parquet.LogicalType

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

BSONLogicalType, DateLogicalType, DecimalLogicalType, EnumLogicalType, IntervalLogicalType, IntLogicalType, JSONLogicalType, ListLogicalType, MapLogicalType, NoLogicalType, NullLogicalType, StringLogicalType, TimeLogicalType, TimestampLogicalType, UndefinedLogicalType, UUIDLogicalType

@Namespace(value="parquet")
 @NoOffset
 @Properties(inherit=parquet.class)
public class LogicalType
extends Pointer

\brief Implementation of parquet.thrift LogicalType types.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LogicalType.TimeUnit
static class	LogicalType.Type

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

Method Summary

Modifier and Type	Method and Description
static LogicalType	BSON()
static LogicalType	Date()
static LogicalType	Decimal(int precision)
static LogicalType	Decimal(int precision, int scale)
static LogicalType	Enum()
boolean	Equals(LogicalType other) \brief Return true if the given logical type is equivalent to this logical type.
static LogicalType	FromConvertedType(ConvertedType.type converted_type)
static LogicalType	FromConvertedType(ConvertedType.type converted_type, DecimalMetadata converted_decimal_metadata) \brief If possible, return a logical type equivalent to the given legacy converted type (and decimal metadata if applicable).
static LogicalType	FromConvertedType(int converted_type)
static LogicalType	FromConvertedType(int converted_type, DecimalMetadata converted_decimal_metadata)
static LogicalType	FromThrift(LogicalType thrift_logical_type) \brief Return the logical type represented by the Thrift intermediary object.
static LogicalType	Int(int bit_width, boolean is_signed)
static LogicalType	Interval()
boolean	is_applicable(int primitive_type)
boolean	is_applicable(int primitive_type, int primitive_length)
boolean	is_applicable(Type.type primitive_type)
boolean	is_applicable(Type.type primitive_type, int primitive_length) \brief Return true if this logical type is consistent with the given underlying physical type.
boolean	is_BSON()
boolean	is_compatible(ConvertedType.type converted_type)
boolean	is_compatible(ConvertedType.type converted_type, DecimalMetadata converted_decimal_metadata) \brief Return true if this logical type is equivalent to the given legacy converted type (and decimal metadata if applicable).
boolean	is_compatible(int converted_type)
boolean	is_compatible(int converted_type, DecimalMetadata converted_decimal_metadata)
boolean	is_date()
boolean	is_decimal()
boolean	is_enum()
boolean	is_int()
boolean	is_interval()
boolean	is_invalid()
boolean	is_JSON()
boolean	is_list()
boolean	is_map()
boolean	is_nested() \brief Return true if this logical type is suitable for a schema GroupNode.
boolean	is_none()
boolean	is_nonnested()
boolean	is_null()
boolean	is_serialized() \brief Return true if this logical type is included in the Thrift output for its node.
boolean	is_string()
boolean	is_time()
boolean	is_timestamp()
boolean	is_UUID()
boolean	is_valid() \brief Return true if this logical type is of a known type.
static LogicalType	JSON()
static LogicalType	List()
static LogicalType	Map()
static LogicalType	None() \brief Create a placeholder for when no logical type is specified
static LogicalType	Null() \brief Create a logical type for data that's always null Any physical type can be annotated with this logical type.
SortOrder.type	sort_order() \brief Return the appropriate sort order for this logical type.
static LogicalType	String() \brief Return the explicitly requested logical type.
static LogicalType	Time(boolean is_adjusted_to_utc, int time_unit)
static LogicalType	Time(boolean is_adjusted_to_utc, LogicalType.TimeUnit.unit time_unit)
static LogicalType	Timestamp(boolean is_adjusted_to_utc, int time_unit)
static LogicalType	Timestamp(boolean is_adjusted_to_utc, int time_unit, boolean is_from_converted_type, boolean force_set_converted_type)
static LogicalType	Timestamp(boolean is_adjusted_to_utc, LogicalType.TimeUnit.unit time_unit)
static LogicalType	Timestamp(boolean is_adjusted_to_utc, LogicalType.TimeUnit.unit time_unit, boolean is_from_converted_type, boolean force_set_converted_type) \brief Create a Timestamp logical type
ConvertedType.type	ToConvertedType(DecimalMetadata out_decimal_metadata) \brief If possible, return the legacy converted type (and decimal metadata if applicable) equivalent to this logical type.
String	ToJSON() \brief Return a JSON representation of this logical type.
String	ToString() \brief Return a printable representation of this logical type.
LogicalType	ToThrift() \brief Return a serializable Thrift object for this logical type.
LogicalType.Type.type	type() \brief Return the enumerated type of this logical type.
static LogicalType	UUID()

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, getDirectBufferAddress, getPointer, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, 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

LogicalType

public LogicalType(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

FromConvertedType

@Cast(value="const parquet::LogicalType*")
 @SharedPtr
 @ByVal
public static LogicalType FromConvertedType(ConvertedType.type converted_type,
                                                                                                              @Const @ByVal(nullValue="parquet::schema::DecimalMetadata({false, -1,-1})")
                                                                                                              DecimalMetadata converted_decimal_metadata)

\brief If possible, return a logical type equivalent to the given legacy converted type (and decimal metadata if applicable).

FromConvertedType

@Cast(value="const parquet::LogicalType*")
 @SharedPtr
 @ByVal
public static LogicalType FromConvertedType(ConvertedType.type converted_type)

FromConvertedType

@Cast(value="const parquet::LogicalType*")
 @SharedPtr
 @ByVal
public static LogicalType FromConvertedType(@Cast(value="parquet::ConvertedType::type")
                                                                                                              int converted_type,
                                                                                                              @Const @ByVal(nullValue="parquet::schema::DecimalMetadata({false, -1,-1})")
                                                                                                              DecimalMetadata converted_decimal_metadata)

FromConvertedType

@Cast(value="const parquet::LogicalType*")
 @SharedPtr
 @ByVal
public static LogicalType FromConvertedType(@Cast(value="parquet::ConvertedType::type")
                                                                                                              int converted_type)

FromThrift

@Cast(value="const parquet::LogicalType*")
 @SharedPtr
 @ByVal
public static LogicalType FromThrift(@Const @ByRef
                                                                                                       LogicalType thrift_logical_type)

\brief Return the logical type represented by the Thrift intermediary object.

String

@Cast(value="const parquet::LogicalType*")
 @SharedPtr
 @ByVal
public static LogicalType String()

\brief Return the explicitly requested logical type.

Map

@Cast(value="const parquet::LogicalType*")
 @SharedPtr
 @ByVal
public static LogicalType Map()

List

@Cast(value="const parquet::LogicalType*")
 @SharedPtr
 @ByVal
public static LogicalType List()

Enum

@Cast(value="const parquet::LogicalType*")
 @SharedPtr
 @ByVal
public static LogicalType Enum()

Decimal

@Cast(value="const parquet::LogicalType*")
 @SharedPtr
 @ByVal
public static LogicalType Decimal(int precision,
                                                                                                    int scale)

Decimal

@Cast(value="const parquet::LogicalType*")
 @SharedPtr
 @ByVal
public static LogicalType Decimal(int precision)

Date

@Cast(value="const parquet::LogicalType*")
 @SharedPtr
 @ByVal
public static LogicalType Date()

Time

@Cast(value="const parquet::LogicalType*")
 @SharedPtr
 @ByVal
public static LogicalType Time(@Cast(value="bool")
                                                                                                 boolean is_adjusted_to_utc,
                                                                                                 LogicalType.TimeUnit.unit time_unit)

Time

@Cast(value="const parquet::LogicalType*")
 @SharedPtr
 @ByVal
public static LogicalType Time(@Cast(value="bool")
                                                                                                 boolean is_adjusted_to_utc,
                                                                                                 @Cast(value="parquet::LogicalType::TimeUnit::unit")
                                                                                                 int time_unit)

Timestamp

@Cast(value="const parquet::LogicalType*")
 @SharedPtr
 @ByVal
public static LogicalType Timestamp(@Cast(value="bool")
                                                                                                      boolean is_adjusted_to_utc,
                                                                                                      LogicalType.TimeUnit.unit time_unit,
                                                                                                      @Cast(value="bool")
                                                                                                      boolean is_from_converted_type,
                                                                                                      @Cast(value="bool")
                                                                                                      boolean force_set_converted_type)

\brief Create a Timestamp logical type

Parameters:

is_adjusted_to_utc - [in] set true if the data is UTC-normalized

time_unit - [in] the resolution of the timestamp

is_from_converted_type - [in] if true, the timestamp was generated by translating a legacy converted type of TIMESTAMP_MILLIS or TIMESTAMP_MICROS. Default is false.

force_set_converted_type - [in] if true, always set the legacy ConvertedType TIMESTAMP_MICROS and TIMESTAMP_MILLIS metadata. Default is false

Timestamp

@Cast(value="const parquet::LogicalType*")
 @SharedPtr
 @ByVal
public static LogicalType Timestamp(@Cast(value="bool")
                                                                                                      boolean is_adjusted_to_utc,
                                                                                                      LogicalType.TimeUnit.unit time_unit)

Timestamp

@Cast(value="const parquet::LogicalType*")
 @SharedPtr
 @ByVal
public static LogicalType Timestamp(@Cast(value="bool")
                                                                                                      boolean is_adjusted_to_utc,
                                                                                                      @Cast(value="parquet::LogicalType::TimeUnit::unit")
                                                                                                      int time_unit,
                                                                                                      @Cast(value="bool")
                                                                                                      boolean is_from_converted_type,
                                                                                                      @Cast(value="bool")
                                                                                                      boolean force_set_converted_type)

Timestamp

@Cast(value="const parquet::LogicalType*")
 @SharedPtr
 @ByVal
public static LogicalType Timestamp(@Cast(value="bool")
                                                                                                      boolean is_adjusted_to_utc,
                                                                                                      @Cast(value="parquet::LogicalType::TimeUnit::unit")
                                                                                                      int time_unit)

Interval

@Cast(value="const parquet::LogicalType*")
 @SharedPtr
 @ByVal
public static LogicalType Interval()

Int

@Cast(value="const parquet::LogicalType*")
 @SharedPtr
 @ByVal
public static LogicalType Int(int bit_width,
                                                                                                @Cast(value="bool")
                                                                                                boolean is_signed)

Null

@Cast(value="const parquet::LogicalType*")
 @SharedPtr
 @ByVal
public static LogicalType Null()

\brief Create a logical type for data that's always null Any physical type can be annotated with this logical type.

JSON

@Cast(value="const parquet::LogicalType*")
 @SharedPtr
 @ByVal
public static LogicalType JSON()

BSON

@Cast(value="const parquet::LogicalType*")
 @SharedPtr
 @ByVal
public static LogicalType BSON()

UUID

@Cast(value="const parquet::LogicalType*")
 @SharedPtr
 @ByVal
public static LogicalType UUID()

None

@Cast(value="const parquet::LogicalType*")
 @SharedPtr
 @ByVal
public static LogicalType None()

\brief Create a placeholder for when no logical type is specified

is_applicable

@Cast(value="bool")
public boolean is_applicable(Type.type primitive_type,
                                                  int primitive_length)

\brief Return true if this logical type is consistent with the given underlying physical type.

is_applicable

@Cast(value="bool")
public boolean is_applicable(Type.type primitive_type)

is_applicable

@Cast(value="bool")
public boolean is_applicable(@Cast(value="parquet::Type::type")
                                                  int primitive_type,
                                                  int primitive_length)

is_applicable

@Cast(value="bool")
public boolean is_applicable(@Cast(value="parquet::Type::type")
                                                  int primitive_type)

is_compatible

@Cast(value="bool")
public boolean is_compatible(ConvertedType.type converted_type,
                                                  @ByVal(nullValue="parquet::schema::DecimalMetadata({false, -1, -1})")
                                                  DecimalMetadata converted_decimal_metadata)

\brief Return true if this logical type is equivalent to the given legacy converted type (and decimal metadata if applicable).

is_compatible

@Cast(value="bool")
public boolean is_compatible(ConvertedType.type converted_type)

is_compatible

@Cast(value="bool")
public boolean is_compatible(@Cast(value="parquet::ConvertedType::type")
                                                  int converted_type,
                                                  @ByVal(nullValue="parquet::schema::DecimalMetadata({false, -1, -1})")
                                                  DecimalMetadata converted_decimal_metadata)

is_compatible

@Cast(value="bool")
public boolean is_compatible(@Cast(value="parquet::ConvertedType::type")
                                                  int converted_type)

ToConvertedType

public ConvertedType.type ToConvertedType(DecimalMetadata out_decimal_metadata)

\brief If possible, return the legacy converted type (and decimal metadata if applicable) equivalent to this logical type.

ToString

@StdString
public String ToString()

\brief Return a printable representation of this logical type.

ToJSON

@StdString
public String ToJSON()

\brief Return a JSON representation of this logical type.

ToThrift

@ByVal
public LogicalType ToThrift()

\brief Return a serializable Thrift object for this logical type.

Equals

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

\brief Return true if the given logical type is equivalent to this logical type.

type

public LogicalType.Type.type type()

\brief Return the enumerated type of this logical type.

sort_order

public SortOrder.type sort_order()

\brief Return the appropriate sort order for this logical type.

is_string

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

is_map

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

is_list

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

is_enum

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

is_decimal

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

is_date

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

is_time

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

is_timestamp

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

is_interval

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

is_int

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

is_null

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

is_JSON

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

is_BSON

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

is_UUID

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

is_none

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

is_valid

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

\brief Return true if this logical type is of a known type.

is_invalid

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

is_nested

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

\brief Return true if this logical type is suitable for a schema GroupNode.

is_nonnested

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

is_serialized

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

\brief Return true if this logical type is included in the Thrift output for its node.