Module org.apache.arrow.vector

Package org.apache.arrow.vector.types.pojo

Class ArrowType.ExtensionType

java.lang.Object

org.apache.arrow.vector.types.pojo.ArrowType

org.apache.arrow.vector.types.pojo.ArrowType.ComplexType

org.apache.arrow.vector.types.pojo.ArrowType.ExtensionType

Direct Known Subclasses:

OpaqueType

Enclosing class:

ArrowType

public abstract static class ArrowType.ExtensionType
extends ArrowType.ComplexType

A user-defined data type that wraps an underlying storage type.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.arrow.vector.types.pojo.ArrowType

ArrowType.ArrowTypeID, ArrowType.ArrowTypeVisitor<T>, ArrowType.Binary, ArrowType.BinaryView, ArrowType.Bool, ArrowType.ComplexType, ArrowType.ComplexTypeVisitor<T>, ArrowType.Date, ArrowType.Decimal, ArrowType.Duration, ArrowType.ExtensionType, ArrowType.FixedSizeBinary, ArrowType.FixedSizeList, ArrowType.FloatingPoint, ArrowType.Int, ArrowType.Interval, ArrowType.LargeBinary, ArrowType.LargeList, ArrowType.LargeListView, ArrowType.LargeUtf8, ArrowType.List, ArrowType.ListView, ArrowType.Map, ArrowType.Null, ArrowType.PrimitiveType, ArrowType.PrimitiveTypeVisitor<T>, ArrowType.RunEndEncoded, ArrowType.Struct, ArrowType.Time, ArrowType.Timestamp, ArrowType.Union, ArrowType.Utf8, ArrowType.Utf8View

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXTENSION_METADATA_KEY_METADATA	The field metadata key storing metadata for the extension type.
static final String	EXTENSION_METADATA_KEY_NAME	The field metadata key storing the name of the extension type.

Constructor Summary

Constructors

Constructor	Description
ExtensionType()

Method Summary

Modifier and Type	Method	Description
<T> T	accept(ArrowType.ArrowTypeVisitor<T> visitor)
abstract ArrowType	deserialize(ArrowType storageType, String serializedData)	Given saved metadata and the underlying storage type, construct a new instance of the user type.
boolean	equals(Object obj)
abstract boolean	extensionEquals(ArrowType.ExtensionType other)	Check equality of this type to another user-defined type.
abstract String	extensionName()	The name of this user-defined type.
abstract FieldVector	getNewVector(String name, FieldType fieldType, BufferAllocator allocator)	Construct a vector for the user type.
int	getType(com.google.flatbuffers.FlatBufferBuilder builder)
ArrowType.ArrowTypeID	getTypeID()
int	hashCode()
abstract String	serialize()	Save any metadata for this type.
abstract ArrowType	storageType()	The on-wire type for this user-defined type.
String	toString()

Methods inherited from class org.apache.arrow.vector.types.pojo.ArrowType.ComplexType

isComplex

Methods inherited from class org.apache.arrow.vector.types.pojo.ArrowType

getInt, getTypeForField

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

EXTENSION_METADATA_KEY_NAME

public static final String EXTENSION_METADATA_KEY_NAME

The field metadata key storing the name of the extension type.

See Also:

• Constant Field Values

EXTENSION_METADATA_KEY_METADATA

public static final String EXTENSION_METADATA_KEY_METADATA

The field metadata key storing metadata for the extension type.

See Also:

• Constant Field Values

Constructor Details

ExtensionType

public ExtensionType()

Method Details

storageType

public abstract ArrowType storageType()

The on-wire type for this user-defined type.

extensionName

public abstract String extensionName()

The name of this user-defined type. Used to identify the type during serialization.

extensionEquals

public abstract boolean extensionEquals(ArrowType.ExtensionType other)

Check equality of this type to another user-defined type.

serialize

public abstract String serialize()

Save any metadata for this type.

deserialize

public abstract ArrowType deserialize(ArrowType storageType,
 String serializedData)

Given saved metadata and the underlying storage type, construct a new instance of the user type.

getNewVector

public abstract FieldVector getNewVector(String name,
 FieldType fieldType,
 BufferAllocator allocator)

Construct a vector for the user type.

getTypeID

public ArrowType.ArrowTypeID getTypeID()

Specified by:

getTypeID in class ArrowType

getType

public int getType(com.google.flatbuffers.FlatBufferBuilder builder)

Specified by:

getType in class ArrowType

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

accept

public <T> T accept(ArrowType.ArrowTypeVisitor<T> visitor)

Specified by:

accept in class ArrowType