Package org.apache.calcite.test.catalog

Class MockCatalogReader.MockTable

java.lang.Object

org.apache.calcite.prepare.Prepare.AbstractPreparingTable

org.apache.calcite.test.catalog.MockCatalogReader.MockTable

All Implemented Interfaces:

RelOptTable, Prepare.PreparingTable, BuiltInMetadata.MaxRowCount.Handler, MetadataHandler<BuiltInMetadata.MaxRowCount>, Wrapper, SqlValidatorTable

Direct Known Subclasses:

MockCatalogReader.MockModifiableViewRelOptTable, MockCatalogReader.MockRelViewTable, MockCatalogReader.MockViewTable, MockCatalogReader.MustFilterMockTable

Enclosing class:

MockCatalogReader

public static class MockCatalogReader.MockTable
extends Prepare.AbstractPreparingTable
implements BuiltInMetadata.MaxRowCount.Handler

Mock implementation of Prepare.PreparingTable.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.calcite.plan.RelOptTable

RelOptTable.ToRelContext, RelOptTable.ViewExpander

Field Summary

Fields

Modifier and Type	Field	Description
protected final MockCatalogReader	catalogReader
protected List<RelCollation>	collationList
protected final List<Map.Entry<String,RelDataType>>	columnList
protected final InitializerExpressionFactory	initializerFactory
protected final List<ImmutableBitSet>	keyList
protected StructKind	kind
protected final Double	maxRowCount
protected final Set<String>	monotonicColumnSet
protected final List<String>	names
protected final List<RelReferentialConstraint>	referentialConstraints
protected final @Nullable MockCatalogReader.ColumnResolver	resolver
protected final Set<String>	rolledUpColumns
protected final double	rowCount
protected RelDataType	rowType
protected final boolean	stream
protected List<Object>	wraps	Wrapped objects that can be obtained by calling unwrap(Class).

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MockTable(MockCatalogReader catalogReader, boolean stream, boolean temporal, double rowCount, List<Map.Entry<String,RelDataType>> columnList, List<ImmutableBitSet> keyList, RelDataType rowType, List<RelCollation> collationList, List<String> names, Set<String> monotonicColumnSet, StructKind kind, @Nullable MockCatalogReader.ColumnResolver resolver, InitializerExpressionFactory initializerFactory)	Copy constructor.
	MockTable(MockCatalogReader catalogReader, String catalogName, String schemaName, String name, boolean stream, boolean temporal, double rowCount, @Nullable MockCatalogReader.ColumnResolver resolver, InitializerExpressionFactory initializerFactory)
	MockTable(MockCatalogReader catalogReader, String catalogName, String schemaName, String name, boolean stream, boolean temporal, double rowCount, @Nullable MockCatalogReader.ColumnResolver resolver, InitializerExpressionFactory initializerFactory, Double maxRowCount)

Method Summary

Modifier and Type	Method	Description
void	addColumn(String name, RelDataType type)
void	addColumn(String name, RelDataType type, boolean isKey)
void	addKey(String... columns)
void	addKey(ImmutableBitSet key)
void	addMonotonic(String name)
void	addWrap(Object wrap)
static MockCatalogReader.MockTable	create(MockCatalogReader catalogReader, List<String> names, boolean stream, double rowCount)
static MockCatalogReader.MockTable	create(MockCatalogReader catalogReader, MockCatalogReader.MockSchema schema, String name, boolean stream, double rowCount)
static MockCatalogReader.MockTable	create(MockCatalogReader catalogReader, MockCatalogReader.MockSchema schema, String name, boolean stream, double rowCount, double maxRowCount)
static MockCatalogReader.MockTable	create(MockCatalogReader catalogReader, MockCatalogReader.MockSchema schema, String name, boolean stream, double rowCount, @Nullable MockCatalogReader.ColumnResolver resolver)
static MockCatalogReader.MockTable	create(MockCatalogReader catalogReader, MockCatalogReader.MockSchema schema, String name, boolean stream, double rowCount, @Nullable MockCatalogReader.ColumnResolver resolver, double maxRowCount)
static MockCatalogReader.MockTable	create(MockCatalogReader catalogReader, MockCatalogReader.MockSchema schema, String name, boolean stream, double rowCount, @Nullable MockCatalogReader.ColumnResolver resolver, InitializerExpressionFactory initializerExpressionFactory, boolean temporal)
static MockCatalogReader.MockTable	create(MockCatalogReader catalogReader, MockCatalogReader.MockSchema schema, String name, boolean stream, double rowCount, @Nullable MockCatalogReader.ColumnResolver resolver, InitializerExpressionFactory initializerExpressionFactory, boolean temporal, Double maxRowCount)
protected RelOptTable	extend(Table extendedTable)	Implementation-specific code to instantiate a new RelOptTable based on a Table that has been extended.
SqlAccessType	getAllowedAccess()	Returns the access type of the table.
List<RelCollation>	getCollationList()	Returns a description of the physical ordering (or orderings) of the rows returned from this table.
MetadataDef<BuiltInMetadata.MaxRowCount>	getDef()
RelDistribution	getDistribution()	Returns a description of the physical distribution of the rows in this table.
Expression	getExpression(Class clazz)	Generates code for this table.
List<ImmutableBitSet>	getKeys()	Returns a list of unique keys, empty list if no key exist, the result should be consistent with isKey.
StructKind	getKind()
@Nullable Double	getMaxRowCount(RelNode r, RelMetadataQuery mq)
SqlMonotonicity	getMonotonicity(String columnName)	Returns whether a given column is monotonic.
List<String>	getQualifiedName()	Obtains an identifier for this table.
List<RelReferentialConstraint>	getReferentialConstraints()	Returns the referential constraints existing for this table.
RelOptSchema	getRelOptSchema()	Returns the RelOptSchema this table belongs to.
double	getRowCount()	Returns an estimate of the number of rows in the table.
RelDataType	getRowType()	Describes the type of rows returned by this table.
boolean	isKey(ImmutableBitSet columns)	Returns whether the given columns are a key or a superset of a unique key of this table.
boolean	isTemporal()	Returns whether the table is temporal.
void	onRegister(RelDataTypeFactory typeFactory)
void	registerRolledUpColumn(String columnName)
void	setKind(StructKind kind)
boolean	supportsModality(SqlModality modality)
RelNode	toRel(RelOptTable.ToRelContext context)	Converts this table into a relational expression.
<T> T	unwrap(Class<T> clazz)	Finds an instance of an interface implemented by this object, or returns null if this object does not support that interface.

Methods inherited from class org.apache.calcite.prepare.Prepare.AbstractPreparingTable

columnHasDefaultValue, extend, getColumnStrategies

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.sql.validate.SqlValidatorTable

table

Methods inherited from interface org.apache.calcite.schema.Wrapper

maybeUnwrap, unwrapOrThrow

Field Details

catalogReader

protected final MockCatalogReader catalogReader

stream

protected final boolean stream

rowCount

protected final double rowCount

columnList

protected final List<Map.Entry<String,RelDataType>> columnList

keyList

protected final List<ImmutableBitSet> keyList

referentialConstraints

protected final List<RelReferentialConstraint> referentialConstraints

rowType

protected RelDataType rowType

collationList

protected List<RelCollation> collationList

names

protected final List<String> names

maxRowCount

protected final Double maxRowCount

monotonicColumnSet

protected final Set<String> monotonicColumnSet

kind

protected StructKind kind

resolver

protected final @Nullable MockCatalogReader.ColumnResolver resolver

initializerFactory

protected final InitializerExpressionFactory initializerFactory

rolledUpColumns

protected final Set<String> rolledUpColumns

wraps

protected List<Object> wraps

Wrapped objects that can be obtained by calling unwrap(Class). Initially an immutable list, but converted to a mutable array list on first assignment.

Constructor Details

MockTable

public MockTable(MockCatalogReader catalogReader,
 String catalogName,
 String schemaName,
 String name,
 boolean stream,
 boolean temporal,
 double rowCount,
 @Nullable MockCatalogReader.ColumnResolver resolver,
 InitializerExpressionFactory initializerFactory)

MockTable

public MockTable(MockCatalogReader catalogReader,
 String catalogName,
 String schemaName,
 String name,
 boolean stream,
 boolean temporal,
 double rowCount,
 @Nullable MockCatalogReader.ColumnResolver resolver,
 InitializerExpressionFactory initializerFactory,
 Double maxRowCount)

MockTable

protected MockTable(MockCatalogReader catalogReader,
 boolean stream,
 boolean temporal,
 double rowCount,
 List<Map.Entry<String,RelDataType>> columnList,
 List<ImmutableBitSet> keyList,
 RelDataType rowType,
 List<RelCollation> collationList,
 List<String> names,
 Set<String> monotonicColumnSet,
 StructKind kind,
 @Nullable MockCatalogReader.ColumnResolver resolver,
 InitializerExpressionFactory initializerFactory)

Copy constructor.

Method Details

registerRolledUpColumn

public void registerRolledUpColumn(String columnName)

addWrap

public void addWrap(Object wrap)

getMaxRowCount

public @Nullable Double getMaxRowCount(RelNode r,
 RelMetadataQuery mq)

Specified by:

getMaxRowCount in interface BuiltInMetadata.MaxRowCount.Handler

getDef

public MetadataDef<BuiltInMetadata.MaxRowCount> getDef()

Specified by:

getDef in interface BuiltInMetadata.MaxRowCount.Handler

Specified by:

getDef in interface MetadataHandler<BuiltInMetadata.MaxRowCount>

extend

protected RelOptTable extend(Table extendedTable)

Description copied from class: Prepare.AbstractPreparingTable

Implementation-specific code to instantiate a new RelOptTable based on a Table that has been extended.

Specified by:

extend in class Prepare.AbstractPreparingTable

create

public static MockCatalogReader.MockTable create(MockCatalogReader catalogReader,
 MockCatalogReader.MockSchema schema,
 String name,
 boolean stream,
 double rowCount)

create

public static MockCatalogReader.MockTable create(MockCatalogReader catalogReader,
 MockCatalogReader.MockSchema schema,
 String name,
 boolean stream,
 double rowCount,
 double maxRowCount)

create

public static MockCatalogReader.MockTable create(MockCatalogReader catalogReader,
 List<String> names,
 boolean stream,
 double rowCount)

create

public static MockCatalogReader.MockTable create(MockCatalogReader catalogReader,
 MockCatalogReader.MockSchema schema,
 String name,
 boolean stream,
 double rowCount,
 @Nullable MockCatalogReader.ColumnResolver resolver)

create

public static MockCatalogReader.MockTable create(MockCatalogReader catalogReader,
 MockCatalogReader.MockSchema schema,
 String name,
 boolean stream,
 double rowCount,
 @Nullable MockCatalogReader.ColumnResolver resolver,
 double maxRowCount)

create

public static MockCatalogReader.MockTable create(MockCatalogReader catalogReader,
 MockCatalogReader.MockSchema schema,
 String name,
 boolean stream,
 double rowCount,
 @Nullable MockCatalogReader.ColumnResolver resolver,
 InitializerExpressionFactory initializerExpressionFactory,
 boolean temporal,
 Double maxRowCount)

create

public static MockCatalogReader.MockTable create(MockCatalogReader catalogReader,
 MockCatalogReader.MockSchema schema,
 String name,
 boolean stream,
 double rowCount,
 @Nullable MockCatalogReader.ColumnResolver resolver,
 InitializerExpressionFactory initializerExpressionFactory,
 boolean temporal)

unwrap

public <T> T unwrap(Class<T> clazz)

Description copied from interface: Wrapper

Finds an instance of an interface implemented by this object, or returns null if this object does not support that interface.

Specified by:

unwrap in interface Wrapper

getRowCount

public double getRowCount()

Description copied from interface: RelOptTable

Returns an estimate of the number of rows in the table.

Specified by:

getRowCount in interface RelOptTable

getRelOptSchema

public RelOptSchema getRelOptSchema()

Description copied from interface: RelOptTable

Returns the RelOptSchema this table belongs to.

Specified by:

getRelOptSchema in interface RelOptTable

toRel

public RelNode toRel(RelOptTable.ToRelContext context)

Description copied from interface: RelOptTable

Converts this table into a relational expression.

The planner calls this method to convert a table into an initial relational expression, generally something abstract, such as a LogicalTableScan, then optimizes this expression by applying rules to transform it into more efficient access methods for this table.

Specified by:

toRel in interface RelOptTable

getCollationList

public List<RelCollation> getCollationList()

Description copied from interface: RelOptTable

Returns a description of the physical ordering (or orderings) of the rows returned from this table.

Specified by:

getCollationList in interface RelOptTable

See Also:

• RelMetadataQuery.collations(RelNode)

getDistribution

public RelDistribution getDistribution()

Description copied from interface: RelOptTable

Returns a description of the physical distribution of the rows in this table.

Specified by:

getDistribution in interface RelOptTable

See Also:

• RelMetadataQuery.distribution(RelNode)

isKey

public boolean isKey(ImmutableBitSet columns)

Description copied from interface: RelOptTable

Returns whether the given columns are a key or a superset of a unique key of this table.

Specified by:

isKey in interface RelOptTable

Parameters:

columns - Ordinals of key columns

Returns:

Whether the given columns are a key or a superset of a key

getKeys

public List<ImmutableBitSet> getKeys()

Description copied from interface: RelOptTable

Returns a list of unique keys, empty list if no key exist, the result should be consistent with isKey.

Specified by:

getKeys in interface RelOptTable

getReferentialConstraints

public List<RelReferentialConstraint> getReferentialConstraints()

Description copied from interface: RelOptTable

Returns the referential constraints existing for this table. These constraints are represented over other tables using RelReferentialConstraint nodes.

Specified by:

getReferentialConstraints in interface RelOptTable

getRowType

public RelDataType getRowType()

Description copied from interface: RelOptTable

Describes the type of rows returned by this table.

Specified by:

getRowType in interface RelOptTable

Specified by:

getRowType in interface SqlValidatorTable

supportsModality

public boolean supportsModality(SqlModality modality)

Specified by:

supportsModality in interface SqlValidatorTable

isTemporal

public boolean isTemporal()

Description copied from interface: SqlValidatorTable

Returns whether the table is temporal.

Specified by:

isTemporal in interface SqlValidatorTable

onRegister

public void onRegister(RelDataTypeFactory typeFactory)

getQualifiedName

public List<String> getQualifiedName()

Description copied from interface: RelOptTable

Obtains an identifier for this table. The identifier must be unique with respect to the Connection producing this table.

Specified by:

getQualifiedName in interface RelOptTable

Specified by:

getQualifiedName in interface SqlValidatorTable

Returns:

qualified name

getMonotonicity

public SqlMonotonicity getMonotonicity(String columnName)

Description copied from interface: SqlValidatorTable

Returns whether a given column is monotonic.

Specified by:

getMonotonicity in interface SqlValidatorTable

getAllowedAccess

public SqlAccessType getAllowedAccess()

Description copied from interface: SqlValidatorTable

Returns the access type of the table.

Specified by:

getAllowedAccess in interface SqlValidatorTable

getExpression

public Expression getExpression(Class clazz)

Description copied from interface: RelOptTable

Generates code for this table.

Specified by:

getExpression in interface RelOptTable

Parameters:

clazz - The desired collection class; for example Queryable.

Returns:

the code for the table, or null if code generation is not supported

addColumn

public void addColumn(String name,
 RelDataType type)

addColumn

public void addColumn(String name,
 RelDataType type,
 boolean isKey)

addKey

public void addKey(String... columns)

addKey

public void addKey(ImmutableBitSet key)

addMonotonic

public void addMonotonic(String name)

setKind

public void setKind(StructKind kind)

getKind

public StructKind getKind()