Package org.apache.calcite.schema.impl

Class DelegatingSchema

  • All Implemented Interfaces:
    Schema
    public class DelegatingSchema
extends java.lang.Object
implements Schema
    Implementation of Schema that delegates to an underlying schema.

    • Nested Class Summary

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected Schema schema  

    • Constructor Summary

      Constructors 
      Constructor Description
      DelegatingSchema​(Schema schema)
      Creates a DelegatingSchema.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Expression getExpression​(SchemaPlus parentSchema, java.lang.String name)
      Returns the expression by which this schema can be referenced in generated code.
      java.util.Set<java.lang.String> getFunctionNames()
      Returns the names of the functions in this schema.
      java.util.Collection<Function> getFunctions​(java.lang.String name)
      Returns a list of functions in this schema with the given name, or an empty list if there is no such function.
      Schema getSubSchema​(java.lang.String name)
      Returns a sub-schema with a given name, or null.
      java.util.Set<java.lang.String> getSubSchemaNames()
      Returns the names of this schema's child schemas.
      Table getTable​(java.lang.String name)
      Returns a table with a given name, or null if not found.
      java.util.Set<java.lang.String> getTableNames()
      Returns the names of the tables in this schema.
      RelProtoDataType getType​(java.lang.String name)
      Returns a type with a given name, or null if not found.
      java.util.Set<java.lang.String> getTypeNames()
      Returns the names of the types in this schema.
      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).
      Schema snapshot​(SchemaVersion version)
      Returns the snapshot of this schema as of the specified time.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • schema

        protected final Schema schema

    • Constructor Detail

      • DelegatingSchema

        public DelegatingSchema​(Schema schema)
        Creates a DelegatingSchema.
        Parameters:
        schema - Underlying schema

    • Method Detail

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • 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
        Returns:
        Whether the user is allowed to create new tables, functions and sub-schemas in this schema

      • 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.

      • getExpression

        public Expression getExpression​(SchemaPlus parentSchema,
                                java.lang.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

      • getTable

        public Table getTable​(java.lang.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 java.util.Set<java.lang.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

      • getType

        public RelProtoDataType getType​(java.lang.String name)
        Description copied from interface: Schema
        Returns a type with a given name, or null if not found.
        Specified by:
        getType in interface Schema
        Parameters:
        name - Table name
        Returns:
        Table, or null

      • getTypeNames

        public java.util.Set<java.lang.String> getTypeNames()
        Description copied from interface: Schema
        Returns the names of the types in this schema.
        Specified by:
        getTypeNames in interface Schema
        Returns:
        Names of the tables in this schema

      • getFunctions

        public java.util.Collection<Function> getFunctions​(java.lang.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 java.util.Set<java.lang.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

      • getSubSchema

        public Schema getSubSchema​(java.lang.String name)
        Description copied from interface: Schema
        Returns a sub-schema with a given name, or null.
        Specified by:
        getSubSchema in interface Schema
        Parameters:
        name - Sub-schema name
        Returns:
        Sub-schema with a given name, or null

      • getSubSchemaNames

        public java.util.Set<java.lang.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