Package org.apache.calcite.rel.type

Class RelDataTypeFactory.Builder

java.lang.Object

org.apache.calcite.rel.type.RelDataTypeFactory.Builder

Direct Known Subclasses:

RelDataTypeFactory.FieldInfoBuilder

Enclosing interface:

RelDataTypeFactory

public static class RelDataTypeFactory.Builder
extends Object

Fluid API to build a list of fields.

Constructor Summary

Constructors

Constructor	Description
Builder(RelDataTypeFactory typeFactory)	Creates a Builder with the given type factory.

Method Summary

Modifier and Type	Method	Description
RelDataTypeFactory.Builder	add(String name, org.apache.calcite.avatica.util.TimeUnit startUnit, int startPrecision, org.apache.calcite.avatica.util.TimeUnit endUnit, int fractionalSecondPrecision)	Adds a field with an interval type.
RelDataTypeFactory.Builder	add(String name, RelDataType type)	Adds a field with given name and type.
RelDataTypeFactory.Builder	add(String name, SqlTypeName typeName)	Adds a field with a type created using RelDataTypeFactory.createSqlType(org.apache.calcite.sql.type.SqlTypeName).
RelDataTypeFactory.Builder	add(String name, SqlTypeName typeName, int precision)	Adds a field with a type created using RelDataTypeFactory.createSqlType(org.apache.calcite.sql.type.SqlTypeName, int).
RelDataTypeFactory.Builder	add(String name, SqlTypeName typeName, int precision, int scale)	Adds a field with a type created using RelDataTypeFactory.createSqlType(org.apache.calcite.sql.type.SqlTypeName, int, int).
RelDataTypeFactory.Builder	add(RelDataTypeField field)	Adds a field.
RelDataTypeFactory.Builder	addAll(Iterable<? extends Map.Entry<String,RelDataType>> fields)	Adds all fields in a collection.
RelDataType	build()	Creates a struct type with the current contents of this builder.
RelDataType	buildDynamic()	Creates a dynamic struct type with the current contents of this builder.
int	getFieldCount()	Returns the number of fields.
String	getFieldName(int index)	Returns the name of a given field.
RelDataType	getFieldType(int index)	Returns the type of a given field.
RelDataTypeFactory.Builder	kind(StructKind kind)
boolean	nameExists(String name)	Returns whether a field exists with the given name.
RelDataTypeFactory.Builder	nullable(boolean nullable)	Changes the nullability of the last field added.
RelDataTypeFactory.Builder	nullableRecord(boolean nullableRecord)	Sets whether the record type will be nullable.
RelDataTypeFactory.Builder	uniquify()	Makes sure that field names are unique.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(RelDataTypeFactory typeFactory)

Creates a Builder with the given type factory.

Method Details

getFieldCount

public int getFieldCount()

Returns the number of fields.

Returns:

number of fields

getFieldName

public String getFieldName(int index)

Returns the name of a given field.

Parameters:

index - Ordinal of field

Returns:

Name of given field

getFieldType

public RelDataType getFieldType(int index)

Returns the type of a given field.

Parameters:

index - Ordinal of field

Returns:

Type of given field

add

public RelDataTypeFactory.Builder add(String name,
 RelDataType type)

Adds a field with given name and type.

add

public RelDataTypeFactory.Builder add(String name,
 SqlTypeName typeName)

Adds a field with a type created using RelDataTypeFactory.createSqlType(org.apache.calcite.sql.type.SqlTypeName).

add

public RelDataTypeFactory.Builder add(String name,
 SqlTypeName typeName,
 int precision)

Adds a field with a type created using RelDataTypeFactory.createSqlType(org.apache.calcite.sql.type.SqlTypeName, int).

add

public RelDataTypeFactory.Builder add(String name,
 SqlTypeName typeName,
 int precision,
 int scale)

Adds a field with a type created using RelDataTypeFactory.createSqlType(org.apache.calcite.sql.type.SqlTypeName, int, int).

add

public RelDataTypeFactory.Builder add(String name,
 org.apache.calcite.avatica.util.TimeUnit startUnit,
 int startPrecision,
 org.apache.calcite.avatica.util.TimeUnit endUnit,
 int fractionalSecondPrecision)

Adds a field with an interval type.

nullable

public RelDataTypeFactory.Builder nullable(boolean nullable)

Changes the nullability of the last field added.

Throws:

IndexOutOfBoundsException - if no fields have been added

add

public RelDataTypeFactory.Builder add(RelDataTypeField field)

Adds a field. Field's ordinal is ignored.

addAll

public RelDataTypeFactory.Builder addAll(Iterable<? extends Map.Entry<String,RelDataType>> fields)

Adds all fields in a collection.

kind

public RelDataTypeFactory.Builder kind(StructKind kind)

nullableRecord

public RelDataTypeFactory.Builder nullableRecord(boolean nullableRecord)

Sets whether the record type will be nullable.

uniquify

public RelDataTypeFactory.Builder uniquify()

Makes sure that field names are unique.

build

public RelDataType build()

Creates a struct type with the current contents of this builder.

buildDynamic

public RelDataType buildDynamic()

Creates a dynamic struct type with the current contents of this builder.

nameExists

public boolean nameExists(String name)

Returns whether a field exists with the given name.