org.apache.drill.exec.record.metadata

Class MetadataUtils

java.lang.Object

org.apache.drill.exec.record.metadata.MetadataUtils

public class MetadataUtils
extends Object

A collection of utility methods for working with column and tuple metadata.

Constructor Summary

Constructors

Constructor and Description
MetadataUtils()

Method Summary

Modifier and Type	Method and Description
static ColumnMetadata	cloneMapWithSchema(ColumnMetadata source, TupleMetadata members)
static ColumnMetadata	diffMap(ColumnMetadata map, ColumnMetadata other)
static TupleMetadata	diffTuple(TupleMetadata base, TupleMetadata subtend)
static TupleSchema	fromColumns(List<ColumnMetadata> columns) Create a tuple given the list of columns that make up the tuple.
static ColumnMetadata	fromField(MaterializedField field) Create a column metadata object that holds the given MaterializedField.
static TupleSchema	fromFields(Iterable<MaterializedField> fields)
static ColumnMetadata	fromView(MaterializedField field)
static boolean	hasDynamicColumns(TupleMetadata schema)
static boolean	isComplex(TypeProtos.MinorType type)
static boolean	isRepeatedList(ColumnMetadata col)
static boolean	isScalar(ColumnMetadata col)
static boolean	isScalar(TypeProtos.MinorType type)
static boolean	isWildcard(ColumnMetadata col)
static ColumnMetadata	newDecimal(String name, TypeProtos.DataMode mode, int precision, int scale)
static ColumnMetadata	newDecimal(String name, TypeProtos.MinorType type, TypeProtos.DataMode mode, int precision, int scale)
static DictColumnMetadata	newDict(MaterializedField field)
static DictColumnMetadata	newDict(MaterializedField field, TupleSchema schema)
static DictColumnMetadata	newDict(String name)
static DictColumnMetadata	newDictArray(String name)
static ColumnMetadata	newDynamic(String name)
static MapColumnMetadata	newMap(MaterializedField field)
static MapColumnMetadata	newMap(MaterializedField field, TupleSchema schema) Create a column metadata object for a map column, given the MaterializedField that describes the column, and a list of column metadata objects that describe the columns in the map.
static MapColumnMetadata	newMap(String name)
static MapColumnMetadata	newMap(String name, TupleMetadata schema)
static MapColumnMetadata	newMap(String name, TypeProtos.DataMode dataMode, TupleMetadata schema)
static ColumnMetadata	newMapArray(String name)
static ColumnMetadata	newMapArray(String name, TupleMetadata schema)
static RepeatedListColumnMetadata	newRepeatedList(String name, ColumnMetadata child)
static PrimitiveColumnMetadata	newScalar(String name, TypeProtos.MajorType type)
static PrimitiveColumnMetadata	newScalar(String name, TypeProtos.MinorType type, TypeProtos.DataMode mode)
static VariantColumnMetadata	newVariant(MaterializedField field, VariantSchema schema)
static VariantColumnMetadata	newVariant(String name, TypeProtos.DataMode cardinality)
static ColumnMetadata	wildcard()

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataUtils

public MetadataUtils()

Method Detail

fromFields

public static TupleSchema fromFields(Iterable<MaterializedField> fields)

fromField

public static ColumnMetadata fromField(MaterializedField field)

Create a column metadata object that holds the given MaterializedField. The type of the object will be either a primitive, map or dict column, depending on the field's type. The logic here mimics the code as written, which is very messy in some places.

Parameters:

field - the materialized field to wrap

Returns:

the column metadata that wraps the field

fromView

public static ColumnMetadata fromView(MaterializedField field)

fromColumns

public static TupleSchema fromColumns(List<ColumnMetadata> columns)

Create a tuple given the list of columns that make up the tuple. Creates nested maps as needed.

Parameters:

columns - list of columns that make up the tuple

Returns:

a tuple metadata object that contains the columns

newMap

public static MapColumnMetadata newMap(MaterializedField field,
                                       TupleSchema schema)

Create a column metadata object for a map column, given the MaterializedField that describes the column, and a list of column metadata objects that describe the columns in the map.

Parameters:

field - the materialized field that describes the map column

schema - metadata that describes the tuple of columns in the map

Returns:

a map column metadata for the map

newMap

public static MapColumnMetadata newMap(MaterializedField field)

newMap

public static MapColumnMetadata newMap(String name,
                                       TupleMetadata schema)

newMap

public static MapColumnMetadata newMap(String name)

newDict

public static DictColumnMetadata newDict(MaterializedField field)

newDict

public static DictColumnMetadata newDict(MaterializedField field,
                                         TupleSchema schema)

newDict

public static DictColumnMetadata newDict(String name)

newVariant

public static VariantColumnMetadata newVariant(MaterializedField field,
                                               VariantSchema schema)

newVariant

public static VariantColumnMetadata newVariant(String name,
                                               TypeProtos.DataMode cardinality)

newRepeatedList

public static RepeatedListColumnMetadata newRepeatedList(String name,
                                                         ColumnMetadata child)

newMapArray

public static ColumnMetadata newMapArray(String name,
                                         TupleMetadata schema)

newMap

public static MapColumnMetadata newMap(String name,
                                       TypeProtos.DataMode dataMode,
                                       TupleMetadata schema)

newMapArray

public static ColumnMetadata newMapArray(String name)

newDictArray

public static DictColumnMetadata newDictArray(String name)

newScalar

public static PrimitiveColumnMetadata newScalar(String name,
                                                TypeProtos.MinorType type,
                                                TypeProtos.DataMode mode)

newScalar

public static PrimitiveColumnMetadata newScalar(String name,
                                                TypeProtos.MajorType type)

newDecimal

public static ColumnMetadata newDecimal(String name,
                                        TypeProtos.DataMode mode,
                                        int precision,
                                        int scale)

newDecimal

public static ColumnMetadata newDecimal(String name,
                                        TypeProtos.MinorType type,
                                        TypeProtos.DataMode mode,
                                        int precision,
                                        int scale)

isScalar

public static boolean isScalar(ColumnMetadata col)

isScalar

public static boolean isScalar(TypeProtos.MinorType type)

isComplex

public static boolean isComplex(TypeProtos.MinorType type)

newDynamic

public static ColumnMetadata newDynamic(String name)

wildcard

public static ColumnMetadata wildcard()

isWildcard

public static boolean isWildcard(ColumnMetadata col)

cloneMapWithSchema

public static ColumnMetadata cloneMapWithSchema(ColumnMetadata source,
                                                TupleMetadata members)

diffMap

public static ColumnMetadata diffMap(ColumnMetadata map,
                                     ColumnMetadata other)

diffTuple

public static TupleMetadata diffTuple(TupleMetadata base,
                                      TupleMetadata subtend)

hasDynamicColumns

public static boolean hasDynamicColumns(TupleMetadata schema)

isRepeatedList

public static boolean isRepeatedList(ColumnMetadata col)