Package com.github.jinahya.database.metadata.bind

Class Context

java.lang.Object

com.github.jinahya.database.metadata.bind.Context

public class Context
extends Object

A class for retrieving information from an instance of DatabaseMetaData.

Author:

Jin Kwon <jinahya_at_gmail.com>

Method Summary

Modifier and Type	Method	Description
List<Attribute>	getAttributes(String catalog, String schemaPattern, String typeNamePattern, String attributeNamePattern)	Invokes DatabaseMetaData.getAttributes(java.lang.String, java.lang.String, java.lang.String, java.lang.String) method with given arguments, and returns a list of bound values.
List<BestRowIdentifier>	getBestRowIdentifier(String catalog, String schema, String table, int scope, boolean nullable)	Invokes DatabaseMetaData.getBestRowIdentifier(java.lang.String, java.lang.String, java.lang.String, int, boolean) method with given arguments, and returns a list of bound values.
List<Catalog>	getCatalogs()	Invokes DatabaseMetaData.getCatalogs() method, and returns a list of bound values.
List<ClientInfoProperty>	getClientInfoProperties()	Invokes DatabaseMetaData.getClientInfoProperties() method, and returns a list of bound values.
List<ColumnPrivilege>	getColumnPrivileges(String catalog, String schema, String table, String columnNamePattern)	Invokes DatabaseMetaData.getColumnPrivileges(java.lang.String, java.lang.String, java.lang.String, java.lang.String) method with given arguments, and returns a list of bound values.
List<Column>	getColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern)	Invokes getColumns(catalog, schemaPattern, * tableNamePattern, columnNamePattern) method with given arguments, and returns a list of bound values.
List<CrossReference>	getCrossReference(String parentCatalog, String parentSchema, String parentTable, String foreignCatalog, String foreignSchema, String foreignTable)	Invokes DatabaseMetaData.getCrossReference(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String) method with given arguments, and returns a list of bound values.
List<ExportedKey>	getExportedKeys(String catalog, String schema, String table)	Invokes DatabaseMetaData.getExportedKeys(java.lang.String, java.lang.String, java.lang.String) method with given arguments, and returns a list of bound values.
List<FunctionColumn>	getFunctionColumns(String catalog, String schemaPattern, String functionNamePattern, String columnNamePattern)	Invokes DatabaseMetaData.getFunctionColumns(String, String, String, String) method with specified arguments, and returns a list of bound values.
List<Function>	getFunctions(String catalog, String schemaPattern, String functionNamePattern)	Invokes DatabaseMetaData.getFunctions(String, String, String) method with given arguments, and returns a list of bound values.
List<ImportedKey>	getImportedKeys(String catalog, String schema, String table)	Invokes DatabaseMetaData.getImportedKeys(String, String, String) method with given arguments, and returns a list of bound values.
List<IndexInfo>	getIndexInfo(String catalog, String schema, String table, boolean unique, boolean approximate)	Invokes DatabaseMetaData.getIndexInfo(String, String, String, boolean, boolean) method with specified arguments, and returns a list of bound values.
List<PrimaryKey>	getPrimaryKeys(String catalog, String schema, String table)	Invokes DatabaseMetaData.getPrimaryKeys(String, String, String) method with given arguments, and returns a list of bound values.
List<ProcedureColumn>	getProcedureColumns(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern)	Invokes DatabaseMetaData.getProcedureColumns(String, String, String, String) method with given arguments , and returns a list of bound values.
List<Procedure>	getProcedures(String catalog, String schemaPattern, String procedureNamePattern)	Invokes DatabaseMetaData.getProcedures(java.lang.String, java.lang.String, java.lang.String) method with given arguments, and returns a lsit of bound values.
List<PseudoColumn>	getPseudoColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern)	Invokes DatabaseMetaData.getPseudoColumns(java.lang.String, java.lang.String, java.lang.String, java.lang.String) method with given arguments, and returns a list of bound values.
List<Schema>	getSchemas()	Invokes DatabaseMetaData.getSchemas() method, and returns a list of bound values.
List<Schema>	getSchemas(String catalog, String schemaPattern)	Invokes DatabaseMetaData.getSchemas(String, String) method with given arguments, and returns a list of bound values.
List<SuperTable>	getSuperTables(String catalog, String schemaPattern, String tableNamePattern)	Invokes DatabaseMetaData.getSuperTables(String, String, String) method with given arguments and adds bounds values to specified collection.
List<SuperType>	getSuperTypes(String catalog, String schemaPattern, String typeNamePattern)	Invokes DatabaseMetaData.getSuperTypes(String, String, String) method with given arguments, and returns a list of bound values.
List<TablePrivilege>	getTablePrivileges(String catalog, String schemaPattern, String tableNamePattern)	Invokes DatabaseMetaData.getTablePrivileges(java.lang.String, java.lang.String, java.lang.String) method with given arguments, and returns a list of bound values.
List<Table>	getTables(String catalog, String schemaPattern, String tableNamePattern, String[] types)	Invokes getTables(catalog, schemaPattern, tableNamePattern, types) method with given arguments, and returns a list of bound values.
<C extends Collection<? super Table>> C	getTables(String catalog, String schemaPattern, String tableNamePattern, String[] types, C collection)	Invokes getTables(catalog, schemaPattern, tableNamePattern, types) method with given arguments, and adds each bound values to specified collection.
List<TableType>	getTableTypes()	Invokes DatabaseMetaData.getTableTypes() method, and returns a list of bound values.
List<TypeInfo>	getTypeInfo()	Invokes DatabaseMetaData.getTypeInfo() method, and returns a list of bound values.
List<UDT>	getUDTs(String catalog, String schemaPattern, String typeNamePattern, int[] types)	Invokes DatabaseMetaData.getUDTs(java.lang.String, java.lang.String, java.lang.String, int[]) method with given arguments, and returns a list of bound values.
List<VersionColumn>	getVersionColumns(String catalog, String schema, String table)	Invokes DatabaseMetaData.getVersionColumns(java.lang.String, java.lang.String, java.lang.String) method with given arguments, and returns a list of bound values.
static Context	newInstance(Connection connection)	Creates a new instance from specified connection.

Methods inherited from class java.lang.Object

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

Method Details

newInstance

public static Context newInstance(Connection connection)
                           throws SQLException

Creates a new instance from specified connection.

Parameters:

connection - the connection.

Returns:

a new instance.

Throws:

SQLException - if a database error occurs.

getAttributes

public List<Attribute> getAttributes(String catalog,
 String schemaPattern,
 String typeNamePattern,
 String attributeNamePattern)
                              throws SQLException

Invokes DatabaseMetaData.getAttributes(java.lang.String, java.lang.String, java.lang.String, java.lang.String) method with given arguments, and returns a list of bound values.

Parameters:

catalog - a value for catalog parameter.

schemaPattern - a value for schemaPattern parameter.

typeNamePattern - a value for typeNamePattern parameter.

attributeNamePattern - a value for attributeNamePattern parameter.

Returns:

a list of bound values.

Throws:

SQLException - if a database error occurs.

getBestRowIdentifier

public List<BestRowIdentifier> getBestRowIdentifier(String catalog,
 String schema,
 String table,
 int scope,
 boolean nullable)
                                             throws SQLException

Invokes DatabaseMetaData.getBestRowIdentifier(java.lang.String, java.lang.String, java.lang.String, int, boolean) method with given arguments, and returns a list of bound values.

Parameters:

catalog - a value for catalog parameter.

schema - a value for schema parameter.

table - a value for table parameter.

scope - a value for scope parameter.

nullable - a value for nullable parameter.

Returns:

a list of bound values.

Throws:

SQLException - if a database error occurs.

getCatalogs

public List<Catalog> getCatalogs()
                          throws SQLException

Invokes DatabaseMetaData.getCatalogs() method, and returns a list of bound values.

Returns:

a list of bound values.

Throws:

SQLException - if a database error occurs.

getClientInfoProperties

public List<ClientInfoProperty> getClientInfoProperties()
                                                 throws SQLException

Invokes DatabaseMetaData.getClientInfoProperties() method, and returns a list of bound values.

Returns:

a list of bound values.

Throws:

SQLException - if a database error occurs.

getColumnPrivileges

public List<ColumnPrivilege> getColumnPrivileges(String catalog,
 String schema,
 String table,
 String columnNamePattern)
                                          throws SQLException

Invokes DatabaseMetaData.getColumnPrivileges(java.lang.String, java.lang.String, java.lang.String, java.lang.String) method with given arguments, and returns a list of bound values.

Parameters:

catalog - a value for catalog parameter.

schema - a value for schema parameter.

table - a value for table parameter.

columnNamePattern - a value for columnNamePattern parameter.

Returns:

a list of bound values.

Throws:

SQLException - if a database error occurs.

getColumns

public List<Column> getColumns(String catalog,
 String schemaPattern,
 String tableNamePattern,
 String columnNamePattern)
                        throws SQLException

Invokes getColumns(catalog, schemaPattern, * tableNamePattern, columnNamePattern) method with given arguments, and returns a list of bound values.

Parameters:

catalog - a value for catalog parameter.

schemaPattern - a value for schemaPattern parameter.

tableNamePattern - a value for tableNameSchema parameter.

columnNamePattern - a value for columnNamePattern parameter.

Returns:

a list of bound values.

Throws:

SQLException - if a database error occurs.

getCrossReference

public List<CrossReference> getCrossReference(String parentCatalog,
 String parentSchema,
 String parentTable,
 String foreignCatalog,
 String foreignSchema,
 String foreignTable)
                                       throws SQLException

Invokes DatabaseMetaData.getCrossReference(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String) method with given arguments, and returns a list of bound values.

Parameters:

parentCatalog - a value for parentCatalog parameter

parentSchema - a value for parentSchema parameter

parentTable - a value for parentTable parameter

foreignCatalog - a value for foreignCatalog parameter

foreignSchema - av value for foreignSchema parameter

foreignTable - a value for foreignTable parameter

Returns:

a list of bound values.

Throws:

SQLException - if a database error occurs.

getExportedKeys

public List<ExportedKey> getExportedKeys(String catalog,
 String schema,
 String table)
                                  throws SQLException

Invokes DatabaseMetaData.getExportedKeys(java.lang.String, java.lang.String, java.lang.String) method with given arguments, and returns a list of bound values.

Parameters:

catalog - a value for catalog parameter.

schema - a value for schema parameter.

table - a value for table parameter.

Returns:

a list of bound values.

Throws:

SQLException - if a database error occurs.

getFunctions

public List<Function> getFunctions(String catalog,
 String schemaPattern,
 String functionNamePattern)
                            throws SQLException

Invokes DatabaseMetaData.getFunctions(String, String, String) method with given arguments, and returns a list of bound values.

Parameters:

catalog - a value for catalog parameter.

schemaPattern - a value for schemaPattern parameter.

functionNamePattern - a value for functionNamePattern parameter.

Returns:

a list of bound values.

Throws:

SQLException - if a database error occurs.

getFunctionColumns

public List<FunctionColumn> getFunctionColumns(String catalog,
 String schemaPattern,
 String functionNamePattern,
 String columnNamePattern)
                                        throws SQLException

Invokes DatabaseMetaData.getFunctionColumns(String, String, String, String) method with specified arguments, and returns a list of bound values.

Parameters:

catalog - a value for catalog parameter.

schemaPattern - a value for schemaPattern parameter.

functionNamePattern - a value for functionNamePattern parameter.

columnNamePattern - a value for columnNamePattern parameter.

Returns:

a list of bound values.

Throws:

SQLException - if a database error occurs.

getImportedKeys

public List<ImportedKey> getImportedKeys(String catalog,
 String schema,
 String table)
                                  throws SQLException

Invokes DatabaseMetaData.getImportedKeys(String, String, String) method with given arguments, and returns a list of bound values.

Parameters:

catalog - a value for catalog parameter.

schema - a value for schema parameter.

table - a value for table parameter.

Returns:

a list of bound values.

Throws:

SQLException - if a database error occurs.

getIndexInfo

public List<IndexInfo> getIndexInfo(String catalog,
 String schema,
 String table,
 boolean unique,
 boolean approximate)
                             throws SQLException

Invokes DatabaseMetaData.getIndexInfo(String, String, String, boolean, boolean) method with specified arguments, and returns a list of bound values.

Parameters:

catalog - a value for catalog parameter.

schema - a value for schema parameter.

table - a value for table parameter.

unique - a value for unique parameter.

approximate - a value for approximate parameter.

Returns:

a list of bound values.

Throws:

SQLException - if a database error occurs.

getPrimaryKeys

public List<PrimaryKey> getPrimaryKeys(String catalog,
 String schema,
 String table)
                                throws SQLException

Invokes DatabaseMetaData.getPrimaryKeys(String, String, String) method with given arguments, and returns a list of bound values.

Parameters:

catalog - a value for catalog parameter.

schema - a value for schema parameter.

table - a value for table parameter.

Returns:

a list of bound values.

Throws:

SQLException - if a database error occurs.

getProcedureColumns

public List<ProcedureColumn> getProcedureColumns(String catalog,
 String schemaPattern,
 String procedureNamePattern,
 String columnNamePattern)
                                          throws SQLException

Invokes DatabaseMetaData.getProcedureColumns(String, String, String, String) method with given arguments , and returns a list of bound values.

Parameters:

catalog - a value for catalog parameter.

schemaPattern - a value for schemaPattern parameter.

procedureNamePattern - a value for procedureNamePattern parameter.

columnNamePattern - a value for columnNamePattern parameter.

Returns:

a list of bound values.

Throws:

SQLException - if a database error occurs.

getProcedures

public List<Procedure> getProcedures(String catalog,
 String schemaPattern,
 String procedureNamePattern)
                              throws SQLException

Invokes DatabaseMetaData.getProcedures(java.lang.String, java.lang.String, java.lang.String) method with given arguments, and returns a lsit of bound values.

Parameters:

catalog - a value for catalog parameter.

schemaPattern - a value for schemaPattern parameter.

procedureNamePattern - a value for procedureNamePattern parameter.

Returns:

a list of bound values.

Throws:

SQLException - if a database error occurs.

getPseudoColumns

public List<PseudoColumn> getPseudoColumns(String catalog,
 String schemaPattern,
 String tableNamePattern,
 String columnNamePattern)
                                    throws SQLException

Invokes DatabaseMetaData.getPseudoColumns(java.lang.String, java.lang.String, java.lang.String, java.lang.String) method with given arguments, and returns a list of bound values.

Parameters:

catalog - a value for catalog parameter.

schemaPattern - a value for schemaPattern parameter.

tableNamePattern - a value for tableNamePattern parameter.

columnNamePattern - a value for columnNamePattern parameter.

Returns:

a list of bound values.

Throws:

SQLException - if a database error occurs.

getSchemas

public List<Schema> getSchemas()
                        throws SQLException

Invokes DatabaseMetaData.getSchemas() method, and returns a list of bound values.

Returns:

a list of bound values.

Throws:

SQLException - if a database error occurs.

getSchemas

public List<Schema> getSchemas(String catalog,
 String schemaPattern)
                        throws SQLException

Invokes DatabaseMetaData.getSchemas(String, String) method with given arguments, and returns a list of bound values.

Parameters:

catalog - a value for catalog parameter.

schemaPattern - a value for schemaPattern parameter.

Returns:

a list of bound values.

Throws:

SQLException - if a database error occurs.

getSuperTables

public List<SuperTable> getSuperTables(String catalog,
 String schemaPattern,
 String tableNamePattern)
                                throws SQLException

Invokes DatabaseMetaData.getSuperTables(String, String, String) method with given arguments and adds bounds values to specified collection.

Parameters:

catalog - a value for catalog parameter.

schemaPattern - a value for schemaPattern paramter.

tableNamePattern - a value for tableNamePattern parameter.

Returns:

a list of bound values.

Throws:

SQLException - if a database error occurs.

getSuperTypes

public List<SuperType> getSuperTypes(String catalog,
 String schemaPattern,
 String typeNamePattern)
                              throws SQLException

Invokes DatabaseMetaData.getSuperTypes(String, String, String) method with given arguments, and returns a list of bound values.

Parameters:

catalog - a value for catalog parameter.

schemaPattern - a value for schemaPattern parameter.

typeNamePattern - a value for typeNamePattern parameter.

Returns:

a list of bound values.

Throws:

SQLException - if a database error occurs.

getTablePrivileges

public List<TablePrivilege> getTablePrivileges(String catalog,
 String schemaPattern,
 String tableNamePattern)
                                        throws SQLException

Invokes DatabaseMetaData.getTablePrivileges(java.lang.String, java.lang.String, java.lang.String) method with given arguments, and returns a list of bound values.

Parameters:

catalog - a value for catalog parameter.

schemaPattern - a value for schemaPattern parameter.

tableNamePattern - a value for tableNamePattern parameter.

Returns:

a list of bound values.

Throws:

SQLException - if a database error occurs.

getTableTypes

public List<TableType> getTableTypes()
                              throws SQLException

Invokes DatabaseMetaData.getTableTypes() method, and returns a list of bound values.

Returns:

a list of bound values.

Throws:

SQLException - if a database error occurs.

getTables

public <C extends Collection<? super Table>> C getTables(String catalog,
 String schemaPattern,
 String tableNamePattern,
 String[] types,
 C collection)
                                                  throws SQLException

Invokes getTables(catalog, schemaPattern, tableNamePattern, types) method with given arguments, and adds each bound values to specified collection.

Parameters:

catalog - a value for catalog parameter.

schemaPattern - a value for schemaPattern parameter.

tableNamePattern - a value for tableNamePattern parameter.

types - a value for types parameter.

collection - the collection to which bound values are added.

Returns:

given collection.

Throws:

SQLException - if a database error occurs.

See Also:

• getTables(String, String, String, String[], Consumer)

getTables

public List<Table> getTables(String catalog,
 String schemaPattern,
 String tableNamePattern,
 String[] types)
                      throws SQLException

Invokes getTables(catalog, schemaPattern, tableNamePattern, types) method with given arguments, and returns a list of bound values.

Parameters:

catalog - a value for catalog parameter.

schemaPattern - a value for schemaPattern parameter.

tableNamePattern - a value for tableNamePattern parameter.

types - a value for types parameter.

Returns:

a list of bound values.

Throws:

SQLException - if a database error occurs.

getTypeInfo

public List<TypeInfo> getTypeInfo()
                           throws SQLException

Invokes DatabaseMetaData.getTypeInfo() method, and returns a list of bound values.

Returns:

a list of bound values.

Throws:

SQLException - if a database error occurs.

getUDTs

public List<UDT> getUDTs(String catalog,
 String schemaPattern,
 String typeNamePattern,
 int[] types)
                  throws SQLException

Invokes DatabaseMetaData.getUDTs(java.lang.String, java.lang.String, java.lang.String, int[]) method with given arguments, and returns a list of bound values.

Parameters:

catalog - a value for catalog parameter.

schemaPattern - a value for schemaPattern parameter

typeNamePattern - a value for typeNamePattern parameter.

types - a value for type parameter

Returns:

a list of bound values.

Throws:

SQLException - if a database error occurs.

getVersionColumns

public List<VersionColumn> getVersionColumns(String catalog,
 String schema,
 String table)
                                      throws SQLException

Invokes DatabaseMetaData.getVersionColumns(java.lang.String, java.lang.String, java.lang.String) method with given arguments, and returns a list of bound values.

Parameters:

catalog - a value for catalog parameter.

schema - a value for schema parameter.

table - a value for table parameter.

Returns:

a list of bound values.

Throws:

SQLException - if a database access error occurs.