Package org.apache.calcite.rel.type

Class RelDataTypeFactoryImpl.JavaType

java.lang.Object

org.apache.calcite.rel.type.RelDataTypeImpl

org.apache.calcite.rel.type.RelDataTypeFactoryImpl.JavaType

All Implemented Interfaces:

RelDataType, RelDataTypeFamily

Enclosing class:

RelDataTypeFactoryImpl

public class RelDataTypeFactoryImpl.JavaType
extends RelDataTypeImpl

Type which is based upon a Java class.

Field Summary

Fields inherited from class org.apache.calcite.rel.type.RelDataTypeImpl

digest, fieldList, NON_NULLABLE_SUFFIX

Fields inherited from interface org.apache.calcite.rel.type.RelDataType

PRECISION_NOT_SPECIFIED, SCALE_NOT_SPECIFIED

Constructor Summary

Constructors

Constructor	Description
JavaType(Class clazz)
JavaType(Class clazz, boolean nullable)
JavaType(Class clazz, boolean nullable, @Nullable Charset charset, @Nullable SqlCollation collation)

Method Summary

Modifier and Type	Method	Description
protected void	generateTypeString(StringBuilder sb, boolean withDetail)	Generates a string representation of this type.
@Nullable Charset	getCharset()	Gets this type's character set, or null if this type cannot carry a character set or has no character set defined.
@Nullable SqlCollation	getCollation()	Gets this type's collation, or null if this type cannot carry a collation or has no collation defined.
@Nullable RelDataType	getComponentType()	Gets the component type if this type is a collection, otherwise null.
RelDataTypeFamily	getFamily()	Gets a canonical object representing the family of this type.
Class	getJavaClass()
@Nullable RelDataType	getKeyType()	For RelDataTypeFactoryImpl.JavaType created with Map class, we cannot get the key type.
SqlTypeName	getSqlTypeName()	Gets the SqlTypeName of this type.
@Nullable RelDataType	getValueType()	For RelDataTypeFactoryImpl.JavaType created with Map class, we cannot get the value type.
boolean	isNullable()	Queries whether this type allows null values.

Methods inherited from class org.apache.calcite.rel.type.RelDataTypeImpl

computeDigest, equals, extra, getComparability, getField, getFieldCount, getFieldList, getFieldMap, getFieldNames, getFullTypeString, getIntervalQualifier, getPrecedenceList, getPrecision, getScale, getSqlIdentifier, getStructKind, hashCode, isDynamicStruct, isStruct, proto, proto, proto, proto, toString

Methods inherited from class java.lang.Object

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

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

equalsSansFieldNames, getMeasureElementType

Constructor Details

JavaType

public JavaType(Class clazz)

JavaType

public JavaType(Class clazz,
 boolean nullable)

JavaType

public JavaType(Class clazz,
 boolean nullable,
 @Nullable Charset charset,
 @Nullable SqlCollation collation)

Method Details

getJavaClass

public Class getJavaClass()

isNullable

public boolean isNullable()

Description copied from interface: RelDataType

Queries whether this type allows null values.

Specified by:

isNullable in interface RelDataType

Overrides:

isNullable in class RelDataTypeImpl

Returns:

whether type allows null values

getFamily

public RelDataTypeFamily getFamily()

Description copied from interface: RelDataType

Gets a canonical object representing the family of this type. Two values can be compared if and only if their types are in the same family.

Specified by:

getFamily in interface RelDataType

Overrides:

getFamily in class RelDataTypeImpl

Returns:

canonical object representing type family, never null

generateTypeString

protected void generateTypeString(StringBuilder sb,
 boolean withDetail)

Description copied from class: RelDataTypeImpl

Generates a string representation of this type.

Specified by:

generateTypeString in class RelDataTypeImpl

Parameters:

sb - StringBuilder into which to generate the string

withDetail - when true, all detail information needed to compute a unique digest (and return from getFullTypeString) should be included;

getComponentType

public @Nullable RelDataType getComponentType()

Description copied from interface: RelDataType

Gets the component type if this type is a collection, otherwise null.

Specified by:

getComponentType in interface RelDataType

Overrides:

getComponentType in class RelDataTypeImpl

Returns:

canonical type descriptor for components

getKeyType

public @Nullable RelDataType getKeyType()

For RelDataTypeFactoryImpl.JavaType created with Map class, we cannot get the key type. Use ANY as key type.

Specified by:

getKeyType in interface RelDataType

Overrides:

getKeyType in class RelDataTypeImpl

Returns:

canonical type descriptor for key

getValueType

public @Nullable RelDataType getValueType()

For RelDataTypeFactoryImpl.JavaType created with Map class, we cannot get the value type. Use ANY as value type.

Specified by:

getValueType in interface RelDataType

Overrides:

getValueType in class RelDataTypeImpl

Returns:

canonical type descriptor for value

getCharset

public @Nullable Charset getCharset()

Description copied from interface: RelDataType

Gets this type's character set, or null if this type cannot carry a character set or has no character set defined.

Specified by:

getCharset in interface RelDataType

Overrides:

getCharset in class RelDataTypeImpl

Returns:

charset of type

getCollation

public @Nullable SqlCollation getCollation()

Description copied from interface: RelDataType

Gets this type's collation, or null if this type cannot carry a collation or has no collation defined.

Specified by:

getCollation in interface RelDataType

Overrides:

getCollation in class RelDataTypeImpl

Returns:

collation of type

getSqlTypeName

public SqlTypeName getSqlTypeName()

Description copied from class: RelDataTypeImpl

Gets the SqlTypeName of this type. Sub-classes must override the method to ensure the resulting value is non-nullable.

Specified by:

getSqlTypeName in interface RelDataType

Overrides:

getSqlTypeName in class RelDataTypeImpl

Returns:

SqlTypeName, never null