org.apache.calcite.rel.type

Class RelDataTypeImpl

java.lang.Object

org.apache.calcite.rel.type.RelDataTypeImpl

All Implemented Interfaces:

RelDataType, RelDataTypeFamily

Direct Known Subclasses:

AbstractSqlType, DynamicRecordType, RelCrossType, RelDataTypeFactoryImpl.JavaType, RelRecordType

public abstract class RelDataTypeImpl
extends Object
implements RelDataType, RelDataTypeFamily

RelDataTypeImpl is an abstract base for implementations of RelDataType.

Identity is based upon the digest field, which each derived class should set during construction.

Field Summary

Fields

Modifier and Type	Field and Description
protected @Nullable String	digest
protected @Nullable List<RelDataTypeField>	fieldList
static String	NON_NULLABLE_SUFFIX Suffix for the digests of non-nullable types.

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

PRECISION_NOT_SPECIFIED, SCALE_NOT_SPECIFIED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RelDataTypeImpl() Default constructor, to allow derived classes such as BasicSqlType to be Serializable.
protected	RelDataTypeImpl(@Nullable List<? extends RelDataTypeField> fieldList) Creates a RelDataTypeImpl.

Method Summary

Modifier and Type	Method and Description
protected void	computeDigest() Computes the digest field.
boolean	equals(@Nullable Object obj)
static @Nullable RelDataTypeField	extra(RelDataType rowType) Returns the "extra" field in a row type whose presence signals that fields will come into existence just by asking for them.
protected abstract 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.
RelDataTypeComparability	getComparability() Returns the category of comparison operators that make sense when applied to values of this type.
@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.
@Nullable RelDataTypeField	getField(String fieldName, boolean caseSensitive, boolean elideRecord) Looks up a field by name.
int	getFieldCount() Returns the number of fields in a struct type.
List<RelDataTypeField>	getFieldList() Gets the fields in a struct type.
protected @Nullable Map<String,RelDataTypeField>	getFieldMap() Returns a map from field names to fields.
List<String>	getFieldNames() Returns the names of the fields in a struct type.
String	getFullTypeString() Gets a string representation of this type with full detail such as character set and nullability.
@Nullable SqlIntervalQualifier	getIntervalQualifier() Gets this type's interval qualifier, or null if this is not an interval type.
@Nullable RelDataType	getKeyType() Gets the key type if this type is a map, otherwise null.
RelDataTypePrecedenceList	getPrecedenceList() Returns the precedence list for this type.
int	getPrecision() Gets the JDBC-defined precision for values of this type.
int	getScale() Gets the scale of this type.
@Nullable SqlIdentifier	getSqlIdentifier() Gets the SqlIdentifier associated with this type.
SqlTypeName	getSqlTypeName() Gets the SqlTypeName of this type.
StructKind	getStructKind() Returns the rule for resolving the fields of a structured type, or StructKind.NONE if this is not a structured type.
@Nullable RelDataType	getValueType() Gets the value type if this type is a map, otherwise null.
int	hashCode()
boolean	isDynamicStruct() Returns whether this type has dynamic structure (for "schema-on-read" table).
boolean	isNullable() Queries whether this type allows null values.
boolean	isStruct() Queries whether this is a structured type.
static RelProtoDataType	proto(RelDataType protoType) Returns an implementation of RelProtoDataType that copies a given type using the given type factory.
static RelProtoDataType	proto(SqlTypeName typeName, boolean nullable) Returns a RelProtoDataType that will create a type typeName.
static RelProtoDataType	proto(SqlTypeName typeName, int precision, boolean nullable) Returns a RelProtoDataType that will create a type typeName(precision).
static RelProtoDataType	proto(SqlTypeName typeName, int precision, int scale, boolean nullable) Returns a RelProtoDataType that will create a type typeName(precision, scale).
String	toString() Gets a string representation of this type without detail such as character set and nullability.

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

Field Detail

NON_NULLABLE_SUFFIX

public static final String NON_NULLABLE_SUFFIX

Suffix for the digests of non-nullable types.

See Also:

Constant Field Values

fieldList

protected final @Nullable List<RelDataTypeField> fieldList

digest

protected @Nullable String digest

Constructor Detail

RelDataTypeImpl

protected RelDataTypeImpl(@Nullable List<? extends RelDataTypeField> fieldList)

Creates a RelDataTypeImpl.

Parameters:

fieldList - List of fields

RelDataTypeImpl

protected RelDataTypeImpl()

Default constructor, to allow derived classes such as BasicSqlType to be Serializable.

(The serialization specification says that a class can be serializable even if its base class is not serializable, provided that the base class has a public or protected zero-args constructor.)

Method Detail

getField

public @Nullable RelDataTypeField getField(String fieldName,
                                           boolean caseSensitive,
                                           boolean elideRecord)

Description copied from interface: RelDataType

Looks up a field by name.

NOTE: Be careful choosing the value of caseSensitive:

• If the field name was supplied by an end-user (e.g. as a column alias in SQL), use your session's case-sensitivity setting.
• Only hard-code true if you are sure that the field name is internally generated.
• Hard-coding false is almost certainly wrong.

Specified by:

getField in interface RelDataType

Parameters:

fieldName - Name of field to find

caseSensitive - Whether match is case-sensitive

elideRecord - Whether to find fields nested within records

Returns:

named field, or null if not found

getFieldMap

protected @Nullable Map<String,RelDataTypeField> getFieldMap()

Returns a map from field names to fields.

Matching is case-sensitive.

If several fields have the same name, the map contains the first.

A dynamic star field is indexed under its own name and "" (the empty string).

If the map is null, the type must do lookup the long way.

getFieldList

public List<RelDataTypeField> getFieldList()

Description copied from interface: RelDataType

Gets the fields in a struct type. The field count is equal to the size of the returned list.

Specified by:

getFieldList in interface RelDataType

Returns:

read-only list of fields

getFieldNames

public List<String> getFieldNames()

Description copied from interface: RelDataType

Returns the names of the fields in a struct type. The field count is equal to the size of the returned list.

Specified by:

getFieldNames in interface RelDataType

Returns:

read-only list of field names

getFieldCount

public int getFieldCount()

Description copied from interface: RelDataType

Returns the number of fields in a struct type.

This method is equivalent to RelDataType.getFieldList().size().

Specified by:

getFieldCount in interface RelDataType

getStructKind

public StructKind getStructKind()

Description copied from interface: RelDataType

Returns the rule for resolving the fields of a structured type, or StructKind.NONE if this is not a structured type.

Specified by:

getStructKind in interface RelDataType

Returns:

the StructKind that determines how this type's fields are resolved

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

Returns:

canonical type descriptor for components

getKeyType

public @Nullable RelDataType getKeyType()

Description copied from interface: RelDataType

Gets the key type if this type is a map, otherwise null.

Specified by:

getKeyType in interface RelDataType

Returns:

canonical type descriptor for key

getValueType

public @Nullable RelDataType getValueType()

Description copied from interface: RelDataType

Gets the value type if this type is a map, otherwise null.

Specified by:

getValueType in interface RelDataType

Returns:

canonical type descriptor for value

isStruct

public boolean isStruct()

Description copied from interface: RelDataType

Queries whether this is a structured type.

Specified by:

isStruct in interface RelDataType

Returns:

whether this type has fields; examples include rows and user-defined structured types in SQL, and classes in Java

equals

public boolean equals(@Nullable Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getFullTypeString

public String getFullTypeString()

Description copied from interface: RelDataType

Gets a string representation of this type with full detail such as character set and nullability. The string must serve as a "digest" for this type, meaning two types can be considered identical iff their digests are equal.

Specified by:

getFullTypeString in interface RelDataType

Returns:

full type string

isNullable

public boolean isNullable()

Description copied from interface: RelDataType

Queries whether this type allows null values.

Specified by:

isNullable in interface RelDataType

Returns:

whether type allows null values

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

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

Returns:

collation of type

getIntervalQualifier

public @Nullable SqlIntervalQualifier getIntervalQualifier()

Description copied from interface: RelDataType

Gets this type's interval qualifier, or null if this is not an interval type.

Specified by:

getIntervalQualifier in interface RelDataType

Returns:

interval qualifier

getPrecision

public int getPrecision()

Description copied from interface: RelDataType

Gets the JDBC-defined precision for values of this type. Note that this is not always the same as the user-specified precision. For example, the type INTEGER has no user-specified precision, but this method returns 10 for an INTEGER type.

Returns RelDataType.PRECISION_NOT_SPECIFIED (-1) if precision is not applicable for this type.

Specified by:

getPrecision in interface RelDataType

Returns:

number of decimal digits for exact numeric types; number of decimal digits in mantissa for approximate numeric types; number of decimal digits for fractional seconds of datetime types; length in characters for character types; length in bytes for binary types; length in bits for bit types; 1 for BOOLEAN; -1 if precision is not valid for this type

getScale

public int getScale()

Description copied from interface: RelDataType

Gets the scale of this type. Returns RelDataType.SCALE_NOT_SPECIFIED (-1) if scale is not valid for this type.

Specified by:

getScale in interface RelDataType

Returns:

number of digits of scale

getSqlTypeName

public SqlTypeName getSqlTypeName()

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

Returns:

SqlTypeName, never null

getSqlIdentifier

public @Nullable SqlIdentifier getSqlIdentifier()

Description copied from interface: RelDataType

Gets the SqlIdentifier associated with this type. For a predefined type, this is a simple identifier based on RelDataType.getSqlTypeName(). For a user-defined type, this is a compound identifier which uniquely names the type.

Specified by:

getSqlIdentifier in interface RelDataType

Returns:

SqlIdentifier, or null if this is not an SQL type

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

Returns:

canonical object representing type family, never null

generateTypeString

protected abstract void generateTypeString(StringBuilder sb,
                                           boolean withDetail)

Generates a string representation of this type.

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;

computeDigest

protected void computeDigest(@UnknownInitialization RelDataTypeImpl this)

Computes the digest field. This should be called in every non-abstract subclass constructor once the type is fully defined.

toString

public String toString()

Description copied from interface: RelDataType

Gets a string representation of this type without detail such as character set and nullability.

Specified by:

toString in interface RelDataType

Overrides:

toString in class Object

Returns:

abbreviated type string

getPrecedenceList

public RelDataTypePrecedenceList getPrecedenceList()

Description copied from interface: RelDataType

Returns the precedence list for this type.

Specified by:

getPrecedenceList in interface RelDataType

getComparability

public RelDataTypeComparability getComparability()

Description copied from interface: RelDataType

Returns the category of comparison operators that make sense when applied to values of this type.

Specified by:

getComparability in interface RelDataType

proto

public static RelProtoDataType proto(RelDataType protoType)

Returns an implementation of RelProtoDataType that copies a given type using the given type factory.

proto

public static RelProtoDataType proto(SqlTypeName typeName,
                                     boolean nullable)

Returns a RelProtoDataType that will create a type typeName.

For example, proto(SqlTypeName.DATE), false will create DATE NOT NULL.

Parameters:

typeName - Type name

nullable - Whether nullable

Returns:

Proto data type

proto

public static RelProtoDataType proto(SqlTypeName typeName,
                                     int precision,
                                     boolean nullable)

Returns a RelProtoDataType that will create a type typeName(precision).

For example, proto(SqlTypeName.VARCHAR, 100, false) will create VARCHAR(100) NOT NULL.

Parameters:

typeName - Type name

precision - Precision

nullable - Whether nullable

Returns:

Proto data type

proto

public static RelProtoDataType proto(SqlTypeName typeName,
                                     int precision,
                                     int scale,
                                     boolean nullable)

Returns a RelProtoDataType that will create a type typeName(precision, scale).

For example, proto(SqlTypeName.DECIMAL, 7, 2, false) will create DECIMAL(7, 2) NOT NULL.

Parameters:

typeName - Type name

precision - Precision

scale - Scale

nullable - Whether nullable

Returns:

Proto data type

extra

public static @Nullable RelDataTypeField extra(RelDataType rowType)

Returns the "extra" field in a row type whose presence signals that fields will come into existence just by asking for them.

Parameters:

rowType - Row type

Returns:

The "extra" field, or null

isDynamicStruct

public boolean isDynamicStruct()

Description copied from interface: RelDataType

Returns whether this type has dynamic structure (for "schema-on-read" table).

Specified by:

isDynamicStruct in interface RelDataType