org.apache.calcite.prepare

Class RelOptTableImpl.MySchemaPlus

java.lang.Object

org.apache.calcite.prepare.RelOptTableImpl.MySchemaPlus

All Implemented Interfaces:

Schema, SchemaPlus

Enclosing class:

RelOptTableImpl

private static class RelOptTableImpl.MySchemaPlus
extends Object
implements SchemaPlus

Implementation of SchemaPlus that wraps a regular schema and knows its name and parent.

It is read-only, and functionality is limited in other ways, it but allows table expressions to be generated.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.calcite.schema.Schema

Schema.TableType

Field Summary

Fields

Modifier and Type	Field and Description
private String	name
private SchemaPlus	parent
private Schema	schema

Constructor Summary

Constructors

Constructor and Description
MySchemaPlus(SchemaPlus parent, String name, Schema schema)

Method Summary

Modifier and Type	Method and Description
void	add(String name, Function function) Adds a function to this schema.
void	add(String name, Lattice lattice) Adds a lattice to this schema.
SchemaPlus	add(String name, Schema schema) Adds a schema as a sub-schema of this schema, and returns the wrapped object.
void	add(String name, Table table) Adds a table to this schema.
static RelOptTableImpl.MySchemaPlus	create(Path path)
Expression	getExpression(SchemaPlus parentSchema, String name) Returns the expression by which this schema can be referenced in generated code.
Set<String>	getFunctionNames() Returns the names of the functions in this schema.
Collection<Function>	getFunctions(String name) Returns a list of functions in this schema with the given name, or an empty list if there is no such function.
String	getName() Returns the name of this schema.
SchemaPlus	getParentSchema() Returns the parent schema, or null if this schema has no parent.
SchemaPlus	getSubSchema(String name) Returns a sub-schema with a given name, or null.
Set<String>	getSubSchemaNames() Returns the names of this schema's child schemas.
Table	getTable(String name) Returns a table with a given name, or null if not found.
Set<String>	getTableNames() Returns the names of the tables in this schema.
boolean	isCacheEnabled()
boolean	isMutable() Returns whether the user is allowed to create new tables, functions and sub-schemas in this schema, in addition to those returned automatically by methods such as Schema.getTable(String).
void	setCacheEnabled(boolean cache)
void	setPath(com.google.common.collect.ImmutableList<com.google.common.collect.ImmutableList<String>> path)
Schema	snapshot(SchemaVersion version) Returns the snapshot of this schema as of the specified time.
<T> T	unwrap(Class<T> clazz) Returns an underlying object.

Methods inherited from class java.lang.Object

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

Field Detail

parent

private final SchemaPlus parent

name

private final String name

schema

private final Schema schema

Constructor Detail

MySchemaPlus

MySchemaPlus(SchemaPlus parent,
             String name,
             Schema schema)

Method Detail

create

public static RelOptTableImpl.MySchemaPlus create(Path path)

getParentSchema

public SchemaPlus getParentSchema()

Description copied from interface: SchemaPlus

Returns the parent schema, or null if this schema has no parent.

Specified by:

getParentSchema in interface SchemaPlus

getName

public String getName()

Description copied from interface: SchemaPlus

Returns the name of this schema.

The name must not be null, and must be unique within its parent. The root schema is typically named "".

Specified by:

getName in interface SchemaPlus

getSubSchema

public SchemaPlus getSubSchema(String name)

Description copied from interface: Schema

Returns a sub-schema with a given name, or null.

Specified by:

getSubSchema in interface Schema

Specified by:

getSubSchema in interface SchemaPlus

Parameters:

name - Sub-schema name

Returns:

Sub-schema with a given name, or null

add

public SchemaPlus add(String name,
                      Schema schema)

Description copied from interface: SchemaPlus

Adds a schema as a sub-schema of this schema, and returns the wrapped object.

Specified by:

add in interface SchemaPlus

add

public void add(String name,
                Table table)

Description copied from interface: SchemaPlus

Adds a table to this schema.

Specified by:

add in interface SchemaPlus

add

public void add(String name,
                Function function)

Description copied from interface: SchemaPlus

Adds a function to this schema.

Specified by:

add in interface SchemaPlus

add

public void add(String name,
                Lattice lattice)

Description copied from interface: SchemaPlus

Adds a lattice to this schema.

Specified by:

add in interface SchemaPlus

isMutable

public boolean isMutable()

Description copied from interface: Schema

Returns whether the user is allowed to create new tables, functions and sub-schemas in this schema, in addition to those returned automatically by methods such as Schema.getTable(String).

Even if this method returns true, the maps are not modified. Calcite stores the defined objects in a wrapper object.

Specified by:

isMutable in interface Schema

Specified by:

isMutable in interface SchemaPlus

Returns:

Whether the user is allowed to create new tables, functions and sub-schemas in this schema

unwrap

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

Description copied from interface: SchemaPlus

Returns an underlying object.

Specified by:

unwrap in interface SchemaPlus

setPath

public void setPath(com.google.common.collect.ImmutableList<com.google.common.collect.ImmutableList<String>> path)

Specified by:

setPath in interface SchemaPlus

setCacheEnabled

public void setCacheEnabled(boolean cache)

Specified by:

setCacheEnabled in interface SchemaPlus

isCacheEnabled

public boolean isCacheEnabled()

Specified by:

isCacheEnabled in interface SchemaPlus

getTable

public Table getTable(String name)

Description copied from interface: Schema

Returns a table with a given name, or null if not found.

Specified by:

getTable in interface Schema

Parameters:

name - Table name

Returns:

Table, or null

getTableNames

public Set<String> getTableNames()

Description copied from interface: Schema

Returns the names of the tables in this schema.

Specified by:

getTableNames in interface Schema

Returns:

Names of the tables in this schema

getFunctions

public Collection<Function> getFunctions(String name)

Description copied from interface: Schema

Returns a list of functions in this schema with the given name, or an empty list if there is no such function.

Specified by:

getFunctions in interface Schema

Parameters:

name - Name of function

Returns:

List of functions with given name, or empty list

getFunctionNames

public Set<String> getFunctionNames()

Description copied from interface: Schema

Returns the names of the functions in this schema.

Specified by:

getFunctionNames in interface Schema

Returns:

Names of the functions in this schema

getSubSchemaNames

public Set<String> getSubSchemaNames()

Description copied from interface: Schema

Returns the names of this schema's child schemas.

Specified by:

getSubSchemaNames in interface Schema

Returns:

Names of this schema's child schemas

getExpression

public Expression getExpression(SchemaPlus parentSchema,
                                String name)

Description copied from interface: Schema

Returns the expression by which this schema can be referenced in generated code.

Specified by:

getExpression in interface Schema

Parameters:

parentSchema - Parent schema

name - Name of this schema

Returns:

Expression by which this schema can be referenced in generated code

snapshot

public Schema snapshot(SchemaVersion version)

Description copied from interface: Schema

Returns the snapshot of this schema as of the specified time. The contents of the schema snapshot should not change over time.

Specified by:

snapshot in interface Schema

Parameters:

version - The current schema version

Returns:

the schema snapshot.