org.apache.drill.exec.record.metadata

Class DictBuilder

java.lang.Object

org.apache.drill.exec.record.metadata.DictBuilder

public class DictBuilder
extends Object

Internal structure for building a dict. Dict is an array of key-value pairs with defined types for key and value (key and value fields are defined within TupleSchema). Key can be TypeProtos.DataMode.REQUIRED primitive, while value can be primitive or complex.

Column is added to the parent container during creation and all resumeXXX methods return qualified parent container.

See Also:

DictVector

Constructor Summary

Constructors

Constructor and Description
DictBuilder(org.apache.drill.exec.record.metadata.SchemaContainer parent, String name, TypeProtos.DataMode mode)

Method Summary

Modifier and Type	Method and Description
void	addColumn(ColumnMetadata column)
void	build()
DictColumnMetadata	buildColumn()
DictBuilder	dictArrayValue()
DictBuilder	dictValue()
DictBuilder	key(TypeProtos.MajorType type) Use this method to set types with width or scale and precision, e.g.
DictBuilder	key(TypeProtos.MinorType type)
UnionBuilder	listValue()
MapBuilder	mapArrayValue()
MapBuilder	mapValue()
DictBuilder	nullableValue(TypeProtos.MinorType type)
RepeatedListBuilder	repeatedListValue()
DictBuilder	repeatedValue(TypeProtos.MinorType type)
DictBuilder	resumeDict()
RepeatedListBuilder	resumeList()
MapBuilder	resumeMap()
SchemaBuilder	resumeSchema()
UnionBuilder	resumeUnion()
UnionBuilder	unionValue()
DictBuilder	value(TypeProtos.MajorType type) Define non-complex value type.
DictBuilder	value(TypeProtos.MinorType type)

Methods inherited from class java.lang.Object

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

Constructor Detail

DictBuilder

public DictBuilder(org.apache.drill.exec.record.metadata.SchemaContainer parent,
                   String name,
                   TypeProtos.DataMode mode)

Method Detail

addColumn

public void addColumn(ColumnMetadata column)

key

public DictBuilder key(TypeProtos.MinorType type)

key

public DictBuilder key(TypeProtos.MajorType type)

Use this method to set types with width or scale and precision, e.g. TypeProtos.MinorType.VARDECIMAL with scale and precision or TypeProtos.MinorType.VARCHAR etc.

Parameters:

type - desired type for key

Returns:

this builder

Throws:

IllegalStateException - if key field is already set

IllegalArgumentException - if type is not supported (either complex or nullable)

value

public DictBuilder value(TypeProtos.MinorType type)

nullableValue

public DictBuilder nullableValue(TypeProtos.MinorType type)

repeatedValue

public DictBuilder repeatedValue(TypeProtos.MinorType type)

value

public DictBuilder value(TypeProtos.MajorType type)

Define non-complex value type. For complex types use mapValue(), mapArrayValue() etc.

Parameters:

type - desired non-complex type for value.

Returns:

this builder

Throws:

IllegalStateException - if value is already set

IllegalArgumentException - if type is either MAP, LIST, DICT or UNION.

See Also:

method to define value as {@code MAP}, method to define value as {@code REPEATED MAP}, method to define value as {@code LIST}, method to define value as {@code UNION}, method to define value as {@code DICT}, method to define value as {@code REPEATED DICT}

mapValue

public MapBuilder mapValue()

mapArrayValue

public MapBuilder mapArrayValue()

dictValue

public DictBuilder dictValue()

dictArrayValue

public DictBuilder dictArrayValue()

unionValue

public UnionBuilder unionValue()

listValue

public UnionBuilder listValue()

repeatedListValue

public RepeatedListBuilder repeatedListValue()

buildColumn

public DictColumnMetadata buildColumn()

build

public void build()

resumeSchema

public SchemaBuilder resumeSchema()

resumeMap

public MapBuilder resumeMap()

resumeList

public RepeatedListBuilder resumeList()

resumeUnion

public UnionBuilder resumeUnion()

resumeDict

public DictBuilder resumeDict()