Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
package com.github.jinahya.database.metadata.bind;
/*-
* #%L
* database-metadata-bind
* %%
* Copyright (C) 2011 - 2019 Jinahya, Inc.
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* #L%
*/
import lombok.extern.java.Log;
import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.sql.Connection;
import java.sql.DatabaseMetaData;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Objects;
import java.util.Set;
import java.util.function.Consumer;
import java.util.logging.Level;
/**
* A class for retrieving information from an instance of {@link java.sql.DatabaseMetaData}.
*
* @author Jin Kwon <jinahya_at_gmail.com>
*/
@Log
public class Context {
/**
* Creates a new instance from specified connection.
*
* @param connection the connection.
* @return a new instance.
* @throws SQLException if a database error occurs.
*/
public static Context newInstance(final Connection connection) throws SQLException {
Objects.requireNonNull(connection, "connection is null");
return new Context(connection.getMetaData());
}
/**
* Creates a new instance with specified DatabaseMetaData.
*
* @param databaseMetaData the DatabaseMetaData to hold.
*/
Context(final DatabaseMetaData databaseMetaData) {
super();
this.databaseMetaData = Objects.requireNonNull(databaseMetaData, "databaseMetaData is null");
}
/**
* Binds given value from specified result set.
*
* @param value type parameter
* @param results the result set from which the value is bound.
* @param type the type of the value.
* @param instance the value.
* @return given {@code value}.
* @throws SQLException if a database error occurs.
*/
private T bind(final ResultSet results, final Class type, final T instance)
throws SQLException {
final Set resultLabels = Utils.getLabels(results);
final Map fieldLabels = new HashMap<>(getLabeledFields(type));
for (final Iterator> i = fieldLabels.entrySet().iterator(); i.hasNext(); ) {
final Entry entry = i.next();
final Field field = entry.getKey();
final _ColumnLabel fieldLabel = entry.getValue();
if (!resultLabels.remove(fieldLabel.value())) {
log.warning(() -> String.format("unknown fieldLabel; %1$s on %2$s", fieldLabel, field));
continue;
}
if (field.isAnnotationPresent(_NotUsedBySpecification.class) ||
field.isAnnotationPresent(_Reserved.class)) {
i.remove();
continue;
}
try {
Utils.setFieldValue(field, instance, results, fieldLabel.value());
} catch (final ReflectiveOperationException roe) {
log.log(Level.SEVERE, String.format("failed to set %1$s", field), roe);
}
i.remove();
}
for (final String resultLabel : resultLabels) {
final Object object = results.getObject(resultLabel);
instance.getUnmappedValues().put(resultLabel, object);
}
if (!fieldLabels.isEmpty()) {
log.warning(() -> String.format("unmapped fields: %1$s", fieldLabels));
}
return instance;
}
/**
* Binds all records as given type and adds them to specified consumer.
*
* @param results the records to bind.
* @param type the type of instances.
* @param consumer the consumer to which bound instances are added
* @param binding type parameter
* @throws SQLException if a database error occurs.
*/
@SuppressWarnings({
"java:S112", // new RuntimeException
"java:S1874", // isAccessible
"java:S3011" // setAccessible
})
private void bind(final ResultSet results, final Class type,
final Consumer consumer)
throws SQLException {
Objects.requireNonNull(results, "results is null");
Objects.requireNonNull(type, "type is null");
Objects.requireNonNull(consumer, "consumer is null");
final Constructor constructor;
try {
constructor = type.getDeclaredConstructor();
} catch (final ReflectiveOperationException roe) {
throw new RuntimeException("failed to get the default constructor; type: " + type, roe);
}
if (!constructor.isAccessible()) {
constructor.setAccessible(true);
}
while (results.next()) {
final T value;
try {
value = constructor.newInstance();
} catch (final ReflectiveOperationException roe) {
throw new RuntimeException("failed to instantiate; type: " + type, roe);
}
consumer.accept(bind(results, type, value));
}
}
/**
* Binds all records as given type and adds them to specified collection.
*
* @param results the records to bind.
* @param type the type of instances.
* @param collection the collection to which bound instances are added
* @param binding type parameter
* @param the type of {@code collection}
* @return given {@code collection}.
* @throws SQLException if a database error occurs.
*/
@SuppressWarnings({
"java:S112", // new RuntimeException
"java:S1874", // isAccessible
"java:S3011" // setAccessible
})
private > C bind(
final ResultSet results, final Class type, final C collection)
throws SQLException {
Objects.requireNonNull(results, "results is null");
Objects.requireNonNull(type, "type is null");
Objects.requireNonNull(collection, "collection is null");
while (results.next()) {
final T value;
try {
final Constructor constructor = type.getDeclaredConstructor();
if (!constructor.isAccessible()) {
constructor.setAccessible(true);
}
value = constructor.newInstance();
} catch (final ReflectiveOperationException roe) {
throw new RuntimeException("failed to instantiate " + type, roe);
}
collection.add(bind(results, type, value));
}
return collection;
}
/**
* Invokes
* {@link DatabaseMetaData#getAttributes(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
* getAttributes(catalog, schemaPattern, typeNamePattern, attributeNamePattern)} method with given arguments, and
* accepts each bound value to specified consumer.
*
* @param catalog a value for {@code catalog} parameter.
* @param schemaPattern a value for {@code schemaPattern} parameter.
* @param typeNamePattern a value for {@code typeNamePattern} parameter.
* @param attributeNamePattern a value for {@code attributeNamePattern} parameter.
* @param consumer the consumer to which bound values are accepted.
* @throws SQLException if a database error occurs.
* @see DatabaseMetaData#getAttributes(String, String, String, String)
*/
public void getAttributes(final String catalog, final String schemaPattern, final String typeNamePattern,
final String attributeNamePattern, final Consumer consumer)
throws SQLException {
Objects.requireNonNull(consumer, "consumer is null");
try (ResultSet results = databaseMetaData.getAttributes(
catalog, schemaPattern, typeNamePattern, attributeNamePattern)) {
assert results != null;
bind(results, Attribute.class, consumer);
}
}
/**
* Invokes
* {@link 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.
*
* @param catalog a value for {@code catalog} parameter.
* @param schemaPattern a value for {@code schemaPattern} parameter.
* @param typeNamePattern a value for {@code typeNamePattern} parameter.
* @param attributeNamePattern a value for {@code attributeNamePattern} parameter.
* @return a list of bound values.
* @throws SQLException if a database error occurs.
* @see #getAttributes(String, String, String, String, Consumer)
*/
public List getAttributes(final String catalog, final String schemaPattern, final String typeNamePattern,
final String attributeNamePattern)
throws SQLException {
final List list = new ArrayList<>();
getAttributes(catalog, schemaPattern, typeNamePattern, attributeNamePattern, list::add);
return list;
}
List getAttributes(final UDT udt, final String attributeNamePattern) throws SQLException {
Objects.requireNonNull(udt, "udt is null");
return getAttributes(
udt.getTypeCatNonNull(),
udt.getTypeSchemNonNull(),
Objects.requireNonNull(udt.getTypeName(), "udt.typeName is null"),
attributeNamePattern
);
}
/**
* Invokes
* {@link DatabaseMetaData#getBestRowIdentifier(java.lang.String, java.lang.String, java.lang.String, int, boolean)}
* method with given arguments, and accepts each bound value to specified consumer.
*
* @param catalog a value for {@code catalog} parameter.
* @param schema a value for {@code schema} parameter.
* @param table a value for {@code table} parameter.
* @param scope a value for {@code scope} parameter.
* @param nullable a value for {@code nullable} parameter.
* @param consumer the consumer to which bound values are accepted.
* @throws SQLException if a database error occurs.
* @see DatabaseMetaData#getBestRowIdentifier(String, String, String, int, boolean)
*/
public void getBestRowIdentifier(final String catalog, final String schema, final String table, final int scope,
final boolean nullable, final Consumer consumer)
throws SQLException {
Objects.requireNonNull(consumer, "consumer is null");
try (ResultSet results = databaseMetaData.getBestRowIdentifier(catalog, schema, table, scope, nullable)) {
assert results != null;
bind(results, BestRowIdentifier.class, consumer);
}
}
/**
* Invokes
* {@link DatabaseMetaData#getBestRowIdentifier(java.lang.String, java.lang.String, java.lang.String, int, boolean)}
* method with given arguments, and returns a list of bound values.
*
* @param catalog a value for {@code catalog} parameter.
* @param schema a value for {@code schema} parameter.
* @param table a value for {@code table} parameter.
* @param scope a value for {@code scope} parameter.
* @param nullable a value for {@code nullable} parameter.
* @return a list of bound values.
* @throws SQLException if a database error occurs.
* @see #getBestRowIdentifier(String, String, String, int, boolean, Consumer)
*/
public List getBestRowIdentifier(final String catalog, final String schema, final String table,
final int scope, final boolean nullable)
throws SQLException {
final List list = new ArrayList<>();
getBestRowIdentifier(catalog, schema, table, scope, nullable, list::add);
return list;
}
List getBestRowIdentifier(final Table table, final int scope, final boolean nullable)
throws SQLException {
Objects.requireNonNull(table, "table is null");
return getBestRowIdentifier(
table.getTableCatNonNull(),
table.getTableSchemNonNull(),
Objects.requireNonNull(table.getTableName(), "table.tableName is null"),
scope,
nullable
);
}
/**
* Invokes {@link DatabaseMetaData#getCatalogs()} method, and accepts each bound value to specified consumer.
*
* @param consumer the consumer to which each bound value is accepted.
* @throws SQLException if a database error occurs.
* @see DatabaseMetaData#getCatalogs()
*/
public void getCatalogs(final Consumer consumer) throws SQLException {
Objects.requireNonNull(consumer, "consumer is null");
try (ResultSet results = databaseMetaData.getCatalogs()) {
assert results != null;
bind(results, Catalog.class, consumer);
}
}
/**
* Invokes {@link DatabaseMetaData#getCatalogs()} method, and returns a list of bound values.
*
* @return a list of bound values.
* @throws SQLException if a database error occurs.
* @see DatabaseMetaData#getCatalogs()
*/
public List getCatalogs() throws SQLException {
final List list = new ArrayList<>();
getCatalogs(list::add);
return list;
}
/**
* Invokes {@link DatabaseMetaData#getClientInfoProperties()} method, and accepts each bound value to specified
* consumer.
*
* @param consumer the consumer to which bound values are accepted.
* @throws SQLException if a database error occurs.
* @see DatabaseMetaData#getClientInfoProperties()
*/
public void getClientInfoProperties(final Consumer consumer)
throws SQLException {
Objects.requireNonNull(consumer, "consumer is null");
try (ResultSet results = databaseMetaData.getClientInfoProperties()) {
assert results != null;
bind(results, ClientInfoProperty.class, consumer);
}
}
/**
* Invokes {@link DatabaseMetaData#getClientInfoProperties()} method, and returns a list of bound values.
*
* @return a list of bound values.
* @throws SQLException if a database error occurs.
* @see #getClientInfoProperties(Consumer)
*/
public List getClientInfoProperties() throws SQLException {
final List list = new ArrayList<>();
getClientInfoProperties(list::add);
return list;
}
/**
* Invokes
* {@link DatabaseMetaData#getColumnPrivileges(java.lang.String, java.lang.String, java.lang.String,
* java.lang.String)} method with given arguments, and accepts each bound value to specified consumer.
*
* @param catalog a value for {@code catalog} parameter.
* @param schema a value for {@code schema} parameter.
* @param table a value for {@code table} parameter.
* @param columnNamePattern a value for {@code columnNamePattern} parameter.
* @param consumer the consumer to which bound values are accepted.
* @throws SQLException if a database error occurs.
* @see DatabaseMetaData#getColumnPrivileges(String, String, String, String)
*/
public void getColumnPrivileges(final String catalog, final String schema, final String table,
final String columnNamePattern,
final Consumer consumer)
throws SQLException {
Objects.requireNonNull(consumer, "consumer is null");
try (ResultSet results = databaseMetaData.getColumnPrivileges(catalog, schema, table, columnNamePattern)) {
assert results != null;
bind(results, ColumnPrivilege.class, consumer);
}
}
/**
* Invokes
* {@link 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.
*
* @param catalog a value for {@code catalog} parameter.
* @param schema a value for {@code schema} parameter.
* @param table a value for {@code table} parameter.
* @param columnNamePattern a value for {@code columnNamePattern} parameter.
* @return a list of bound values.
* @throws SQLException if a database error occurs.
* @see DatabaseMetaData#getColumnPrivileges(String, String, String, String)
*/
public List getColumnPrivileges(final String catalog, final String schema, final String table,
final String columnNamePattern)
throws SQLException {
final List list = new ArrayList<>();
getColumnPrivileges(catalog, schema, table, columnNamePattern, list::add);
return list;
}
List getColumnPrivileges(final Table table, final String columnNamePattern)
throws SQLException {
Objects.requireNonNull(table, "table is null");
return getColumnPrivileges(
table.getTableCatNonNull(),
table.getTableSchemNonNull(),
Objects.requireNonNull(table.getTableName(), "table.tableName is null"),
columnNamePattern
);
}
/**
* Invokes
* {@link DatabaseMetaData#getColumns(String, String, String, String) getColumns(catalog, schemaPattern, *
* tableNamePattern, columnNamePattern)} method with given arguments, and accepts each bound value to specified
* consumer.
*
* @param catalog a value for {@code catalog} parameter.
* @param schemaPattern a value for {@code schemaPattern} parameter.
* @param tableNamePattern a value for {@code tableNameSchema} parameter.
* @param columnNamePattern a value for {@code columnNamePattern} parameter.
* @param consumer the consumer to which bound values are accepted.
* @throws SQLException if a database error occurs.
* @see DatabaseMetaData#getColumns(String, String, String, String)
*/
public void getColumns(final String catalog, final String schemaPattern, final String tableNamePattern,
final String columnNamePattern, final Consumer consumer)
throws SQLException {
Objects.requireNonNull(consumer, "consumer is null");
try (ResultSet results = databaseMetaData.getColumns(catalog, schemaPattern, tableNamePattern,
columnNamePattern)) {
assert results != null;
bind(results, Column.class, consumer);
}
}
/**
* Invokes
* {@link DatabaseMetaData#getColumns(String, String, String, String) getColumns(catalog, schemaPattern,
* tableNamePattern, columnNamePattern)} method with given arguments, and adds each bound value to specified
* collection.
*
* @param catalog a value for {@code catalog} parameter.
* @param schemaPattern a value for {@code schemaPattern} parameter.
* @param tableNamePattern a value for {@code tableNameSchema} parameter.
* @param columnNamePattern a value for {@code columnNamePattern} parameter.
* @param collection the collection to which bound values are added.
* @return given {@code collection}.
* @throws SQLException if a database error occurs.
* @see #getColumns(String, String, String, String, Consumer)
*/
public > C getColumns(final String catalog, final String schemaPattern,
final String tableNamePattern,
final String columnNamePattern, final C collection)
throws SQLException {
getColumns(catalog, schemaPattern, tableNamePattern, columnNamePattern,
(Consumer) collection::add);
return collection;
}
/**
* Invokes
* {@link DatabaseMetaData#getColumns(String, String, String, String) getColumns(catalog, schemaPattern, *
* tableNamePattern, columnNamePattern)} method with given arguments, and returns a list of bound values.
*
* @param catalog a value for {@code catalog} parameter.
* @param schemaPattern a value for {@code schemaPattern} parameter.
* @param tableNamePattern a value for {@code tableNameSchema} parameter.
* @param columnNamePattern a value for {@code columnNamePattern} parameter.
* @return a list of bound values.
* @throws SQLException if a database error occurs.
* @see #getColumns(String, String, String, String, Collection)
*/
public List getColumns(final String catalog, final String schemaPattern, final String tableNamePattern,
final String columnNamePattern)
throws SQLException {
return getColumns(catalog, schemaPattern, tableNamePattern, columnNamePattern, new ArrayList<>());
}
/**
* Invokes
* {@link DatabaseMetaData#getColumns(String, String, String, String) getColumns(catalog, schemaPattern, *
* tableNamePattern, columnNamePattern)} method with given table's properties, and returns a list of bound values.
*
* @param table the table.
* @param columnNamePattern a value for {@code columnNamePattern} parameter.
* @return a list of bound values.
* @throws SQLException if a database error occurs.
* @see #getColumns(String, String, String, String)
*/
List getColumns(final Table table, final String columnNamePattern) throws SQLException {
Objects.requireNonNull(table, "table is null");
return getColumns(
table.getTableCatNonNull(),
table.getTableSchemNonNull(),
Objects.requireNonNull(table.getTableName(), "table.tableName is null"),
columnNamePattern
);
}
/**
* Invokes
* {@link 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 accepts each bound value to specified
* consumer.
*
* @param parentCatalog a value for {@code parentCatalog} parameter
* @param parentSchema a value for {@code parentSchema} parameter
* @param parentTable a value for {@code parentTable} parameter
* @param foreignCatalog a value for {@code foreignCatalog} parameter
* @param foreignSchema av value for {@code foreignSchema} parameter
* @param foreignTable a value for {@code foreignTable} parameter
* @param consumer the consumer to which bound values are accepted.
* @throws SQLException if a database error occurs.
*/
public void getCrossReference(final String parentCatalog, final String parentSchema, final String parentTable,
final String foreignCatalog, final String foreignSchema, final String foreignTable,
final Consumer consumer)
throws SQLException {
Objects.requireNonNull(consumer, "consumer is null");
try (ResultSet results = databaseMetaData.getCrossReference(
parentCatalog, parentSchema, parentTable, foreignCatalog, foreignSchema, foreignTable)) {
assert results != null;
bind(results, CrossReference.class, consumer);
}
}
/**
* Invokes
* {@link 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.
*
* @param parentCatalog a value for {@code parentCatalog} parameter
* @param parentSchema a value for {@code parentSchema} parameter
* @param parentTable a value for {@code parentTable} parameter
* @param foreignCatalog a value for {@code foreignCatalog} parameter
* @param foreignSchema av value for {@code foreignSchema} parameter
* @param foreignTable a value for {@code foreignTable} parameter
* @return a list of bound values.
* @throws SQLException if a database error occurs.
*/
public List getCrossReference(final String parentCatalog, final String parentSchema,
final String parentTable, final String foreignCatalog,
final String foreignSchema, final String foreignTable)
throws SQLException {
final List list = new ArrayList<>();
getCrossReference(parentCatalog, parentSchema, parentTable, foreignCatalog, foreignSchema, foreignTable,
list::add);
return list;
}
/**
* Invokes {@link DatabaseMetaData#getExportedKeys(java.lang.String, java.lang.String, java.lang.String)} method
* with given arguments, and accepts each bound value to specified consumer.
*
* @param catalog a value for {@code catalog} parameter.
* @param schema a value for {@code schema} parameter.
* @param table a value for {@code table} parameter.
* @param consumer the consumer to which bound values are accepted.
* @throws SQLException if a database error occurs.
* @see DatabaseMetaData#getExportedKeys(String, String, String)
*/
public void getExportedKeys(final String catalog, final String schema, final String table,
final Consumer consumer)
throws SQLException {
Objects.requireNonNull(consumer, "consumer is null");
try (ResultSet results = databaseMetaData.getExportedKeys(catalog, schema, table)) {
assert results != null;
bind(results, ExportedKey.class, consumer);
}
}
/**
* Invokes {@link DatabaseMetaData#getExportedKeys(java.lang.String, java.lang.String, java.lang.String)} method
* with given arguments, and returns a list of bound values.
*
* @param catalog a value for {@code catalog} parameter.
* @param schema a value for {@code schema} parameter.
* @param table a value for {@code table} parameter.
* @return a list of bound values.
* @throws SQLException if a database error occurs.
* @see #getExportedKeys(String, String, String, Consumer)
*/
public List getExportedKeys(final String catalog, final String schema, final String table)
throws SQLException {
final List list = new ArrayList<>();
getExportedKeys(catalog, schema, table, list::add);
return list;
}
/**
* Retrieves exported keys of specified table.
*
* @param table the table whose exported keys are retrieved.
* @return a list of exported keys of the {@code table}.
* @throws SQLException if a database error occurs.
* @see #getExportedKeys(String, String, String)
*/
List getExportedKeys(final Table table) throws SQLException {
Objects.requireNonNull(table, "table is null");
return getExportedKeys(
table.getTableCatNonNull(),
table.getTableSchemNonNull(),
Objects.requireNonNull(table.getTableName(), "table.tableName is null")
);
}
/**
* Invokes {@link DatabaseMetaData#getFunctions(String, String, String)} method with given arguments, and accepts
* each bound value to specified consumer.
*
* @param catalog a value for {@code catalog} parameter.
* @param schemaPattern a value for {@code schemaPattern} parameter.
* @param functionNamePattern a value for {@code functionNamePattern} parameter.
* @param consumer the consumer to which bound values are accepted.
* @throws SQLException if a database error occurs.
* @see DatabaseMetaData#getFunctions(String, String, String)
*/
public void getFunctions(final String catalog, final String schemaPattern, final String functionNamePattern,
final Consumer consumer)
throws SQLException {
Objects.requireNonNull(consumer, "consumer is null");
try (ResultSet results = databaseMetaData.getFunctions(catalog, schemaPattern, functionNamePattern)) {
assert results != null;
bind(results, Function.class, consumer);
}
}
/**
* Invokes {@link DatabaseMetaData#getFunctions(String, String, String)} method with given arguments, and returns a
* list of bound values.
*
* @param catalog a value for {@code catalog} parameter.
* @param schemaPattern a value for {@code schemaPattern} parameter.
* @param functionNamePattern a value for {@code functionNamePattern} parameter.
* @return a list of bound values.
* @throws SQLException if a database error occurs.
* @see #getFunctions(String, String, String, Consumer)
*/
public List getFunctions(final String catalog, final String schemaPattern,
final String functionNamePattern)
throws SQLException {
final List list = new ArrayList<>();
getFunctions(catalog, schemaPattern, functionNamePattern, list::add);
return list;
}
/**
* Invokes {@link DatabaseMetaData#getFunctionColumns(String, String, String, String)} method with specified
* arguments, and accepts each bound value to specified consumer.
*
* @param catalog a value for {@code catalog} parameter.
* @param schemaPattern a value for {@code schemaPattern} parameter.
* @param functionNamePattern a value for {@code functionNamePattern} parameter.
* @param columnNamePattern a value for {@code columnNamePattern} parameter.
* @param consumer the consumer to which bound values are accepted.
* @throws SQLException if a database error occurs.
* @see DatabaseMetaData#getFunctionColumns(String, String, String, String)
*/
public void getFunctionColumns(final String catalog, final String schemaPattern, final String functionNamePattern,
final String columnNamePattern,
final Consumer consumer)
throws SQLException {
Objects.requireNonNull(consumer, "consumer is null");
try (ResultSet results = databaseMetaData.getFunctionColumns(
catalog, schemaPattern, functionNamePattern, columnNamePattern)) {
assert results != null;
bind(results, FunctionColumn.class, consumer);
}
}
/**
* Invokes {@link DatabaseMetaData#getFunctionColumns(String, String, String, String)} method with specified
* arguments, and returns a list of bound values.
*
* @param catalog a value for {@code catalog} parameter.
* @param schemaPattern a value for {@code schemaPattern} parameter.
* @param functionNamePattern a value for {@code functionNamePattern} parameter.
* @param columnNamePattern a value for {@code columnNamePattern} parameter.
* @return a list of bound values.
* @throws SQLException if a database error occurs.
* @see #getFunctionColumns(String, String, String, String, Consumer)
*/
public List getFunctionColumns(final String catalog, final String schemaPattern,
final String functionNamePattern, final String columnNamePattern)
throws SQLException {
final List list = new ArrayList<>();
getFunctionColumns(catalog, schemaPattern, functionNamePattern, columnNamePattern, list::add);
return list;
}
/**
* Invokes {@link DatabaseMetaData#getFunctionColumns(String, String, String, String)} method with specified
* arguments, and returns a list of bound values.
*
* @param function the function whose columns are retrieved.
* @param columnNamePattern a value for {@code columnNamePattern} parameter.
* @return a list of bound values.
* @throws SQLException if a database error occurs.
* @see #getFunctionColumns(String, String, String, String)
*/
List getFunctionColumns(final Function function, final String columnNamePattern)
throws SQLException {
Objects.requireNonNull(function, "function is null");
return getFunctionColumns(
function.getFunctionCatNonNull(),
function.getFunctionSchemNonNull(),
Objects.requireNonNull(function.getFunctionName(), "function.functionName is null"),
columnNamePattern
);
}
/**
* Invokes {@link DatabaseMetaData#getImportedKeys(String, String, String)} method with given arguments, and accepts
* each bound value to specified consumer.
*
* @param catalog a value for {@code catalog} parameter.
* @param schema a value for {@code schema} parameter.
* @param table a value for {@code table} parameter.
* @param consumer the consumer to which bound values are accepted.
* @throws SQLException if a database error occurs.
* @see DatabaseMetaData#getImportedKeys(String, String, String)
*/
public void getImportedKeys(final String catalog, final String schema, final String table,
final Consumer consumer)
throws SQLException {
Objects.requireNonNull(consumer, "consumer is null");
try (ResultSet results = databaseMetaData.getImportedKeys(catalog, schema, table)) {
assert results != null;
bind(results, ImportedKey.class, consumer);
}
}
/**
* Invokes {@link DatabaseMetaData#getImportedKeys(String, String, String)} method with given arguments, and returns
* a list of bound values.
*
* @param catalog a value for {@code catalog} parameter.
* @param schema a value for {@code schema} parameter.
* @param table a value for {@code table} parameter.
* @return a list of bound values.
* @throws SQLException if a database error occurs.
* @see #getImportedKeys(String, String, String, Consumer)
*/
public List getImportedKeys(final String catalog, final String schema, final String table)
throws SQLException {
final List list = new ArrayList<>();
getImportedKeys(catalog, schema, table, list::add);
return list;
}
/**
* Retrieves imported keys of specified table.
*
* @param table the table whose imported keys are retrieved.
* @return a list of imported keys of the {@code table}.
* @throws SQLException if a database error occurs.
* @see #getImportedKeys(String, String, String)
*/
List getImportedKeys(final Table table) throws SQLException {
Objects.requireNonNull(table, "table is null");
return getImportedKeys(
table.getTableCatNonNull(),
table.getTableSchemNonNull(),
Objects.requireNonNull(table.getTableName(), "table.tableName is null")
);
}
/**
* Invokes {@link DatabaseMetaData#getIndexInfo(String, String, String, boolean, boolean)} method with specified
* arguments, and accepts bound value to specified consumer.
*
* @param catalog a value for {@code catalog} parameter.
* @param schema a value for {@code schema} parameter.
* @param table a value for {@code table} parameter.
* @param unique a value for {@code unique} parameter.
* @param approximate a value for {@code approximate} parameter.
* @param consumer the consumer to which bound values are accepted.
* @throws SQLException if a database error occurs.
* @see DatabaseMetaData#getIndexInfo(String, String, String, boolean, boolean)
*/
public void getIndexInfo(final String catalog, final String schema, final String table, final boolean unique,
final boolean approximate, final Consumer consumer)
throws SQLException {
Objects.requireNonNull(consumer, "consumer is null");
try (ResultSet results = databaseMetaData.getIndexInfo(catalog, schema, table, unique, approximate)) {
assert results != null;
bind(results, IndexInfo.class, consumer);
}
}
/**
* Invokes {@link DatabaseMetaData#getIndexInfo(String, String, String, boolean, boolean)} method with specified
* arguments, and returns a list of bound values.
*
* @param catalog a value for {@code catalog} parameter.
* @param schema a value for {@code schema} parameter.
* @param table a value for {@code table} parameter.
* @param unique a value for {@code unique} parameter.
* @param approximate a value for {@code approximate} parameter.
* @return a list of bound values.
* @throws SQLException if a database error occurs.
* @see #getIndexInfo(String, String, String, boolean, boolean, Consumer)
*/
public List getIndexInfo(final String catalog, final String schema, final String table,
final boolean unique, final boolean approximate)
throws SQLException {
final List list = new ArrayList<>();
getIndexInfo(catalog, schema, table, unique, approximate, list::add);
return list;
}
List getIndexInfo(final Table table, final boolean unique, final boolean approximate)
throws SQLException {
Objects.requireNonNull(table, "table is null");
return getIndexInfo(
table.getTableCatNonNull(),
table.getTableSchemNonNull(),
Objects.requireNonNull(table.getTableName(), "table.tableName is null"),
unique,
approximate
);
}
/**
* Invokes {@link DatabaseMetaData#getPrimaryKeys(String, String, String)} method with given arguments, and accepts
* each bound value to specified consumer.
*
* @param catalog a value for {@code catalog} parameter.
* @param schema a value for {@code schema} parameter.
* @param table a value for {@code table} parameter.
* @param consumer the consumer to which bound values are accepted.
* @throws SQLException if a database error occurs.
* @see DatabaseMetaData#getPrimaryKeys(String, String, String)
*/
public void getPrimaryKeys(final String catalog, final String schema, final String table,
final Consumer consumer)
throws SQLException {
Objects.requireNonNull(consumer, "consumer is null");
try (ResultSet results = databaseMetaData.getPrimaryKeys(catalog, schema, table)) {
assert results != null;
bind(results, PrimaryKey.class, consumer);
}
}
/**
* Invokes {@link DatabaseMetaData#getPrimaryKeys(String, String, String)} method with given arguments, and returns
* a list of bound values.
*
* @param catalog a value for {@code catalog} parameter.
* @param schema a value for {@code schema} parameter.
* @param table a value for {@code table} parameter.
* @return a list of bound values.
* @throws SQLException if a database error occurs.
* @see #getPrimaryKeys(String, String, String, Consumer)
*/
public List getPrimaryKeys(final String catalog, final String schema, final String table)
throws SQLException {
final List list = new ArrayList<>();
getPrimaryKeys(catalog, schema, table, list::add);
return list;
}
List getPrimaryKeys(final Table table) throws SQLException {
Objects.requireNonNull(table, "table is null");
return getPrimaryKeys(
table.getTableCatNonNull(),
table.getTableSchemNonNull(),
Objects.requireNonNull(table.getTableName(), "table.tableName is null")
);
}
/**
* Invokes {@link DatabaseMetaData#getProcedureColumns(String, String, String, String)} method with given arguments
* , and accepts each value to specified consumer.
*
* @param catalog a value for {@code catalog} parameter.
* @param schemaPattern a value for {@code schemaPattern} parameter.
* @param procedureNamePattern a value for {@code procedureNamePattern} parameter.
* @param columnNamePattern a value for {@code columnNamePattern} parameter.
* @param consumer the consumer to which bound values are accepted.
* @throws SQLException if a database error occurs.
* @see DatabaseMetaData#getProcedureColumns(String, String, String, String)
*/
public void getProcedureColumns(final String catalog, final String schemaPattern, final String procedureNamePattern,
final String columnNamePattern,
final Consumer consumer)
throws SQLException {
Objects.requireNonNull(consumer, "consumer is null");
try (ResultSet results = databaseMetaData.getProcedureColumns(
catalog, schemaPattern, procedureNamePattern, columnNamePattern)) {
assert results != null;
bind(results, ProcedureColumn.class, consumer);
}
}
/**
* Invokes {@link DatabaseMetaData#getProcedureColumns(String, String, String, String)} method with given arguments
* , and returns a list of bound values.
*
* @param catalog a value for {@code catalog} parameter.
* @param schemaPattern a value for {@code schemaPattern} parameter.
* @param procedureNamePattern a value for {@code procedureNamePattern} parameter.
* @param columnNamePattern a value for {@code columnNamePattern} parameter.
* @return a list of bound values.
* @throws SQLException if a database error occurs.
* @see #getProcedureColumns(String, String, String, String, Consumer)
*/
public List getProcedureColumns(final String catalog, final String schemaPattern,
final String procedureNamePattern,
final String columnNamePattern)
throws SQLException {
final List list = new ArrayList<>();
getProcedureColumns(catalog, schemaPattern, procedureNamePattern, columnNamePattern, list::add);
return list;
}
List getProcedureColumns(final Procedure procedure, final String columnNamePattern)
throws SQLException {
Objects.requireNonNull(procedure, "procedure is null");
Objects.requireNonNull(columnNamePattern, "columnNamePattern is null");
return getProcedureColumns(
procedure.getProcedureCatNonNull(),
procedure.getProcedureSchemNonNull(),
procedure.getProcedureName(),
columnNamePattern
);
}
/**
* Invokes {@link DatabaseMetaData#getProcedures(java.lang.String, java.lang.String, java.lang.String)} method with
* given arguments, and accepts each bounds value to specified consumer.
*
* @param catalog a value for {@code catalog} parameter.
* @param schemaPattern a value for {@code schemaPattern} parameter.
* @param procedureNamePattern a value for {@code procedureNamePattern} parameter.
* @param consumer the consumer to which bound values are accepted.
* @throws SQLException if a database error occurs.
* @see DatabaseMetaData#getProcedures(String, String, String)
*/
public void getProcedures(final String catalog, final String schemaPattern, final String procedureNamePattern,
final Consumer consumer)
throws SQLException {
Objects.requireNonNull(consumer, "consumer is null");
try (ResultSet results = databaseMetaData.getProcedures(catalog, schemaPattern, procedureNamePattern)) {
assert results != null;
bind(results, Procedure.class, consumer);
}
}
/**
* Invokes {@link DatabaseMetaData#getProcedures(java.lang.String, java.lang.String, java.lang.String)} method with
* given arguments, and returns a lsit of bound values.
*
* @param catalog a value for {@code catalog} parameter.
* @param schemaPattern a value for {@code schemaPattern} parameter.
* @param procedureNamePattern a value for {@code procedureNamePattern} parameter.
* @return a list of bound values.
* @throws SQLException if a database error occurs.
* @see #getProcedures(String, String, String, Consumer)
*/
public List getProcedures(final String catalog, final String schemaPattern,
final String procedureNamePattern)
throws SQLException {
final List list = new ArrayList<>();
getProcedures(catalog, schemaPattern, procedureNamePattern, list::add);
return list;
}
/**
* Invokes
* {@link DatabaseMetaData#getPseudoColumns(java.lang.String, java.lang.String, java.lang.String, java.lang.String)}
* method with given arguments, and accepts each bound value to specified consumer.
*
* @param catalog a value for {@code catalog} parameter.
* @param schemaPattern a value for {@code schemaPattern} parameter.
* @param tableNamePattern a value for {@code tableNamePattern} parameter.
* @param columnNamePattern a value for {@code columnNamePattern} parameter.
* @param consumer the consumer to which bound values are accepted.
* @throws SQLException if a database error occurs.
* @see DatabaseMetaData#getPseudoColumns(String, String, String, String)
*/
public void getPseudoColumns(final String catalog, final String schemaPattern, final String tableNamePattern,
final String columnNamePattern, final Consumer consumer)
throws SQLException {
Objects.requireNonNull(consumer, "consumer is null");
try (ResultSet results = databaseMetaData.getPseudoColumns(
catalog, schemaPattern, tableNamePattern, columnNamePattern)) {
assert results != null;
bind(results, PseudoColumn.class, consumer);
}
}
/**
* Invokes
* {@link 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.
*
* @param catalog a value for {@code catalog} parameter.
* @param schemaPattern a value for {@code schemaPattern} parameter.
* @param tableNamePattern a value for {@code tableNamePattern} parameter.
* @param columnNamePattern a value for {@code columnNamePattern} parameter.
* @return a list of bound values.
* @throws SQLException if a database error occurs.
* @see #getPseudoColumns(String, String, String, String, Consumer)
*/
public List getPseudoColumns(final String catalog, final String schemaPattern,
final String tableNamePattern, final String columnNamePattern)
throws SQLException {
final List list = new ArrayList<>();
getPseudoColumns(catalog, schemaPattern, tableNamePattern, columnNamePattern, list::add);
return list;
}
List getPseudoColumns(final Table table, final String columnNamePattern)
throws SQLException {
Objects.requireNonNull(table, "table is null");
return getPseudoColumns(
table.getTableCatNonNull(),
table.getTableSchemNonNull(),
Objects.requireNonNull(table.getTableName(), "table.tableName is null"),
columnNamePattern
);
}
/**
* Invokes {@link DatabaseMetaData#getSchemas()} method, and accepts each bound value to specified consumer.
*
* @param consumer the consumer to which bound values are accepted.
* @throws SQLException if a database error occurs.
* @see DatabaseMetaData#getSchemas()
*/
public void getSchemas(final Consumer consumer) throws SQLException {
Objects.requireNonNull(consumer, "consumer is null");
try (ResultSet results = databaseMetaData.getSchemas()) {
assert results != null;
bind(results, Schema.class, consumer);
}
}
/**
* Invokes {@link DatabaseMetaData#getSchemas()} method, and returns a list of bound values.
*
* @return a list of bound values.
* @throws SQLException if a database error occurs.
* @see #getSchemas(Consumer)
*/
public List getSchemas() throws SQLException {
final List list = new ArrayList<>();
getSchemas(list::add);
return list;
}
/**
* Invokes {@link DatabaseMetaData#getSchemas(String, String)} method with given arguments, and accepts each bound
* value to specified consumer.
*
* @param catalog a value for {@code catalog} parameter.
* @param schemaPattern a value for {@code schemaPattern} parameter.
* @param consumer the consumer to which bound values are accepted.
* @throws SQLException if a database error occurs.
* @see DatabaseMetaData#getSchemas(String, String)
*/
public void getSchemas(final String catalog, final String schemaPattern, final Consumer consumer)
throws SQLException {
Objects.requireNonNull(consumer, "consumer is null");
try (ResultSet results = databaseMetaData.getSchemas(catalog, schemaPattern)) {
assert results != null;
bind(results, Schema.class, consumer);
}
}
/**
* Invokes {@link DatabaseMetaData#getSchemas(String, String)} method with given arguments, and returns a list of
* bound values.
*
* @param catalog a value for {@code catalog} parameter.
* @param schemaPattern a value for {@code schemaPattern} parameter.
* @return a list of bound values.
* @throws SQLException if a database error occurs.
* @see #getSchemas(String, String, Consumer)
*/
public List getSchemas(final String catalog, final String schemaPattern) throws SQLException {
final List list = new ArrayList<>();
getSchemas(catalog, schemaPattern, list::add);
return list;
}
List getSchemas(final Catalog catalog, final String schemaPattern) throws SQLException {
Objects.requireNonNull(catalog, "catalog is null");
return getSchemas(
Objects.requireNonNull(catalog.getTableCat(), "catalog.tableCat is null"),
schemaPattern
);
}
/**
* Invokes {@link DatabaseMetaData#getSuperTables(String, String, String)} method with given arguments, and accepts
* each bounds value to specified consumer.
*
* @param catalog a value for {@code catalog} parameter.
* @param schemaPattern a value for {@code schemaPattern} parameter.
* @param tableNamePattern a value for {@code tableNamePattern} parameter.
* @param consumer the consumer to which bound values are accepted.
* @throws SQLException if a database error occurs.
* @see DatabaseMetaData#getSuperTables(String, String, String)
*/
public void getSuperTables(final String catalog, final String schemaPattern, final String tableNamePattern,
final Consumer consumer)
throws SQLException {
Objects.requireNonNull(consumer, "consumer is null");
try (ResultSet results = databaseMetaData.getSuperTables(catalog, schemaPattern, tableNamePattern)) {
assert results != null;
bind(results, SuperTable.class, consumer);
}
}
/**
* Invokes {@link DatabaseMetaData#getSuperTables(String, String, String)} method with given arguments and adds
* bounds values to specified collection.
*
* @param catalog a value for {@code catalog} parameter.
* @param schemaPattern a value for {@code schemaPattern} paramter.
* @param tableNamePattern a value for {@code tableNamePattern} parameter.
* @return a list of bound values.
* @throws SQLException if a database error occurs.
* @see #getSuperTables(String, String, String, Consumer)
*/
public List getSuperTables(final String catalog, final String schemaPattern,
final String tableNamePattern)
throws SQLException {
final List list = new ArrayList<>();
getSuperTables(catalog, schemaPattern, tableNamePattern, list::add);
return list;
}
List getSuperTables(final Schema schema, final String tableNamePattern) throws SQLException {
Objects.requireNonNull(schema, "schema is null");
return getSuperTables(
schema.getTableCatalogNonNull(),
Objects.requireNonNull(schema.getTableSchem(), "schema.tableSchem is null"),
tableNamePattern
);
}
/**
* Invokes {@link DatabaseMetaData#getSuperTypes(String, String, String)} method with given arguments, and accepts
* each bound value to specified consumer.
*
* @param catalog a value for {@code catalog} parameter.
* @param schemaPattern a value for {@code schemaPattern} parameter.
* @param typeNamePattern a value for {@code typeNamePattern} parameter.
* @param consumer the consumer to which bound values are accepted.
* @throws SQLException if a database error occurs.
* @see DatabaseMetaData#getSuperTypes(String, String, String)
*/
public void getSuperTypes(final String catalog, final String schemaPattern, final String typeNamePattern,
final Consumer consumer)
throws SQLException {
Objects.requireNonNull(consumer, "consumer is null");
try (ResultSet results = databaseMetaData.getSuperTypes(catalog, schemaPattern, typeNamePattern)) {
assert results != null;
bind(results, SuperType.class, consumer);
}
}
/**
* Invokes {@link DatabaseMetaData#getSuperTypes(String, String, String)} method with given arguments, and returns a
* list of bound values.
*
* @param catalog a value for {@code catalog} parameter.
* @param schemaPattern a value for {@code schemaPattern} parameter.
* @param typeNamePattern a value for {@code typeNamePattern} parameter.
* @return a list of bound values.
* @throws SQLException if a database error occurs.
* @see #getSuperTypes(String, String, String, Consumer)
*/
public List getSuperTypes(final String catalog, final String schemaPattern, final String typeNamePattern)
throws SQLException {
final List list = new ArrayList<>();
getSuperTypes(catalog, schemaPattern, typeNamePattern, list::add);
return list;
}
List getSuperTypes(final Schema schema, final String typeNamePattern) throws SQLException {
Objects.requireNonNull(schema, "schema is null");
return getSuperTypes(
schema.getTableCatalogNonNull(),
Objects.requireNonNull(schema.getTableSchem(), "schema.tableSchem is null"),
typeNamePattern
);
}
/**
* Invokes {@link DatabaseMetaData#getTablePrivileges(java.lang.String, java.lang.String, java.lang.String)} method
* with given arguments, and accepts each bound value to specified consumer.
*
* @param catalog a value for {@code catalog} parameter.
* @param schemaPattern a value for {@code schemaPattern} parameter.
* @param tableNamePattern a value for {@code tableNamePattern} parameter.
* @param consumer the consumer to which bound values are accepted.
* @throws SQLException if a database error occurs.
* @see DatabaseMetaData#getTablePrivileges(String, String, String)
*/
public void getTablePrivileges(final String catalog, final String schemaPattern, final String tableNamePattern,
final Consumer consumer)
throws SQLException {
Objects.requireNonNull(consumer, "consumer is null");
try (ResultSet results = databaseMetaData.getTablePrivileges(catalog, schemaPattern, tableNamePattern)) {
assert results != null;
bind(results, TablePrivilege.class, consumer);
}
}
/**
* Invokes {@link DatabaseMetaData#getTablePrivileges(java.lang.String, java.lang.String, java.lang.String)} method
* with given arguments, and returns a list of bound values.
*
* @param catalog a value for {@code catalog} parameter.
* @param schemaPattern a value for {@code schemaPattern} parameter.
* @param tableNamePattern a value for {@code tableNamePattern} parameter.
* @return a list of bound values.
* @throws SQLException if a database error occurs.
* @see #getTablePrivileges(String, String, String, Consumer)
*/
public List getTablePrivileges(final String catalog, final String schemaPattern,
final String tableNamePattern)
throws SQLException {
final List list = new ArrayList<>();
getTablePrivileges(catalog, schemaPattern, tableNamePattern, list::add);
return list;
}
List getTablePrivileges(final Schema schema, final String tableNamePattern) throws SQLException {
Objects.requireNonNull(schema, "schema is null");
return getTablePrivileges(
schema.getTableCatalogNonNull(),
Objects.requireNonNull(schema.getTableSchem(), "schema.tableSchem is null"),
tableNamePattern
);
}
List getTablePrivileges(final Table table) throws SQLException {
Objects.requireNonNull(table, "table is null");
return getTablePrivileges(
table.getTableCatNonNull(),
table.getTableSchemNonNull(),
Objects.requireNonNull(table.getTableName(), "table.tableName is null")
);
}
/**
* Invokes {@link DatabaseMetaData#getTableTypes()} method, and accepts each bound value to specified consumer.
*
* @param consumer the consumer to which bound values are accepted.
* @throws SQLException if a database error occurs.
* @see DatabaseMetaData#getTableTypes()
*/
public void getTableTypes(final Consumer consumer) throws SQLException {
Objects.requireNonNull(consumer, "consumer is null");
try (ResultSet results = databaseMetaData.getTableTypes()) {
assert results != null;
bind(results, TableType.class, consumer);
}
}
/**
* Invokes {@link DatabaseMetaData#getTableTypes()} method, and returns a list of bound values.
*
* @return a list of bound values.
* @throws SQLException if a database error occurs.
* @see #getTableTypes(Consumer)
*/
public List getTableTypes() throws SQLException {
final List list = new ArrayList<>();
getTableTypes(list::add);
return list;
}
/**
* Invokes
* {@link DatabaseMetaData#getTables(java.lang.String, java.lang.String, java.lang.String, java.lang.String[])
* getTables(catalog, schemaPattern, tableNamePattern, types)} method with given arguments, and accepts each bound
* value to specified consumer.
*
* @param catalog a value for {@code catalog} parameter.
* @param schemaPattern a value for {@code schemaPattern} parameter.
* @param tableNamePattern a value for {@code tableNamePattern} parameter.
* @param types a value for {@code types} parameter.
* @param consumer the consumer to which values are accepted.
* @throws SQLException if a database error occurs.
* @see DatabaseMetaData#getTables(String, String, String, String[])
*/
public void getTables(final String catalog, final String schemaPattern, final String tableNamePattern,
final String[] types, final Consumer consumer)
throws SQLException {
Objects.requireNonNull(consumer, "consumer is null");
try (ResultSet results = databaseMetaData.getTables(catalog, schemaPattern, tableNamePattern, types)) {
assert results != null;
bind(results, Table.class, consumer);
}
}
/**
* Invokes
* {@link DatabaseMetaData#getTables(java.lang.String, java.lang.String, java.lang.String, java.lang.String[])
* getTables(catalog, schemaPattern, tableNamePattern, types)} method with given arguments, and adds each bound
* values to specified collection.
*
* @param catalog a value for {@code catalog} parameter.
* @param schemaPattern a value for {@code schemaPattern} parameter.
* @param tableNamePattern a value for {@code tableNamePattern} parameter.
* @param types a value for {@code types} parameter.
* @param collection the collection to which bound values are added.
* @return given {@code collection}.
* @throws SQLException if a database error occurs.
* @see #getTables(String, String, String, String[], Consumer)
*/
public > C getTables(final String catalog, final String schemaPattern,
final String tableNamePattern, final String[] types,
final C collection)
throws SQLException {
Objects.requireNonNull(collection, "collection is null");
getTables(catalog, schemaPattern, tableNamePattern, types, (Consumer) collection::add);
return collection;
}
/**
* Invokes
* {@link DatabaseMetaData#getTables(java.lang.String, java.lang.String, java.lang.String, java.lang.String[])
* getTables(catalog, schemaPattern, tableNamePattern, types)} method with given arguments, and returns a list of
* bound values.
*
* @param catalog a value for {@code catalog} parameter.
* @param schemaPattern a value for {@code schemaPattern} parameter.
* @param tableNamePattern a value for {@code tableNamePattern} parameter.
* @param types a value for {@code types} parameter.
* @return a list of bound values.
* @throws SQLException if a database error occurs.
* @see #getTables(String, String, String, String[], Collection)
*/
public List
getTables(final String catalog, final String schemaPattern, final String tableNamePattern,
final String[] types)
throws SQLException {
return getTables(catalog, schemaPattern, tableNamePattern, types, new ArrayList<>());
}
public List
getTables(final Schema schema, final String tableNamePattern, final String[] types)
throws SQLException {
Objects.requireNonNull(schema, "schema is null");
return getTables(
schema.getTableCatalogNonNull(),
Objects.requireNonNull(schema.getTableSchem(), "schema.tableSchem is null"),
tableNamePattern,
types
);
}
/**
* Invokes {@link DatabaseMetaData#getTypeInfo()} method, and accepts each bound value to specified consumer.
*
* @param consumer the consumer to which bound values are added.
* @throws SQLException if a database error occurs.
* @see DatabaseMetaData#getTypeInfo()
*/
public void getTypeInfo(final Consumer consumer) throws SQLException {
Objects.requireNonNull(consumer, "consumer is null");
try (ResultSet results = databaseMetaData.getTypeInfo()) {
assert results != null;
bind(results, TypeInfo.class, consumer);
}
}
/**
* Invokes {@link DatabaseMetaData#getTypeInfo()} method, and returns a list of bound values.
*
* @return a list of bound values.
* @throws SQLException if a database error occurs.
* @see #getTypeInfo(Consumer)
*/
public List getTypeInfo() throws SQLException {
final List list = new ArrayList<>();
getTypeInfo(list::add);
return list;
}
/**
* Invokes {@link DatabaseMetaData#getUDTs(java.lang.String, java.lang.String, java.lang.String, int[])} method with
* given arguments, and accepts each bound value to specified consumer.
*
* @param catalog a value for {@code catalog} parameter.
* @param schemaPattern a value for {@code schemaPattern} parameter
* @param typeNamePattern a value for {@code typeNamePattern} parameter.
* @param types a value for {@code type} parameter
* @param consumer the consumer to which bound values are accepted.
* @throws SQLException if a database error occurs.
* @see DatabaseMetaData#getUDTs(String, String, String, int[])
*/
public void getUDTs(final String catalog, final String schemaPattern, final String typeNamePattern,
final int[] types, final Consumer consumer)
throws SQLException {
Objects.requireNonNull(consumer, "consumer is null");
try (ResultSet results = databaseMetaData.getUDTs(catalog, schemaPattern, typeNamePattern, types)) {
assert results != null;
bind(results, UDT.class, consumer);
}
}
/**
* Invokes {@link DatabaseMetaData#getUDTs(java.lang.String, java.lang.String, java.lang.String, int[])} method with
* given arguments, and returns a list of bound values.
*
* @param catalog a value for {@code catalog} parameter.
* @param schemaPattern a value for {@code schemaPattern} parameter
* @param typeNamePattern a value for {@code typeNamePattern} parameter.
* @param types a value for {@code type} parameter
* @return a list of bound values.
* @throws SQLException if a database error occurs.
* @see #getUDTs(String, String, String, int[], Consumer)
*/
public List getUDTs(final String catalog, final String schemaPattern, final String typeNamePattern,
final int[] types)
throws SQLException {
final List list = new ArrayList<>();
getUDTs(catalog, schemaPattern, typeNamePattern, types, list::add);
return list;
}
/**
* Invokes {@link DatabaseMetaData#getVersionColumns(java.lang.String, java.lang.String, java.lang.String)} method
* with given arguments, and accepts each bound value to specified consumer.
*
* @param catalog a value for {@code catalog} parameter.
* @param schema a value for {@code schema} parameter.
* @param table a value for {@code table} parameter.
* @param consumer the consumer to which bound values are accepted.
* @throws SQLException if a database access error occurs.
* @see DatabaseMetaData#getVersionColumns(String, String, String)
*/
public void getVersionColumns(final String catalog, final String schema, final String table,
final Consumer consumer)
throws SQLException {
Objects.requireNonNull(consumer, "consumer is null");
try (ResultSet results = databaseMetaData.getVersionColumns(catalog, schema, table)) {
assert results != null;
bind(results, VersionColumn.class, consumer);
}
}
/**
* Invokes {@link DatabaseMetaData#getVersionColumns(java.lang.String, java.lang.String, java.lang.String)} method
* with given arguments, and returns a list of bound values.
*
* @param catalog a value for {@code catalog} parameter.
* @param schema a value for {@code schema} parameter.
* @param table a value for {@code table} parameter.
* @return a list of bound values.
* @throws SQLException if a database access error occurs.
* @see #getVersionColumns(String, String, String, Consumer)
*/
public List getVersionColumns(final String catalog, final String schema, final String table)
throws SQLException {
final List list = new ArrayList<>();
getVersionColumns(catalog, schema, table, list::add);
return list;
}
List getVersionColumns(final Table table) throws SQLException {
Objects.requireNonNull(table, "table is null");
return getVersionColumns(
table.getTableCatNonNull(),
table.getTableSchemNonNull(),
Objects.requireNonNull(table.getTableName(), "table.tableName is null")
);
}
private Map getLabeledFields(final Class clazz) {
Objects.requireNonNull(clazz, "clazz is null");
return Collections.unmodifiableMap(
classesAndLabeledFields.computeIfAbsent(clazz, c -> Utils.getFieldsAnnotatedWith(c, _ColumnLabel.class))
);
}
final DatabaseMetaData databaseMetaData;
private final Map, Map> classesAndLabeledFields = new HashMap<>();
}
