org.apache.calcite.prepare

Class CalciteCatalogReader

java.lang.Object

org.apache.calcite.prepare.CalciteCatalogReader

All Implemented Interfaces:

RelOptSchema, Prepare.CatalogReader, SqlOperatorTable, SqlValidatorCatalogReader

public class CalciteCatalogReader
extends Object
implements Prepare.CatalogReader, SqlOperatorTable

Implementation of Prepare.CatalogReader and also SqlOperatorTable based on tables and functions defined schemas.

Constructor Summary

Constructors

Constructor and Description
CalciteCatalogReader(CalciteSchema rootSchema, boolean caseSensitive, List<String> defaultSchema, JavaTypeFactory typeFactory)

Method Summary

Methods

Modifier and Type	Method and Description
RelDataType	createTypeFromProjection(RelDataType type, List<String> columnNameList)
RelDataTypeField	field(RelDataType rowType, String alias) Finds a field with a given name, using the case-sensitivity of the current session.
int	fieldOrdinal(RelDataType rowType, String alias) Finds the ordinal of a field with a given name, using the case-sensitivity of the current session.
List<SqlMoniker>	getAllSchemaObjectNames(List<String> names) Given fully qualified schema name, returns schema object names as specified.
RelDataType	getNamedType(SqlIdentifier typeName) Finds a user-defined type with the given name, possibly qualified.
List<SqlOperator>	getOperatorList() Retrieves a list of all functions and operators in this table.
List<String>	getSchemaName() Returns the name of the current schema.
RelOptTableImpl	getTable(List<String> names) Finds a table with the given name, possibly qualified.
RelOptTableImpl	getTableForMember(List<String> names) Retrieves a RelOptTable based upon a member access.
RelDataTypeFactory	getTypeFactory() Returns the type factory used to generate types for this schema.
void	lookupOperatorOverloads(SqlIdentifier opName, SqlFunctionCategory category, SqlSyntax syntax, List<SqlOperator> operatorList) Retrieves a list of operators with a given name and syntax.
int	match(List<String> strings, String name)
boolean	matches(String string, String name)
void	registerRules(RelOptPlanner planner) Registers all of the rules supported by this schema.
CalciteCatalogReader	withSchemaPath(List<String> schemaPath) Returns a catalog reader the same as this one but with a possibly different schema path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CalciteCatalogReader

public CalciteCatalogReader(CalciteSchema rootSchema,
                    boolean caseSensitive,
                    List<String> defaultSchema,
                    JavaTypeFactory typeFactory)

Method Detail

withSchemaPath

public CalciteCatalogReader withSchemaPath(List<String> schemaPath)

Description copied from interface: Prepare.CatalogReader

Returns a catalog reader the same as this one but with a possibly different schema path.

Specified by:

withSchemaPath in interface Prepare.CatalogReader

getTable

public RelOptTableImpl getTable(List<String> names)

Description copied from interface: SqlValidatorCatalogReader

Finds a table with the given name, possibly qualified.

Specified by:

getTable in interface Prepare.CatalogReader

Specified by:

getTable in interface SqlValidatorCatalogReader

Parameters:

names - Qualified name of table

Returns:

named table, or null if not found

getNamedType

public RelDataType getNamedType(SqlIdentifier typeName)

Description copied from interface: SqlValidatorCatalogReader

Finds a user-defined type with the given name, possibly qualified.

NOTE jvs 12-Feb-2005: the reason this method is defined here instead of on RelDataTypeFactory is that it has to take into account context-dependent information such as SQL schema path, whereas a type factory is context-independent.

Specified by:

getNamedType in interface SqlValidatorCatalogReader

Parameters:

typeName - Name of type

Returns:

named type, or null if not found

getAllSchemaObjectNames

public List<SqlMoniker> getAllSchemaObjectNames(List<String> names)

Description copied from interface: SqlValidatorCatalogReader

Given fully qualified schema name, returns schema object names as specified. They can be schema, table, function, view. When names array is empty, the contents of root schema should be returned.

Specified by:

getAllSchemaObjectNames in interface SqlValidatorCatalogReader

Parameters:

names - the array contains fully qualified schema name or empty list for root schema

Returns:

the list of all object (schema, table, function, view) names under the above criteria

getSchemaName

public List<String> getSchemaName()

Description copied from interface: SqlValidatorCatalogReader

Returns the name of the current schema.

Specified by:

getSchemaName in interface SqlValidatorCatalogReader

Returns:

name of the current schema

getTableForMember

public RelOptTableImpl getTableForMember(List<String> names)

Description copied from interface: RelOptSchema

Retrieves a RelOptTable based upon a member access.

For example, the Saffron expression salesSchema.emps would be resolved using a call to salesSchema.getTableForMember(new String[]{"emps" }).

Note that name.length is only greater than 1 for queries originating from JDBC.

Specified by:

getTableForMember in interface RelOptSchema

Specified by:

getTableForMember in interface Prepare.CatalogReader

Parameters:

names - Qualified name

field

public RelDataTypeField field(RelDataType rowType,
                     String alias)

Description copied from interface: SqlValidatorCatalogReader

Finds a field with a given name, using the case-sensitivity of the current session.

Specified by:

field in interface SqlValidatorCatalogReader

fieldOrdinal

public int fieldOrdinal(RelDataType rowType,
               String alias)

Description copied from interface: SqlValidatorCatalogReader

Finds the ordinal of a field with a given name, using the case-sensitivity of the current session.

Specified by:

fieldOrdinal in interface SqlValidatorCatalogReader

matches

public boolean matches(String string,
              String name)

Specified by:

matches in interface SqlValidatorCatalogReader

match

public int match(List<String> strings,
        String name)

Specified by:

match in interface SqlValidatorCatalogReader

createTypeFromProjection

public RelDataType createTypeFromProjection(RelDataType type,
                                   List<String> columnNameList)

Specified by:

createTypeFromProjection in interface SqlValidatorCatalogReader

lookupOperatorOverloads

public void lookupOperatorOverloads(SqlIdentifier opName,
                           SqlFunctionCategory category,
                           SqlSyntax syntax,
                           List<SqlOperator> operatorList)

Description copied from interface: SqlOperatorTable

Retrieves a list of operators with a given name and syntax. For example, by passing SqlSyntax.Function, the returned list is narrowed to only matching SqlFunction objects.

Specified by:

lookupOperatorOverloads in interface SqlOperatorTable

Parameters:

opName - name of operator

category - function category to look up, or null for any matching operator

syntax - syntax type of operator

operatorList - mutable list to which to append matches

getOperatorList

public List<SqlOperator> getOperatorList()

Description copied from interface: SqlOperatorTable

Retrieves a list of all functions and operators in this table. Used for automated testing.

Specified by:

getOperatorList in interface SqlOperatorTable

Returns:

list of SqlOperator objects

getTypeFactory

public RelDataTypeFactory getTypeFactory()

Description copied from interface: RelOptSchema

Returns the type factory used to generate types for this schema.

Specified by:

getTypeFactory in interface RelOptSchema

registerRules

public void registerRules(RelOptPlanner planner)
                   throws Exception

Description copied from interface: RelOptSchema

Registers all of the rules supported by this schema. Only called by RelOptPlanner.registerSchema(org.apache.calcite.plan.RelOptSchema).

Specified by:

registerRules in interface RelOptSchema

Throws:

Exception