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.
private static class	RelDataTypeFactoryImpl.Key Key to the data type cache.

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
private static com.google.common.cache.LoadingCache<Object,RelDataType>	CACHE Global cache.
private static Map<Class,RelDataTypeFamily>	CLASS_FAMILIES
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
private static void	addFields(RelDataType type, List<RelDataTypeField> fieldList) Adds all fields in type to fieldList, renumbering the fields (if necessary) to ensure that their index matches their position in the list.
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) Looks up a type using a temporary key, and if not present, creates a permanent key and type.
private RelDataType	copyRecordType(RelRecordType type, boolean ignoreNullable, boolean nullable)
private RelDataType	copySimpleType(RelDataType type, boolean nullable)
RelDataType	copyType(RelDataType type) Duplicates a type, making a deep copy.
RelDataType	createDecimalProduct(RelDataType type1, RelDataType type2) Infers the return type of a decimal multiplication.
RelDataType	createDecimalQuotient(RelDataType type1, RelDataType type2) Rules: Let p1, s1 be the precision and scale of the first operand Let p2, s2 be the precision and scale of the second operand Let p, s be the precision and scale of the result Let d be the number of whole digits in the result Then the result type is a decimal with: d = p1 - s1 + s2 s < max(6, s1 + p2 + 1) p = d + s p and s are capped at their maximum values
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.
private List<RelDataTypeFieldImpl>	fieldsOf(Class clazz)
Charset	getDefaultCharset()
private static List<RelDataTypeField>	getFieldList(List<RelDataType> types) Returns a list of the fields in a list of types.
private static void	getTypeList(com.google.common.collect.ImmutableList<RelDataType> inTypes, List<RelDataType> flatTypes) Returns a list of all atomic types in a list.
RelDataTypeSystem	getTypeSystem() Returns the type system.
static boolean	isJavaType(RelDataType t)
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 RelDataType	leastRestrictiveStructuredType(List<RelDataType> types)
boolean	useDoubleMultiplication(RelDataType type1, RelDataType type2) Returns whether a decimal multiplication should be implemented by casting arguments to double values.

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

CACHE

private static final com.google.common.cache.LoadingCache<Object,RelDataType> CACHE

Global cache. Uses soft values to allow GC.

CLASS_FAMILIES

private static final Map<Class,RelDataTypeFamily> CLASS_FAMILIES

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 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 RelDataType leastRestrictiveStructuredType(List<RelDataType> types)

copySimpleType

private RelDataType copySimpleType(RelDataType type,
                                   boolean nullable)

copyRecordType

private RelDataType copyRecordType(RelRecordType type,
                                   boolean ignoreNullable,
                                   boolean nullable)

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)

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.

getFieldList

private static List<RelDataTypeField> getFieldList(List<RelDataType> types)

Returns a list of the fields in a list of types.

getTypeList

private static void getTypeList(com.google.common.collect.ImmutableList<RelDataType> inTypes,
                                List<RelDataType> flatTypes)

Returns a list of all atomic types in a list.

addFields

private static void addFields(RelDataType type,
                              List<RelDataTypeField> fieldList)

Adds all fields in type to fieldList, renumbering the fields (if necessary) to ensure that their index matches their position in the list.

isJavaType

public static boolean isJavaType(RelDataType t)

fieldsOf

private List<RelDataTypeFieldImpl> fieldsOf(Class clazz)

createDecimalProduct

public RelDataType createDecimalProduct(RelDataType type1,
                                        RelDataType type2)

Infers the return type of a decimal multiplication. Decimal multiplication involves at least one decimal operand and requires both operands to have exact numeric types.

Implement RelDataTypeFactory with SQL 2003 compliant behavior. Let p1, s1 be the precision and scale of the first operand Let p2, s2 be the precision and scale of the second operand Let p, s be the precision and scale of the result, Then the result type is a decimal with:

• p = p1 + p2
• s = s1 + s2

p and s are capped at their maximum values

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.

See Also:

SQL:2003 Part 2 Section 6.26

useDoubleMultiplication

public boolean useDoubleMultiplication(RelDataType type1,
                                       RelDataType type2)

Description copied from interface: RelDataTypeFactory

Returns whether a decimal multiplication should be implemented by casting arguments to double values.

Pre-condition: createDecimalProduct(type1, type2) != null

Specified by:

useDoubleMultiplication in interface RelDataTypeFactory

createDecimalQuotient

public RelDataType createDecimalQuotient(RelDataType type1,
                                         RelDataType type2)

Rules:

• Let p1, s1 be the precision and scale of the first operand
• Let p2, s2 be the precision and scale of the second operand
• Let p, s be the precision and scale of the result
• Let d be the number of whole digits in the result
• Then the result type is a decimal with:
  • d = p1 - s1 + s2
  • s < max(6, s1 + p2 + 1)
  • p = d + s
• p and s are capped at their maximum values

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.

See Also:

SQL:2003 Part 2 Section 6.26

getDefaultCharset

public Charset getDefaultCharset()

Specified by:

getDefaultCharset in interface RelDataTypeFactory

Returns:

the default Charset for string types

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