org.apache.calcite.avatica

Class MetaImpl

java.lang.Object

org.apache.calcite.avatica.MetaImpl

All Implemented Interfaces:

Meta

public abstract class MetaImpl
extends Object
implements Meta

Basic implementation of Meta.

Each sub-class must implement the two remaining abstract methods, Meta.prepare(org.apache.calcite.avatica.Meta.ConnectionHandle, java.lang.String, int) and Meta.prepareAndExecute(org.apache.calcite.avatica.Meta.ConnectionHandle, java.lang.String, int, org.apache.calcite.avatica.Meta.PrepareCallback). It should also override metadata methods such as getCatalogs() and getTables(java.lang.String, org.apache.calcite.avatica.Meta.Pat, org.apache.calcite.avatica.Meta.Pat, java.util.List<java.lang.String>) for the element types for which it has instances; the default metadata methods return empty collections.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetaImpl.MetaAttribute Metadata describing an attribute.
static class	MetaImpl.MetaBestRowIdentifier Metadata describing the best identifier for a row.
static class	MetaImpl.MetaCatalog Metadata describing a catalog.
static class	MetaImpl.MetaClientInfoProperty Metadata describing a client info property.
static class	MetaImpl.MetaColumn Metadata describing a column.
static class	MetaImpl.MetaColumnPrivilege Metadata describing a column privilege.
static class	MetaImpl.MetaCrossReference Metadata describing a cross reference.
static class	MetaImpl.MetaExportedKey Metadata describing an exported key.
static class	MetaImpl.MetaFunction Metadata describing a function.
static class	MetaImpl.MetaFunctionColumn Metadata describing a function column.
static class	MetaImpl.MetaImportedKey Metadata describing an imported key.
static class	MetaImpl.MetaIndexInfo Metadata describing index info.
static class	MetaImpl.MetaPrimaryKey Metadata describing a primary key.
static class	MetaImpl.MetaProcedure Metadata describing a procedure.
static class	MetaImpl.MetaProcedureColumn Metadata describing a procedure column.
static class	MetaImpl.MetaPseudoColumn Metadata describing a pseudo column.
static class	MetaImpl.MetaSchema Metadata describing a schema.
static class	MetaImpl.MetaSuperTable Metadata describing a super-table.
static class	MetaImpl.MetaSuperType Metadata describing a super-type.
static class	MetaImpl.MetaTable Metadata describing a table.
static class	MetaImpl.MetaTablePrivilege Metadata describing a table privilege.
static class	MetaImpl.MetaTableType Metadata describing a table type.
static class	MetaImpl.MetaTypeInfo Metadata describing type info.
static class	MetaImpl.MetaUdt Metadata describing a user-defined type.
static class	MetaImpl.MetaVersionColumn Metadata describing a version column.
static interface	MetaImpl.Named An object that has a name.

Nested classes/interfaces inherited from interface org.apache.calcite.avatica.Meta

Meta.ConnectionHandle, Meta.ConnectionProperties, Meta.CursorFactory, Meta.ExecuteResult, Meta.Factory, Meta.Frame, Meta.MetaResultSet, Meta.Pat, Meta.PrepareCallback, Meta.Signature, Meta.StatementHandle, Meta.Style

Field Summary

Fields

Modifier and Type	Field and Description
protected AvaticaConnection	connection The AvaticaConnection backing this.
protected ConnectionPropertiesImpl	connProps Represents the various states specific to connection.

Constructor Summary

Constructors

Constructor and Description
MetaImpl(AvaticaConnection connection)

Method Summary

Methods

Modifier and Type	Method and Description
void	closeConnection(Meta.ConnectionHandle ch) Close a connection
static List<List<Object>>	collect(Meta.CursorFactory cursorFactory, Iterable<Object> iterable, List<List<Object>> list)
protected static ColumnMetaData	columnMetaData(String name, int index, Class<?> type)
Meta.ConnectionProperties	connectionSync(Meta.ConnectionHandle ch, Meta.ConnectionProperties connProps) Sync client and server view of connection properties.
static Cursor	createCursor(Meta.CursorFactory cursorFactory, Iterable<Object> iterable) Uses a Meta.CursorFactory to convert an Iterable into a Cursor.
protected <E> Meta.MetaResultSet	createEmptyResultSet(Class<E> clazz) Creates an empty result set.
Iterable<Object>	createIterable(Meta.StatementHandle handle, Meta.Signature signature, List<Object> parameterValues, Meta.Frame firstFrame) Creates an iterable for a result set.
protected Meta.MetaResultSet	createResultSet(Map<String,Object> internalParameters, List<ColumnMetaData> columns, Meta.CursorFactory cursorFactory, Meta.Frame firstFrame)
Meta.StatementHandle	createStatement(Meta.ConnectionHandle ch) Called during the creation of a statement to allocate a new handle.
Meta.Frame	fetch(Meta.StatementHandle h, List<Object> parameterValues, int offset, int fetchMaxRowCount) Returns a frame of rows.
protected static ColumnMetaData.StructType	fieldMetaData(Class clazz)
Meta.MetaResultSet	getAttributes(String catalog, Meta.Pat schemaPattern, Meta.Pat typeNamePattern, Meta.Pat attributeNamePattern)
Meta.MetaResultSet	getBestRowIdentifier(String catalog, String schema, String table, int scope, boolean nullable)
Meta.MetaResultSet	getCatalogs()
Meta.MetaResultSet	getClientInfoProperties()
Meta.MetaResultSet	getColumnPrivileges(String catalog, String schema, String table, Meta.Pat columnNamePattern)
Meta.MetaResultSet	getColumns(String catalog, Meta.Pat schemaPattern, Meta.Pat tableNamePattern, Meta.Pat columnNamePattern)
Meta.MetaResultSet	getCrossReference(String parentCatalog, String parentSchema, String parentTable, String foreignCatalog, String foreignSchema, String foreignTable)
Meta.MetaResultSet	getExportedKeys(String catalog, String schema, String table)
Meta.MetaResultSet	getFunctionColumns(String catalog, Meta.Pat schemaPattern, Meta.Pat functionNamePattern, Meta.Pat columnNamePattern)
Meta.MetaResultSet	getFunctions(String catalog, Meta.Pat schemaPattern, Meta.Pat functionNamePattern)
Meta.MetaResultSet	getImportedKeys(String catalog, String schema, String table)
Meta.MetaResultSet	getIndexInfo(String catalog, String schema, String table, boolean unique, boolean approximate)
String	getNumericFunctions()
Meta.MetaResultSet	getPrimaryKeys(String catalog, String schema, String table)
Meta.MetaResultSet	getProcedureColumns(String catalog, Meta.Pat schemaPattern, Meta.Pat procedureNamePattern, Meta.Pat columnNamePattern)
Meta.MetaResultSet	getProcedures(String catalog, Meta.Pat schemaPattern, Meta.Pat procedureNamePattern)
Meta.MetaResultSet	getPseudoColumns(String catalog, Meta.Pat schemaPattern, Meta.Pat tableNamePattern, Meta.Pat columnNamePattern)
Meta.MetaResultSet	getSchemas(String catalog, Meta.Pat schemaPattern)
String	getSqlKeywords()
String	getStringFunctions()
Meta.MetaResultSet	getSuperTables(String catalog, Meta.Pat schemaPattern, Meta.Pat tableNamePattern)
Meta.MetaResultSet	getSuperTypes(String catalog, Meta.Pat schemaPattern, Meta.Pat typeNamePattern)
String	getSystemFunctions()
Meta.MetaResultSet	getTablePrivileges(String catalog, Meta.Pat schemaPattern, Meta.Pat tableNamePattern)
Meta.MetaResultSet	getTables(String catalog, Meta.Pat schemaPattern, Meta.Pat tableNamePattern, List<String> typeList)
Meta.MetaResultSet	getTableTypes()
String	getTimeDateFunctions()
Meta.MetaResultSet	getTypeInfo()
Meta.MetaResultSet	getUDTs(String catalog, Meta.Pat schemaPattern, Meta.Pat typeNamePattern, int[] types)
Meta.MetaResultSet	getVersionColumns(String catalog, String schema, String table)

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.avatica.Meta

closeStatement, prepare, prepareAndExecute

Field Detail

connection

protected final AvaticaConnection connection

The AvaticaConnection backing this.

connProps

protected final ConnectionPropertiesImpl connProps

Represents the various states specific to connection.

Note: this instance is used recursively with connection's getter and setter methods.

Constructor Detail

MetaImpl

public MetaImpl(AvaticaConnection connection)

Method Detail

createCursor

public static Cursor createCursor(Meta.CursorFactory cursorFactory,
                  Iterable<Object> iterable)

Uses a Meta.CursorFactory to convert an Iterable into a Cursor.

collect

public static List<List<Object>> collect(Meta.CursorFactory cursorFactory,
                         Iterable<Object> iterable,
                         List<List<Object>> list)

closeConnection

public void closeConnection(Meta.ConnectionHandle ch)

Description copied from interface: Meta

Close a connection

Specified by:

closeConnection in interface Meta

connectionSync

public Meta.ConnectionProperties connectionSync(Meta.ConnectionHandle ch,
                                       Meta.ConnectionProperties connProps)

Description copied from interface: Meta

Sync client and server view of connection properties.

Note: this interface is considered "experimental" and may undergo further changes as this functionality is extended to other aspects of state management for Connection, Statement, and ResultSet.

Specified by:

connectionSync in interface Meta

createStatement

public Meta.StatementHandle createStatement(Meta.ConnectionHandle ch)

Description copied from interface: Meta

Called during the creation of a statement to allocate a new handle.

Specified by:

createStatement in interface Meta

Parameters:

ch - Connection handle

createEmptyResultSet

protected <E> Meta.MetaResultSet createEmptyResultSet(Class<E> clazz)

Creates an empty result set. Useful for JDBC metadata methods that are not implemented or which query entities that are not supported (e.g. triggers in Lingual).

columnMetaData

protected static ColumnMetaData columnMetaData(String name,
                            int index,
                            Class<?> type)

fieldMetaData

protected static ColumnMetaData.StructType fieldMetaData(Class clazz)

createResultSet

protected Meta.MetaResultSet createResultSet(Map<String,Object> internalParameters,
                                 List<ColumnMetaData> columns,
                                 Meta.CursorFactory cursorFactory,
                                 Meta.Frame firstFrame)

getSqlKeywords

public String getSqlKeywords()

Specified by:

getSqlKeywords in interface Meta

getNumericFunctions

public String getNumericFunctions()

Specified by:

getNumericFunctions in interface Meta

getStringFunctions

public String getStringFunctions()

Specified by:

getStringFunctions in interface Meta

getSystemFunctions

public String getSystemFunctions()

Specified by:

getSystemFunctions in interface Meta

getTimeDateFunctions

public String getTimeDateFunctions()

Specified by:

getTimeDateFunctions in interface Meta

getTables

public Meta.MetaResultSet getTables(String catalog,
                           Meta.Pat schemaPattern,
                           Meta.Pat tableNamePattern,
                           List<String> typeList)

Specified by:

getTables in interface Meta

getColumns

public Meta.MetaResultSet getColumns(String catalog,
                            Meta.Pat schemaPattern,
                            Meta.Pat tableNamePattern,
                            Meta.Pat columnNamePattern)

Specified by:

getColumns in interface Meta

getSchemas

public Meta.MetaResultSet getSchemas(String catalog,
                            Meta.Pat schemaPattern)

Specified by:

getSchemas in interface Meta

getCatalogs

public Meta.MetaResultSet getCatalogs()

Specified by:

getCatalogs in interface Meta

getTableTypes

public Meta.MetaResultSet getTableTypes()

Specified by:

getTableTypes in interface Meta

getProcedures

public Meta.MetaResultSet getProcedures(String catalog,
                               Meta.Pat schemaPattern,
                               Meta.Pat procedureNamePattern)

Specified by:

getProcedures in interface Meta

getProcedureColumns

public Meta.MetaResultSet getProcedureColumns(String catalog,
                                     Meta.Pat schemaPattern,
                                     Meta.Pat procedureNamePattern,
                                     Meta.Pat columnNamePattern)

Specified by:

getProcedureColumns in interface Meta

getColumnPrivileges

public Meta.MetaResultSet getColumnPrivileges(String catalog,
                                     String schema,
                                     String table,
                                     Meta.Pat columnNamePattern)

Specified by:

getColumnPrivileges in interface Meta

getTablePrivileges

public Meta.MetaResultSet getTablePrivileges(String catalog,
                                    Meta.Pat schemaPattern,
                                    Meta.Pat tableNamePattern)

Specified by:

getTablePrivileges in interface Meta

getBestRowIdentifier

public Meta.MetaResultSet getBestRowIdentifier(String catalog,
                                      String schema,
                                      String table,
                                      int scope,
                                      boolean nullable)

Specified by:

getBestRowIdentifier in interface Meta

getVersionColumns

public Meta.MetaResultSet getVersionColumns(String catalog,
                                   String schema,
                                   String table)

Specified by:

getVersionColumns in interface Meta

getPrimaryKeys

public Meta.MetaResultSet getPrimaryKeys(String catalog,
                                String schema,
                                String table)

Specified by:

getPrimaryKeys in interface Meta

getImportedKeys

public Meta.MetaResultSet getImportedKeys(String catalog,
                                 String schema,
                                 String table)

Specified by:

getImportedKeys in interface Meta

getExportedKeys

public Meta.MetaResultSet getExportedKeys(String catalog,
                                 String schema,
                                 String table)

Specified by:

getExportedKeys in interface Meta

getCrossReference

public Meta.MetaResultSet getCrossReference(String parentCatalog,
                                   String parentSchema,
                                   String parentTable,
                                   String foreignCatalog,
                                   String foreignSchema,
                                   String foreignTable)

Specified by:

getCrossReference in interface Meta

getTypeInfo

public Meta.MetaResultSet getTypeInfo()

Specified by:

getTypeInfo in interface Meta

getIndexInfo

public Meta.MetaResultSet getIndexInfo(String catalog,
                              String schema,
                              String table,
                              boolean unique,
                              boolean approximate)

Specified by:

getIndexInfo in interface Meta

getUDTs

public Meta.MetaResultSet getUDTs(String catalog,
                         Meta.Pat schemaPattern,
                         Meta.Pat typeNamePattern,
                         int[] types)

Specified by:

getUDTs in interface Meta

getSuperTypes

public Meta.MetaResultSet getSuperTypes(String catalog,
                               Meta.Pat schemaPattern,
                               Meta.Pat typeNamePattern)

Specified by:

getSuperTypes in interface Meta

getSuperTables

public Meta.MetaResultSet getSuperTables(String catalog,
                                Meta.Pat schemaPattern,
                                Meta.Pat tableNamePattern)

Specified by:

getSuperTables in interface Meta

getAttributes

public Meta.MetaResultSet getAttributes(String catalog,
                               Meta.Pat schemaPattern,
                               Meta.Pat typeNamePattern,
                               Meta.Pat attributeNamePattern)

Specified by:

getAttributes in interface Meta

getClientInfoProperties

public Meta.MetaResultSet getClientInfoProperties()

Specified by:

getClientInfoProperties in interface Meta

getFunctions

public Meta.MetaResultSet getFunctions(String catalog,
                              Meta.Pat schemaPattern,
                              Meta.Pat functionNamePattern)

Specified by:

getFunctions in interface Meta

getFunctionColumns

public Meta.MetaResultSet getFunctionColumns(String catalog,
                                    Meta.Pat schemaPattern,
                                    Meta.Pat functionNamePattern,
                                    Meta.Pat columnNamePattern)

Specified by:

getFunctionColumns in interface Meta

getPseudoColumns

public Meta.MetaResultSet getPseudoColumns(String catalog,
                                  Meta.Pat schemaPattern,
                                  Meta.Pat tableNamePattern,
                                  Meta.Pat columnNamePattern)

Specified by:

getPseudoColumns in interface Meta

createIterable

public Iterable<Object> createIterable(Meta.StatementHandle handle,
                              Meta.Signature signature,
                              List<Object> parameterValues,
                              Meta.Frame firstFrame)

Description copied from interface: Meta

Creates an iterable for a result set.

The default implementation just returns iterable, which it requires to be not null; derived classes may instead choose to execute the relational expression in signature.

Specified by:

createIterable in interface Meta

fetch

public Meta.Frame fetch(Meta.StatementHandle h,
               List<Object> parameterValues,
               int offset,
               int fetchMaxRowCount)

Description copied from interface: Meta

Returns a frame of rows.

The frame describes whether there may be another frame. If there is not another frame, the current iteration is done when we have finished the rows in the this frame.

The default implementation always returns null.

Specified by:

fetch in interface Meta

Parameters:

h - Statement handle

parameterValues - A list of parameter values, if statement is to be executed; otherwise null

offset - Zero-based offset of first row in the requested frame

fetchMaxRowCount - Maximum number of rows to return; negative means no limit

Returns:

Frame, or null if there are no more