org.apache.calcite.rel.type

Interface RelDataTypeField

All Superinterfaces:

Map.Entry<String,RelDataType>

All Known Implementing Classes:

RelDataTypeFieldImpl

public interface RelDataTypeField
extends Map.Entry<String,RelDataType>

RelDataTypeField represents the definition of a field in a structured RelDataType.

Extends the Map.Entry interface to allow convenient inter-operation with Java collections classes. In any implementation of this interface, Map.Entry.getKey() must be equivalent to getName() and Map.Entry.getValue() must be equivalent to getType().

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RelDataTypeField.ToFieldIndex Deprecated. Use RelDataTypeField::getIndex
static class	RelDataTypeField.ToFieldName Deprecated. Use RelDataTypeField::getName

Method Summary

Modifier and Type	Method and Description
int	getIndex() Gets the ordinal of this field within its containing type.
String	getName() Gets the name of this field, which is unique within its containing type.
RelDataType	getType() Gets the type of this field.
boolean	isDynamicStar() Returns true if this is a dynamic star field.

Methods inherited from interface java.util.Map.Entry

comparingByKey, comparingByKey, comparingByValue, comparingByValue, equals, getKey, getValue, hashCode, setValue

Method Detail

getName

String getName()

Gets the name of this field, which is unique within its containing type.

Returns:

field name

getIndex

int getIndex()

Gets the ordinal of this field within its containing type.

Returns:

0-based ordinal

getType

RelDataType getType()

Gets the type of this field.

Returns:

field type

isDynamicStar

boolean isDynamicStar()

Returns true if this is a dynamic star field.