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

Class FieldType

java.lang.Object

org.apache.arrow.vector.types.pojo.FieldType

public class FieldType
extends Object

POJO representation of an Arrow field type. It consists of a logical type, nullability and whether the field (column) is dictionary encoded.

Constructor Summary

Constructors

Constructor	Description
FieldType(boolean nullable, ArrowType type, DictionaryEncoding dictionary)
FieldType(boolean nullable, ArrowType type, DictionaryEncoding dictionary, Map<String,String> metadata)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
FieldVector	createNewSingleVector(String name, BufferAllocator allocator, CallBack schemaCallBack)
FieldVector	createNewSingleVector(Field field, BufferAllocator allocator, CallBack schemaCallBack)
boolean	equals(Object obj)
DictionaryEncoding	getDictionary()
Map<String,String>	getMetadata()
ArrowType	getType()
int	hashCode()
boolean	isNullable()
static FieldType	notNullable(ArrowType type)
static FieldType	nullable(ArrowType type)

Methods inherited from class java.lang.Object

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

Constructor Details

FieldType

public FieldType(boolean nullable,
 ArrowType type,
 DictionaryEncoding dictionary)

FieldType

public FieldType(boolean nullable,
 ArrowType type,
 DictionaryEncoding dictionary,
 Map<String,String> metadata)

Constructs a new instance.

Parameters:

nullable - Whether the Vector is nullable

type - The logical arrow type of the field.

dictionary - The dictionary encoding of the field.

metadata - Custom metadata for the field.

Method Details

nullable

public static FieldType nullable(ArrowType type)

notNullable

public static FieldType notNullable(ArrowType type)

isNullable

public boolean isNullable()

getType

public ArrowType getType()

getDictionary

public DictionaryEncoding getDictionary()

getMetadata

public Map<String,String> getMetadata()

createNewSingleVector

public FieldVector createNewSingleVector(String name,
 BufferAllocator allocator,
 CallBack schemaCallBack)

createNewSingleVector

public FieldVector createNewSingleVector(Field field,
 BufferAllocator allocator,
 CallBack schemaCallBack)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object