org.apache.calcite.rel.type

Class RelDataTypeFactoryImpl

java.lang.Object

org.apache.calcite.rel.type.RelDataTypeFactoryImpl

All Implemented Interfaces:

RelDataTypeFactory

Direct Known Subclasses:

SqlTypeFactoryImpl

public abstract class RelDataTypeFactoryImpl
extends Object
implements RelDataTypeFactory

Abstract base for implementations of RelDataTypeFactory.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RelDataTypeFactoryImpl.JavaType Type which is based upon a Java class.

Nested classes/interfaces inherited from interface org.apache.calcite.rel.type.RelDataTypeFactory

RelDataTypeFactory.Builder, RelDataTypeFactory.FieldInfo, RelDataTypeFactory.FieldInfoBuilder

Field Summary

Fields

Modifier and Type	Field and Description
protected RelDataTypeSystem	typeSystem

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RelDataTypeFactoryImpl(RelDataTypeSystem typeSystem) Creates a type factory.

Method Summary

Modifier and Type	Method and Description
RelDataTypeFactory.FieldInfoBuilder	builder() Creates a RelDataTypeFactory.FieldInfoBuilder.
protected RelDataType	canonize(RelDataType type) Registers a type, or returns the existing type if it is already registered.
protected RelDataType	canonize(StructKind kind, List<String> names, List<RelDataType> types)
protected RelDataType	canonize(StructKind kind, List<String> names, List<RelDataType> types, boolean nullable) Looks up a type using a temporary key, and if not present, creates a permanent key and type.
RelDataType	copyType(RelDataType type) Duplicates a type, making a deep copy.
@Nullable RelDataType	createDecimalProduct(RelDataType type1, RelDataType type2) Deprecated.
@Nullable RelDataType	createDecimalQuotient(RelDataType type1, RelDataType type2) Deprecated.
RelDataType	createJavaType(Class clazz) Creates a type that corresponds to a Java class.
RelDataType	createJoinType(RelDataType... types) Creates a cartesian product type.
RelDataType	createStructType(List<? extends Map.Entry<String,RelDataType>> fieldList) Creates a type that represents a structured collection of fieldList, obtaining the field information from a list of (name, type) pairs.
RelDataType	createStructType(List<RelDataType> typeList, List<String> fieldNameList) Creates a type that represents a structured collection of fields.
RelDataType	createStructType(RelDataTypeFactory.FieldInfo fieldInfo) Creates a type that represents a structured collection of fields, obtaining the field information via a callback.
RelDataType	createStructType(StructKind kind, List<RelDataType> typeList, List<String> fieldNameList) Creates a type that represents a structured collection of fields, given lists of the names and types of the fields.
RelDataType	createTypeWithNullability(RelDataType type, boolean nullable) Creates a type that is the same as another type but with possibly different nullability.
RelDataType	decimalOf(RelDataType type) Create a decimal type equivalent to the numeric type, this is related to specific system implementation, you can override this logic if it is required.
Charset	getDefaultCharset() Returns the default Charset (valid if this is a string type).
RelDataTypeSystem	getTypeSystem() Returns the type system.
static boolean	isJavaType(RelDataType t)
@Nullable RelDataType	leastRestrictive(List<RelDataType> types) Returns the most general of a set of types (that is, one type to which they can all be cast), or null if conversion is not possible.
protected @Nullable RelDataType	leastRestrictiveArrayMultisetType(List<RelDataType> types, SqlTypeName sqlTypeName)
protected @Nullable RelDataType	leastRestrictiveMapType(List<RelDataType> types, SqlTypeName sqlTypeName)
protected @Nullable RelDataType	leastRestrictiveStructuredType(List<RelDataType> types)
boolean	useDoubleMultiplication(RelDataType type1, RelDataType type2) Deprecated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.calcite.rel.type.RelDataTypeFactory

createArrayType, createMapType, createMultisetType, createSqlIntervalType, createSqlType, createSqlType, createSqlType, createTypeWithCharsetAndCollation, createUnknownType

Field Detail

typeSystem

protected final RelDataTypeSystem typeSystem

Constructor Detail

RelDataTypeFactoryImpl

protected RelDataTypeFactoryImpl(RelDataTypeSystem typeSystem)

Creates a type factory.

Method Detail

getTypeSystem

public RelDataTypeSystem getTypeSystem()

Description copied from interface: RelDataTypeFactory

Returns the type system.

Specified by:

getTypeSystem in interface RelDataTypeFactory

Returns:

Type system

createJavaType

public RelDataType createJavaType(Class clazz)

Description copied from interface: RelDataTypeFactory

Creates a type that corresponds to a Java class.

Specified by:

createJavaType in interface RelDataTypeFactory

Parameters:

clazz - the Java class used to define the type

Returns:

canonical Java type descriptor

createJoinType

public RelDataType createJoinType(RelDataType... types)

Description copied from interface: RelDataTypeFactory

Creates a cartesian product type.

Specified by:

createJoinType in interface RelDataTypeFactory

Parameters:

types - array of types to be joined

Returns:

canonical join type descriptor

createStructType

public RelDataType createStructType(List<RelDataType> typeList,
                                    List<String> fieldNameList)

Description copied from interface: RelDataTypeFactory

Creates a type that represents a structured collection of fields. Shorthand for createStructType(StructKind.FULLY_QUALIFIED, typeList, fieldNameList).

Specified by:

createStructType in interface RelDataTypeFactory

createStructType

public RelDataType createStructType(StructKind kind,
                                    List<RelDataType> typeList,
                                    List<String> fieldNameList)

Description copied from interface: RelDataTypeFactory

Creates a type that represents a structured collection of fields, given lists of the names and types of the fields.

Specified by:

createStructType in interface RelDataTypeFactory

Parameters:

kind - Name resolution policy

typeList - types of the fields

fieldNameList - names of the fields

Returns:

canonical struct type descriptor

createStructType

public RelDataType createStructType(RelDataTypeFactory.FieldInfo fieldInfo)

Description copied from interface: RelDataTypeFactory

Creates a type that represents a structured collection of fields, obtaining the field information via a callback.

Specified by:

createStructType in interface RelDataTypeFactory

Parameters:

fieldInfo - callback for field information

Returns:

canonical struct type descriptor

createStructType

public final RelDataType createStructType(List<? extends Map.Entry<String,RelDataType>> fieldList)

Description copied from interface: RelDataTypeFactory

Creates a type that represents a structured collection of fieldList, obtaining the field information from a list of (name, type) pairs.

Specified by:

createStructType in interface RelDataTypeFactory

Parameters:

fieldList - List of (name, type) pairs

Returns:

canonical struct type descriptor

leastRestrictive

public @Nullable RelDataType leastRestrictive(List<RelDataType> types)

Description copied from interface: RelDataTypeFactory

Returns the most general of a set of types (that is, one type to which they can all be cast), or null if conversion is not possible. The result may be a new type that is less restrictive than any of the input types, e.g. leastRestrictive(INT, NUMERIC(3, 2)) could be NUMERIC(12, 2).

Specified by:

leastRestrictive in interface RelDataTypeFactory

Parameters:

types - input types to be combined using union (not null, not empty)

Returns:

canonical union type descriptor

leastRestrictiveStructuredType

protected @Nullable RelDataType leastRestrictiveStructuredType(List<RelDataType> types)

leastRestrictiveArrayMultisetType

protected @Nullable RelDataType leastRestrictiveArrayMultisetType(List<RelDataType> types,
                                                                  SqlTypeName sqlTypeName)

leastRestrictiveMapType

protected @Nullable RelDataType leastRestrictiveMapType(List<RelDataType> types,
                                                        SqlTypeName sqlTypeName)

copyType

public RelDataType copyType(RelDataType type)

Description copied from interface: RelDataTypeFactory

Duplicates a type, making a deep copy. Normally, this is a no-op, since canonical type objects are returned. However, it is useful when copying a type from one factory to another.

Specified by:

copyType in interface RelDataTypeFactory

Parameters:

type - input type

Returns:

output type, a new object equivalent to input type

createTypeWithNullability

public RelDataType createTypeWithNullability(RelDataType type,
                                             boolean nullable)

Description copied from interface: RelDataTypeFactory

Creates a type that is the same as another type but with possibly different nullability. The output type may be identical to the input type. For type systems without a concept of nullability, the return value is always the same as the input.

Specified by:

createTypeWithNullability in interface RelDataTypeFactory

Parameters:

type - input type

nullable - true to request a nullable type; false to request a NOT NULL type

Returns:

output type, same as input type except with specified nullability

canonize

protected RelDataType canonize(RelDataType type)

Registers a type, or returns the existing type if it is already registered.

Throws:

NullPointerException - if type is null

canonize

protected RelDataType canonize(StructKind kind,
                               List<String> names,
                               List<RelDataType> types,
                               boolean nullable)

Looks up a type using a temporary key, and if not present, creates a permanent key and type.

This approach allows us to use a cheap temporary key. A permanent key is more expensive, because it must be immutable and not hold references into other data structures.

canonize

protected RelDataType canonize(StructKind kind,
                               List<String> names,
                               List<RelDataType> types)

isJavaType

public static boolean isJavaType(RelDataType t)

createDecimalProduct

@Deprecated
public @Nullable RelDataType createDecimalProduct(RelDataType type1,
                                                              RelDataType type2)

Deprecated.

Delegates to RelDataTypeSystem.deriveDecimalMultiplyType(RelDataTypeFactory, RelDataType, RelDataType) to get the return type for the operation.

Specified by:

createDecimalProduct in interface RelDataTypeFactory

Parameters:

type1 - type of the first operand

type2 - type of the second operand

Returns:

the result type for a decimal multiplication, or null if decimal multiplication should not be applied to the operands.

useDoubleMultiplication

@Deprecated
public boolean useDoubleMultiplication(RelDataType type1,
                                                   RelDataType type2)

Deprecated.

Delegates to RelDataTypeSystem.shouldUseDoubleMultiplication(RelDataTypeFactory, RelDataType, RelDataType) to get if double should be used for multiplication.

Specified by:

useDoubleMultiplication in interface RelDataTypeFactory

createDecimalQuotient

@Deprecated
public @Nullable RelDataType createDecimalQuotient(RelDataType type1,
                                                               RelDataType type2)

Deprecated.

Delegates to RelDataTypeSystem.deriveDecimalDivideType(RelDataTypeFactory, RelDataType, RelDataType) to get the return type for the operation.

Specified by:

createDecimalQuotient in interface RelDataTypeFactory

Parameters:

type1 - type of the first operand

type2 - type of the second operand

Returns:

the result type for a decimal division, or null if decimal division should not be applied to the operands.

decimalOf

public RelDataType decimalOf(RelDataType type)

Description copied from interface: RelDataTypeFactory

Create a decimal type equivalent to the numeric type, this is related to specific system implementation, you can override this logic if it is required.

Specified by:

decimalOf in interface RelDataTypeFactory

Parameters:

type - the numeric type to create decimal type with

Returns:

decimal equivalence of the numeric type.

getDefaultCharset

public Charset getDefaultCharset()

Description copied from interface: RelDataTypeFactory

Returns the default Charset (valid if this is a string type).

Specified by:

getDefaultCharset in interface RelDataTypeFactory

builder

public RelDataTypeFactory.FieldInfoBuilder builder()

Description copied from interface: RelDataTypeFactory

Creates a RelDataTypeFactory.FieldInfoBuilder. But since FieldInfoBuilder is deprecated, we recommend that you use its base class RelDataTypeFactory.Builder, which is not deprecated.

Specified by:

builder in interface RelDataTypeFactory