org.apache.drill.exec.record.metadata

Class TupleSchema

java.lang.Object

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

org.apache.drill.exec.record.metadata.TupleSchema

All Implemented Interfaces:

Iterable<ColumnMetadata>, Propertied, TupleMetadata

public class TupleSchema
extends AbstractPropertied
implements TupleMetadata

Defines the schema of a tuple: either the top-level row or a nested "map" (really structure). A schema is a collection of columns (backed by vectors in the loader itself.) Columns are accessible by name or index. New columns may be added at any time; the new column takes the next available index.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE

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

IS_STRICT_SCHEMA_PROP, READER, WRITER

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

DRILL_PROP_PREFIX

Constructor Summary

Constructors

Constructor and Description
TupleSchema()
TupleSchema(List<AbstractColumnMetadata> columns, Map<String,String> properties)

Method Summary

Modifier and Type	Method and Description
void	add(ColumnMetadata md) Add a column metadata column created by the caller.
ColumnMetadata	add(MaterializedField field) Add a new column to the schema.
int	addColumn(ColumnMetadata column)
ColumnMetadata	addView(MaterializedField field)
void	bind(AbstractMapColumnMetadata parentMap)
MaterializedField	column(int index)
MaterializedField	column(String name)
TupleSchema	copy()
boolean	equals(Object o)
String	fullName()
String	fullName(ColumnMetadata column) Full name of the column.
String	fullName(int index)
int	hashCode()
int	index(String name)
boolean	isEmpty()
boolean	isEquivalent(TupleMetadata other)
boolean	isRoot()
Iterator<ColumnMetadata>	iterator()
ColumnMetadata	metadata(int index)
ColumnMetadata	metadata(String name)
AbstractMapColumnMetadata	parent()
Map<String,String>	properties()
void	replace(ColumnMetadata replaceWith)
int	size()
List<MaterializedField>	toFieldList() Return the schema as a list of MaterializedField objects which can be used to create other schemas.
List<ColumnMetadata>	toMetadataList() Returns schema as list of ColumnMetadata objects which can be used to create JSON schema object.
String	toString()

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

booleanProperty, booleanProperty, 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.TupleMetadata

jsonString, of

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

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

TupleSchema

public TupleSchema()

TupleSchema

public TupleSchema(List<AbstractColumnMetadata> columns,
                   Map<String,String> properties)

Method Detail

bind

public void bind(AbstractMapColumnMetadata parentMap)

copy

public TupleSchema copy()

Specified by:

copy in interface TupleMetadata

add

public ColumnMetadata add(MaterializedField field)

Description copied from interface: TupleMetadata

Add a new column to the schema.

Specified by:

add in interface TupleMetadata

Parameters:

field - materialized field

Returns:

the index of the new column

addView

public ColumnMetadata addView(MaterializedField field)

add

public void add(ColumnMetadata md)

Add a column metadata column created by the caller. Used for specialized cases beyond those handled by add(MaterializedField).

Parameters:

md - the custom column metadata which must have the correct index set (from size()

addColumn

public int addColumn(ColumnMetadata column)

Specified by:

addColumn in interface TupleMetadata

column

public MaterializedField column(String name)

Specified by:

column in interface TupleMetadata

metadata

public ColumnMetadata metadata(String name)

Specified by:

metadata in interface TupleMetadata

index

public int index(String name)

Specified by:

index in interface TupleMetadata

column

public MaterializedField column(int index)

Specified by:

column in interface TupleMetadata

metadata

public ColumnMetadata metadata(int index)

Specified by:

metadata in interface TupleMetadata

parent

public AbstractMapColumnMetadata parent()

Specified by:

parent in interface TupleMetadata

size

public int size()

Specified by:

size in interface TupleMetadata

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface TupleMetadata

iterator

public Iterator<ColumnMetadata> iterator()

Specified by:

iterator in interface Iterable<ColumnMetadata>

isEquivalent

public boolean isEquivalent(TupleMetadata other)

Specified by:

isEquivalent in interface TupleMetadata

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractPropertied

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractPropertied

toFieldList

public List<MaterializedField> toFieldList()

Description copied from interface: TupleMetadata

Return the schema as a list of MaterializedField objects which can be used to create other schemas. Not valid for a flattened schema.

Specified by:

toFieldList in interface TupleMetadata

Returns:

a list of the top-level fields. Maps contain their child fields

toMetadataList

public List<ColumnMetadata> toMetadataList()

Description copied from interface: TupleMetadata

Returns schema as list of ColumnMetadata objects which can be used to create JSON schema object.

Specified by:

toMetadataList in interface TupleMetadata

Returns:

a list of metadata for each column

fullName

public String fullName(int index)

Specified by:

fullName in interface TupleMetadata

fullName

public String fullName(ColumnMetadata column)

Description copied from interface: TupleMetadata

Full name of the column. Note: this name cannot be used to look up the column because of ambiguity. The name "a.b.c" may mean a single column with that name, or may mean maps "a", and "b" with column "c", etc.

Specified by:

fullName in interface TupleMetadata

Returns:

full, dotted, column name

fullName

public String fullName()

isRoot

public boolean isRoot()

replace

public void replace(ColumnMetadata replaceWith)

Specified by:

replace in interface TupleMetadata

toString

public String toString()

Overrides:

toString in class Object

properties

public Map<String,String> properties()

Specified by:

properties in interface Propertied

Overrides:

properties in class AbstractPropertied