Package org.apache.drill.exec.record.metadata

Class PrimitiveColumnMetadata

java.lang.Object

org.apache.drill.exec.record.metadata.AbstractPropertied

org.apache.drill.exec.record.metadata.AbstractColumnMetadata

org.apache.drill.exec.record.metadata.PrimitiveColumnMetadata

All Implemented Interfaces:

ColumnMetadata, Propertied

public class PrimitiveColumnMetadata
extends AbstractColumnMetadata

Primitive (non-map) column. Describes non-nullable, nullable and array types (which differ only in mode, but not in metadata structure.)

Metadata is of two types:

• Storage metadata that describes how the column is materialized in a vector. Storage metadata is immutable because revising an existing vector is a complex operation.
• Supplemental metadata used when reading or writing the column. Supplemental metadata can be changed after the column is created, though it should generally be set before invoking code that uses the metadata.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.drill.exec.record.metadata.ColumnMetadata

ColumnMetadata.StructureType

Field Summary

Fields inherited from class org.apache.drill.exec.record.metadata.AbstractColumnMetadata

mode, name, precision, scale, type

Fields inherited from interface org.apache.drill.exec.record.metadata.ColumnMetadata

BLANK_AS_NULL, BLANK_AS_PROP, BLANK_AS_ZERO, DEFAULT_ARRAY_SIZE, DEFAULT_VALUE_PROP, EXCLUDE_FROM_WILDCARD, EXPECTED_CARDINALITY_PROP, EXPECTED_WIDTH_PROP, FORMAT_PROP, IMPLICIT_COL_TYPE, IMPLICIT_FILENAME, IMPLICIT_FILEPATH, IMPLICIT_FQN, IMPLICIT_PARTITION_PREFIX, IMPLICIT_SUFFIX

Fields inherited from interface org.apache.drill.exec.record.metadata.Propertied

DRILL_PROP_PREFIX

Constructor Summary

Constructors

Constructor	Description
PrimitiveColumnMetadata(String name, TypeProtos.MajorType type)
PrimitiveColumnMetadata(String name, TypeProtos.MinorType type, TypeProtos.DataMode mode)
PrimitiveColumnMetadata(String name, TypeProtos.MinorType type, TypeProtos.DataMode mode, boolean forUnknownSchema)
PrimitiveColumnMetadata(MaterializedField schema)
PrimitiveColumnMetadata(PrimitiveColumnMetadata from)

Method Summary

Modifier and Type	Method	Description
ColumnMetadata	cloneEmpty()	Create an empty version of this column.
ColumnMetadata	copy()
DateTimeFormatter	dateTimeFormatter()	Returns the formatter to use for date/time values.
MaterializedField	emptySchema()
int	expectedWidth()	Get the expected width for a column.
boolean	isEquivalent(ColumnMetadata o)	Report whether one column is equivalent to another.
boolean	isScalar()
boolean	isSchemaForUnknown()
TypeProtos.MajorType	majorType()
ColumnMetadata	mergeWith(MaterializedField field)
int	precision()	Returns precision for current column.
int	scale()	Returns scale for current column.
MaterializedField	schema()
void	setExpectedWidth(int width)	For variable-width columns, specify the expected column width to be used when allocating a new vector.
ColumnMetadata.StructureType	structureType()
String	typeString()	Converts type metadata into string representation accepted by the table schema parser.
Object	valueFromString(String value)	Converts value in string literal form into Object instance based on TypeProtos.MinorType value.
String	valueToString(Object value)	Converts given value instance into String literal representation based on column metadata type.

Methods inherited from class org.apache.drill.exec.record.metadata.AbstractColumnMetadata

appendContents, bind, childSchema, columnString, createColumnMetadata, decodeDefaultValue, defaultValue, dimensions, equals, equalsWithProperties, equalsWithProperties, escapeSpecialSymbols, expectedElementCount, format, isArray, isDict, isDynamic, isMap, isMultiList, isNullable, isVariableWidth, isVariant, mode, name, properties, setDefaultValue, setExpectedElementCount, setFormat, toString, tupleSchema, type, variantSchema

Methods inherited from class org.apache.drill.exec.record.metadata.AbstractPropertied

booleanProperty, booleanProperty, hashCode, hasProperties, intProperty, intProperty, property, property, removeProperty, setBooleanProperty, setIntProperty, setProperties, setProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.drill.exec.record.metadata.Propertied

booleanProperty, booleanProperty, hasProperties, intProperty, intProperty, property, property, removeProperty, setBooleanProperty, setIntProperty, setProperties, setProperty

Constructor Details

PrimitiveColumnMetadata

public PrimitiveColumnMetadata(MaterializedField schema)

PrimitiveColumnMetadata

public PrimitiveColumnMetadata(String name,
 TypeProtos.MajorType type)

PrimitiveColumnMetadata

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

PrimitiveColumnMetadata

public PrimitiveColumnMetadata(String name,
 TypeProtos.MinorType type,
 TypeProtos.DataMode mode,
 boolean forUnknownSchema)

PrimitiveColumnMetadata

public PrimitiveColumnMetadata(PrimitiveColumnMetadata from)

Method Details

copy

public ColumnMetadata copy()

structureType

public ColumnMetadata.StructureType structureType()

expectedWidth

public int expectedWidth()

Description copied from interface: ColumnMetadata

Get the expected width for a column. This is the actual width for fixed- width columns, the specified width (defaulting to 50) for variable-width columns.

Specified by:

expectedWidth in interface ColumnMetadata

Overrides:

expectedWidth in class AbstractColumnMetadata

Returns:

the expected column width of the each data value. Does not include "overhead" space such as for the null-value vector or offset vector

precision

public int precision()

Description copied from class: AbstractColumnMetadata

Returns precision for current column. For the case when precision is not set or column type does not support precision, negative value will be returned.

Specified by:

precision in interface ColumnMetadata

Overrides:

precision in class AbstractColumnMetadata

Returns:

precision for current column

scale

public int scale()

Description copied from class: AbstractColumnMetadata

Returns scale for current column. For the case when scale is not set or column type does not support scale, negative value will be returned.

Specified by:

scale in interface ColumnMetadata

Overrides:

scale in class AbstractColumnMetadata

Returns:

scale for current column

setExpectedWidth

public void setExpectedWidth(int width)

Description copied from interface: ColumnMetadata

For variable-width columns, specify the expected column width to be used when allocating a new vector. Does nothing for fixed-width columns.

Specified by:

setExpectedWidth in interface ColumnMetadata

Overrides:

setExpectedWidth in class AbstractColumnMetadata

Parameters:

width - the expected column width

dateTimeFormatter

public DateTimeFormatter dateTimeFormatter()

Description copied from interface: ColumnMetadata

Returns the formatter to use for date/time values. Only valid for date/time columns.

Specified by:

dateTimeFormatter in interface ColumnMetadata

Overrides:

dateTimeFormatter in class AbstractColumnMetadata

Returns:

cloneEmpty

public ColumnMetadata cloneEmpty()

Description copied from interface: ColumnMetadata

Create an empty version of this column. If the column is a scalar, produces a simple copy. If a map, produces a clone without child columns.

Returns:

empty clone of this column

mergeWith

public ColumnMetadata mergeWith(MaterializedField field)

majorType

public TypeProtos.MajorType majorType()

Specified by:

majorType in interface ColumnMetadata

Overrides:

majorType in class AbstractColumnMetadata

schema

public MaterializedField schema()

emptySchema

public MaterializedField emptySchema()

typeString

public String typeString()

Description copied from interface: ColumnMetadata

Converts type metadata into string representation accepted by the table schema parser.

Specified by:

typeString in interface ColumnMetadata

Specified by:

typeString in class AbstractColumnMetadata

Returns:

type metadata string representation

valueFromString

public Object valueFromString(String value)

Converts value in string literal form into Object instance based on TypeProtos.MinorType value. Returns null in case of error during parsing or unsupported type.

Specified by:

valueFromString in interface ColumnMetadata

Overrides:

valueFromString in class AbstractColumnMetadata

Parameters:

value - value in string literal form

Returns:

Object instance

valueToString

public String valueToString(Object value)

Converts given value instance into String literal representation based on column metadata type.

Specified by:

valueToString in interface ColumnMetadata

Overrides:

valueToString in class AbstractColumnMetadata

Parameters:

value - value instance

Returns:

value in string literal representation

isEquivalent

public boolean isEquivalent(ColumnMetadata o)

Description copied from interface: ColumnMetadata

Report whether one column is equivalent to another. Columns are equivalent if they have the same name, type and structure (ignoring internal structure such as properties.)

Specified by:

isEquivalent in interface ColumnMetadata

Overrides:

isEquivalent in class AbstractColumnMetadata

isScalar

public boolean isScalar()

Specified by:

isScalar in interface ColumnMetadata

Overrides:

isScalar in class AbstractColumnMetadata

isSchemaForUnknown

public boolean isSchemaForUnknown()

Returns:

true in case this primitive is created for unknown schema, for instance the column with all null values