org.apache.parquet.schema

Class LogicalTypeAnnotation

java.lang.Object

org.apache.parquet.schema.LogicalTypeAnnotation

Direct Known Subclasses:

LogicalTypeAnnotation.BsonLogicalTypeAnnotation, LogicalTypeAnnotation.DateLogicalTypeAnnotation, LogicalTypeAnnotation.DecimalLogicalTypeAnnotation, LogicalTypeAnnotation.EnumLogicalTypeAnnotation, LogicalTypeAnnotation.Float16LogicalTypeAnnotation, LogicalTypeAnnotation.IntervalLogicalTypeAnnotation, LogicalTypeAnnotation.IntLogicalTypeAnnotation, LogicalTypeAnnotation.JsonLogicalTypeAnnotation, LogicalTypeAnnotation.ListLogicalTypeAnnotation, LogicalTypeAnnotation.MapKeyValueTypeAnnotation, LogicalTypeAnnotation.MapLogicalTypeAnnotation, LogicalTypeAnnotation.StringLogicalTypeAnnotation, LogicalTypeAnnotation.TimeLogicalTypeAnnotation, LogicalTypeAnnotation.TimestampLogicalTypeAnnotation, LogicalTypeAnnotation.UUIDLogicalTypeAnnotation

public abstract class LogicalTypeAnnotation
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LogicalTypeAnnotation.BsonLogicalTypeAnnotation
static class	LogicalTypeAnnotation.DateLogicalTypeAnnotation
static class	LogicalTypeAnnotation.DecimalLogicalTypeAnnotation
static class	LogicalTypeAnnotation.EnumLogicalTypeAnnotation
static class	LogicalTypeAnnotation.Float16LogicalTypeAnnotation
static class	LogicalTypeAnnotation.IntervalLogicalTypeAnnotation
static class	LogicalTypeAnnotation.IntLogicalTypeAnnotation
static class	LogicalTypeAnnotation.JsonLogicalTypeAnnotation
static class	LogicalTypeAnnotation.ListLogicalTypeAnnotation
static interface	LogicalTypeAnnotation.LogicalTypeAnnotationVisitor<T> Implement this interface to visit a logical type annotation in the schema.
static class	LogicalTypeAnnotation.MapKeyValueTypeAnnotation
static class	LogicalTypeAnnotation.MapLogicalTypeAnnotation
static class	LogicalTypeAnnotation.StringLogicalTypeAnnotation
static class	LogicalTypeAnnotation.TimeLogicalTypeAnnotation
static class	LogicalTypeAnnotation.TimestampLogicalTypeAnnotation
static class	LogicalTypeAnnotation.TimeUnit
static class	LogicalTypeAnnotation.UUIDLogicalTypeAnnotation

Constructor Summary

Constructors

Constructor and Description
LogicalTypeAnnotation()

Method Summary

Modifier and Type	Method and Description
abstract <T> Optional<T>	accept(LogicalTypeAnnotation.LogicalTypeAnnotationVisitor<T> logicalTypeAnnotationVisitor) Visits this logical type with the given visitor
static LogicalTypeAnnotation.BsonLogicalTypeAnnotation	bsonType()
static LogicalTypeAnnotation.DateLogicalTypeAnnotation	dateType()
static LogicalTypeAnnotation.DecimalLogicalTypeAnnotation	decimalType(int scale, int precision)
static LogicalTypeAnnotation.EnumLogicalTypeAnnotation	enumType()
static LogicalTypeAnnotation.Float16LogicalTypeAnnotation	float16Type()
static LogicalTypeAnnotation	fromOriginalType(OriginalType originalType, DecimalMetadata decimalMetadata) Helper method to convert the old representation of logical types (OriginalType) to new logical type.
static LogicalTypeAnnotation.IntervalLogicalTypeAnnotation	intervalType()
static LogicalTypeAnnotation.IntLogicalTypeAnnotation	intType(int bitWidth)
static LogicalTypeAnnotation.IntLogicalTypeAnnotation	intType(int bitWidth, boolean isSigned)
static LogicalTypeAnnotation.JsonLogicalTypeAnnotation	jsonType()
static LogicalTypeAnnotation.ListLogicalTypeAnnotation	listType()
static LogicalTypeAnnotation.MapLogicalTypeAnnotation	mapType()
static LogicalTypeAnnotation.StringLogicalTypeAnnotation	stringType()
static LogicalTypeAnnotation.TimestampLogicalTypeAnnotation	timestampType(boolean isAdjustedToUTC, LogicalTypeAnnotation.TimeUnit unit)
static LogicalTypeAnnotation.TimeLogicalTypeAnnotation	timeType(boolean isAdjustedToUTC, LogicalTypeAnnotation.TimeUnit unit)
abstract OriginalType	toOriginalType() Deprecated. Please use the LogicalTypeAnnotation itself
String	toString()
static LogicalTypeAnnotation.UUIDLogicalTypeAnnotation	uuidType()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LogicalTypeAnnotation

public LogicalTypeAnnotation()

Method Detail

toOriginalType

@Deprecated
public abstract OriginalType toOriginalType()

Deprecated. Please use the LogicalTypeAnnotation itself

Convert this logical type to old logical type representation in parquet-mr (if there's any). Those logical type implementations, which don't have a corresponding mapping should return null.

API should be considered private

Returns:

the OriginalType representation of the new logical type, or null if there's none

accept

public abstract <T> Optional<T> accept(LogicalTypeAnnotation.LogicalTypeAnnotationVisitor<T> logicalTypeAnnotationVisitor)

Visits this logical type with the given visitor

Parameters:

logicalTypeAnnotationVisitor - the visitor to visit this type

toString

public String toString()

Overrides:

toString in class Object

fromOriginalType

public static LogicalTypeAnnotation fromOriginalType(OriginalType originalType,
                                                     DecimalMetadata decimalMetadata)

Helper method to convert the old representation of logical types (OriginalType) to new logical type.

API should be considered private

stringType

public static LogicalTypeAnnotation.StringLogicalTypeAnnotation stringType()

mapType

public static LogicalTypeAnnotation.MapLogicalTypeAnnotation mapType()

listType

public static LogicalTypeAnnotation.ListLogicalTypeAnnotation listType()

enumType

public static LogicalTypeAnnotation.EnumLogicalTypeAnnotation enumType()

decimalType

public static LogicalTypeAnnotation.DecimalLogicalTypeAnnotation decimalType(int scale,
                                                                             int precision)

dateType

public static LogicalTypeAnnotation.DateLogicalTypeAnnotation dateType()

timeType

public static LogicalTypeAnnotation.TimeLogicalTypeAnnotation timeType(boolean isAdjustedToUTC,
                                                                       LogicalTypeAnnotation.TimeUnit unit)

timestampType

public static LogicalTypeAnnotation.TimestampLogicalTypeAnnotation timestampType(boolean isAdjustedToUTC,
                                                                                 LogicalTypeAnnotation.TimeUnit unit)

intType

public static LogicalTypeAnnotation.IntLogicalTypeAnnotation intType(int bitWidth)

intType

public static LogicalTypeAnnotation.IntLogicalTypeAnnotation intType(int bitWidth,
                                                                     boolean isSigned)

intervalType

public static LogicalTypeAnnotation.IntervalLogicalTypeAnnotation intervalType()

jsonType

public static LogicalTypeAnnotation.JsonLogicalTypeAnnotation jsonType()

bsonType

public static LogicalTypeAnnotation.BsonLogicalTypeAnnotation bsonType()

uuidType

public static LogicalTypeAnnotation.UUIDLogicalTypeAnnotation uuidType()

float16Type

public static LogicalTypeAnnotation.Float16LogicalTypeAnnotation float16Type()