Package org.apache.calcite.rel.type

Class RelDataTypeSystemImpl

java.lang.Object

org.apache.calcite.rel.type.RelDataTypeSystemImpl

All Implemented Interfaces:

RelDataTypeSystem

public abstract class RelDataTypeSystemImpl
extends Object
implements RelDataTypeSystem

Default implementation of RelDataTypeSystem, providing parameters from the SQL standard.

To implement other type systems, create a derived class and override values as needed.

Parameter values

Parameter	Value
MAX_NUMERIC_SCALE	19
MIN_NUMERIC_SCALE	0
MAX_NUMERIC_PRECISION	19

Field Summary

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

DEFAULT

Constructor Summary

Constructors

Constructor	Description
RelDataTypeSystemImpl()

Method Summary

Modifier and Type	Method	Description
RelDataType	deriveAvgAggType(RelDataTypeFactory typeFactory, RelDataType argumentType)	Returns the return type of a call to the AVG, STDDEV or VAR aggregate functions, inferred from its argument type.
RelDataType	deriveCovarType(RelDataTypeFactory typeFactory, RelDataType arg0Type, RelDataType arg1Type)	Returns the return type of a call to the COVAR aggregate function, inferred from its argument types.
RelDataType	deriveFractionalRankType(RelDataTypeFactory typeFactory)	Returns the return type of the CUME_DIST and PERCENT_RANK aggregate functions.
RelDataType	deriveRankType(RelDataTypeFactory typeFactory)	Returns the return type of the NTILE, RANK, DENSE_RANK, and ROW_NUMBER aggregate functions.
RelDataType	deriveSumType(RelDataTypeFactory typeFactory, RelDataType argumentType)	Returns the return type of a call to the SUM aggregate function, inferred from its argument type.
int	getDefaultPrecision(SqlTypeName typeName)	Returns default precision for this type if supported, otherwise RelDataType.PRECISION_NOT_SPECIFIED if precision is either unsupported or must be specified explicitly.
int	getDefaultScale(SqlTypeName typeName)	Returns the default scale for this type if supported, otherwise RelDataType.SCALE_NOT_SPECIFIED if scale is either unsupported or must be specified explicitly.
@Nullable String	getLiteral(SqlTypeName typeName, boolean isPrefix)	Returns the LITERAL string for the type, either PREFIX/SUFFIX.
int	getMaxNumericPrecision()	Returns the maximum precision of a NUMERIC or DECIMAL type.
int	getMaxNumericScale()	Returns the maximum scale of a NUMERIC or DECIMAL type.
int	getMaxPrecision(SqlTypeName typeName)	Returns the maximum precision (or length) allowed for this type, or RelDataType.PRECISION_NOT_SPECIFIED if precision/length are not applicable for this type.
int	getMaxScale(SqlTypeName typeName)	Returns the maximum scale allowed for this type, or RelDataType.SCALE_NOT_SPECIFIED if scale is not applicable for this type.
int	getMinPrecision(SqlTypeName typeName)	Returns the minimum precision (or length) allowed for this type, or RelDataType.PRECISION_NOT_SPECIFIED if precision/length are not applicable for this type.
int	getMinScale(SqlTypeName typeName)	Returns the minimum scale (or fractional second precision in the case of intervals) allowed for this type, or RelDataType.SCALE_NOT_SPECIFIED if precision/length are not applicable for this type.
int	getNumTypeRadix(SqlTypeName typeName)	Returns the numeric type radix, typically 2 or 10.
boolean	isAutoincrement(SqlTypeName typeName)	Returns whether the type can be auto increment.
boolean	isCaseSensitive(SqlTypeName typeName)	Returns whether the type is case sensitive.
boolean	isSchemaCaseSensitive()	Whether two record types are considered distinct if their field names are the same but in different cases.
RoundingMode	roundingMode()	Returns the rounding behavior for numerical operations capable of discarding precision.
boolean	shouldConvertRaggedUnionTypesToVarying()	Whether the least restrictive type of a number of CHAR types of different lengths should be a VARCHAR type.

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.RelDataTypeSystem

deriveDecimalDivideType, deriveDecimalModType, deriveDecimalMultiplyType, deriveDecimalPlusType, deriveTimeFrameSet, shouldUseDoubleMultiplication

Constructor Details

RelDataTypeSystemImpl

public RelDataTypeSystemImpl()

Method Details

getMaxScale

public int getMaxScale(SqlTypeName typeName)

Description copied from interface: RelDataTypeSystem

Returns the maximum scale allowed for this type, or RelDataType.SCALE_NOT_SPECIFIED if scale is not applicable for this type.

Specified by:

getMaxScale in interface RelDataTypeSystem

Returns:

Maximum allowed scale

getMinScale

public int getMinScale(SqlTypeName typeName)

Returns the minimum scale (or fractional second precision in the case of intervals) allowed for this type, or RelDataType.SCALE_NOT_SPECIFIED if precision/length are not applicable for this type.

Specified by:

getMinScale in interface RelDataTypeSystem

Returns:

Minimum allowed scale

getDefaultPrecision

public int getDefaultPrecision(SqlTypeName typeName)

Description copied from interface: RelDataTypeSystem

Returns default precision for this type if supported, otherwise RelDataType.PRECISION_NOT_SPECIFIED if precision is either unsupported or must be specified explicitly.

Specified by:

getDefaultPrecision in interface RelDataTypeSystem

Returns:

Default precision

getDefaultScale

public int getDefaultScale(SqlTypeName typeName)

Returns the default scale for this type if supported, otherwise RelDataType.SCALE_NOT_SPECIFIED if scale is either unsupported or must be specified explicitly.

Specified by:

getDefaultScale in interface RelDataTypeSystem

Returns:

Default scale

getMaxPrecision

public int getMaxPrecision(SqlTypeName typeName)

Description copied from interface: RelDataTypeSystem

Returns the maximum precision (or length) allowed for this type, or RelDataType.PRECISION_NOT_SPECIFIED if precision/length are not applicable for this type.

Specified by:

getMaxPrecision in interface RelDataTypeSystem

Returns:

Maximum allowed precision

getMinPrecision

public int getMinPrecision(SqlTypeName typeName)

Returns the minimum precision (or length) allowed for this type, or RelDataType.PRECISION_NOT_SPECIFIED if precision/length are not applicable for this type.

Specified by:

getMinPrecision in interface RelDataTypeSystem

Returns:

Minimum allowed precision

getMaxNumericScale

public int getMaxNumericScale()

Description copied from interface: RelDataTypeSystem

Returns the maximum scale of a NUMERIC or DECIMAL type. Default value is 19.

Specified by:

getMaxNumericScale in interface RelDataTypeSystem

getMaxNumericPrecision

public int getMaxNumericPrecision()

Description copied from interface: RelDataTypeSystem

Returns the maximum precision of a NUMERIC or DECIMAL type. Default value is 19.

Specified by:

getMaxNumericPrecision in interface RelDataTypeSystem

roundingMode

public RoundingMode roundingMode()

Description copied from interface: RelDataTypeSystem

Returns the rounding behavior for numerical operations capable of discarding precision.

Specified by:

roundingMode in interface RelDataTypeSystem

getLiteral

public @Nullable String getLiteral(SqlTypeName typeName,
 boolean isPrefix)

Description copied from interface: RelDataTypeSystem

Returns the LITERAL string for the type, either PREFIX/SUFFIX.

Specified by:

getLiteral in interface RelDataTypeSystem

isCaseSensitive

public boolean isCaseSensitive(SqlTypeName typeName)

Description copied from interface: RelDataTypeSystem

Returns whether the type is case sensitive.

Specified by:

isCaseSensitive in interface RelDataTypeSystem

isAutoincrement

public boolean isAutoincrement(SqlTypeName typeName)

Description copied from interface: RelDataTypeSystem

Returns whether the type can be auto increment.

Specified by:

isAutoincrement in interface RelDataTypeSystem

getNumTypeRadix

public int getNumTypeRadix(SqlTypeName typeName)

Description copied from interface: RelDataTypeSystem

Returns the numeric type radix, typically 2 or 10. 0 means "not applicable".

Specified by:

getNumTypeRadix in interface RelDataTypeSystem

deriveSumType

public RelDataType deriveSumType(RelDataTypeFactory typeFactory,
 RelDataType argumentType)

Description copied from interface: RelDataTypeSystem

Returns the return type of a call to the SUM aggregate function, inferred from its argument type.

Specified by:

deriveSumType in interface RelDataTypeSystem

deriveAvgAggType

public RelDataType deriveAvgAggType(RelDataTypeFactory typeFactory,
 RelDataType argumentType)

Description copied from interface: RelDataTypeSystem

Returns the return type of a call to the AVG, STDDEV or VAR aggregate functions, inferred from its argument type.

Specified by:

deriveAvgAggType in interface RelDataTypeSystem

deriveCovarType

public RelDataType deriveCovarType(RelDataTypeFactory typeFactory,
 RelDataType arg0Type,
 RelDataType arg1Type)

Description copied from interface: RelDataTypeSystem

Returns the return type of a call to the COVAR aggregate function, inferred from its argument types.

Specified by:

deriveCovarType in interface RelDataTypeSystem

deriveFractionalRankType

public RelDataType deriveFractionalRankType(RelDataTypeFactory typeFactory)

Description copied from interface: RelDataTypeSystem

Returns the return type of the CUME_DIST and PERCENT_RANK aggregate functions.

Specified by:

deriveFractionalRankType in interface RelDataTypeSystem

deriveRankType

public RelDataType deriveRankType(RelDataTypeFactory typeFactory)

Description copied from interface: RelDataTypeSystem

Returns the return type of the NTILE, RANK, DENSE_RANK, and ROW_NUMBER aggregate functions.

Specified by:

deriveRankType in interface RelDataTypeSystem

isSchemaCaseSensitive

public boolean isSchemaCaseSensitive()

Description copied from interface: RelDataTypeSystem

Whether two record types are considered distinct if their field names are the same but in different cases.

Specified by:

isSchemaCaseSensitive in interface RelDataTypeSystem

shouldConvertRaggedUnionTypesToVarying

public boolean shouldConvertRaggedUnionTypesToVarying()

Description copied from interface: RelDataTypeSystem

Whether the least restrictive type of a number of CHAR types of different lengths should be a VARCHAR type. And similarly BINARY to VARBINARY.

Specified by:

shouldConvertRaggedUnionTypesToVarying in interface RelDataTypeSystem