org.restsql.core.impl

Class AbstractSqlResourceMetaData

java.lang.Object

org.restsql.core.impl.AbstractSqlResourceMetaData

All Implemented Interfaces:

SqlResourceMetaData

Direct Known Subclasses:

MySqlSqlResourceMetaData, PostgreSqlSqlResourceMetaData

public abstract class AbstractSqlResourceMetaData
extends Object
implements SqlResourceMetaData

Represents meta data for sql resource. Queries database for table and column meta data and primary and foreign keys.

Author:

Mark Sawers

Constructor Summary

Constructors

Constructor and Description
AbstractSqlResourceMetaData()

Method Summary

Methods

Modifier and Type	Method and Description
List<ColumnMetaData>	getAllReadColumns()
TableMetaData	getChild()
List<TableMetaData>	getChildPlusExtTables()
List<ColumnMetaData>	getChildReadColumns()
protected String	getColumnDatabaseName(SqlResourceDefinition definition, ResultSetMetaData resultSetMetaData, int colNumber) Retrieves database name from result set meta data.
protected String	getColumnName(SqlResourceDefinition definition, ResultSetMetaData resultSetMetaData, int colNumber) Retrieves actual column name from result set meta data.
protected String	getColumnTableName(SqlResourceDefinition definition, ResultSetMetaData resultSetMetaData, int colNumber) Retrieves table name from result set meta data.
TableMetaData	getJoin()
List<TableMetaData>	getJoinList()
int	getNumberTables()
TableMetaData	getParent()
List<TableMetaData>	getParentPlusExtTables()
List<ColumnMetaData>	getParentReadColumns()
protected abstract String	getQualifiedColumnLabel(String tableName, String qualifiedTableName, boolean readOnly, String label) Retrieves label disambiguated for duplication.
protected String	getQualifiedColumnName(String tableName, String qualifiedTableName, boolean readOnly, String name) Returns fully qualified column name in database-specific form for use in SQL statements.
protected abstract String	getQualifiedTableName(Connection connection, String databaseName, String tableName) Retrieves database-specific table name used in SQL statements.
protected abstract String	getQualifiedTableName(SqlResourceDefinition definition, ResultSetMetaData resultSetMetaData, int colNumber) Retrieves database-specific table name used in SQL statements.
protected abstract String	getSqlColumnsQuery() Retrieves sql for querying columns.
protected String	getSqlMainQuery(SqlResourceDefinition definition, SqlBuilder sqlBuilder) Retrieves sql for the main query based on the definition.
protected abstract String	getSqlPkQuery() Retrieves sql for querying primary keys.
Map<String,TableMetaData>	getTableMap()
List<TableMetaData>	getTables()
List<TableMetaData>	getWriteTables(Request.Type requestType, boolean doParent) Determines the tables to use for write, possibly substituting the parent+, child+ or join table for query tables.
boolean	hasJoinTable()
boolean	hasMultipleDatabases()
void	init(String resName, SqlResourceDefinition definition, SqlBuilder sqlBuilder) Populates metadata using definition.
protected boolean	isColumnReadOnly(ResultSetMetaData resultSetMetaData, int colNumber) Return whether a column in the given result set is read-only.
protected boolean	isDbMetaDataUpperCase() Returns true if db metadata, e.g.
boolean	isHierarchical()
protected abstract void	setSequenceMetaData(ColumnMetaDataImpl column, ResultSet resultSet) Sets sequence metadata for a column with the columns query result set.
String	toHtml() Returns HTML representation.
String	toXml() Returns XML representation.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSqlResourceMetaData

public AbstractSqlResourceMetaData()

Method Detail

getAllReadColumns

public List<ColumnMetaData> getAllReadColumns()

Specified by:

getAllReadColumns in interface SqlResourceMetaData

getChild

public TableMetaData getChild()

Specified by:

getChild in interface SqlResourceMetaData

getChildPlusExtTables

public List<TableMetaData> getChildPlusExtTables()

Specified by:

getChildPlusExtTables in interface SqlResourceMetaData

getChildReadColumns

public List<ColumnMetaData> getChildReadColumns()

Specified by:

getChildReadColumns in interface SqlResourceMetaData

getJoin

public TableMetaData getJoin()

Specified by:

getJoin in interface SqlResourceMetaData

getJoinList

public List<TableMetaData> getJoinList()

Specified by:

getJoinList in interface SqlResourceMetaData

getNumberTables

public int getNumberTables()

Specified by:

getNumberTables in interface SqlResourceMetaData

getParent

public TableMetaData getParent()

Specified by:

getParent in interface SqlResourceMetaData

getParentPlusExtTables

public List<TableMetaData> getParentPlusExtTables()

Specified by:

getParentPlusExtTables in interface SqlResourceMetaData

getParentReadColumns

public List<ColumnMetaData> getParentReadColumns()

Specified by:

getParentReadColumns in interface SqlResourceMetaData

getTableMap

public Map<String,TableMetaData> getTableMap()

Specified by:

getTableMap in interface SqlResourceMetaData

getTables

public List<TableMetaData> getTables()

Specified by:

getTables in interface SqlResourceMetaData

getWriteTables

public List<TableMetaData> getWriteTables(Request.Type requestType,
                                 boolean doParent)

Determines the tables to use for write, possibly substituting the parent+, child+ or join table for query tables.

Specified by:

getWriteTables in interface SqlResourceMetaData

hasJoinTable

public boolean hasJoinTable()

Specified by:

hasJoinTable in interface SqlResourceMetaData

hasMultipleDatabases

public boolean hasMultipleDatabases()

Specified by:

hasMultipleDatabases in interface SqlResourceMetaData

init

public void init(String resName,
        SqlResourceDefinition definition,
        SqlBuilder sqlBuilder)
          throws SqlResourceException

Populates metadata using definition.

Specified by:

init in interface SqlResourceMetaData

Throws:

SqlResourceException

isHierarchical

public boolean isHierarchical()

Specified by:

isHierarchical in interface SqlResourceMetaData

toHtml

public String toHtml()

Returns HTML representation.

Specified by:

toHtml in interface SqlResourceMetaData

toXml

public String toXml()

Returns XML representation.

Specified by:

toXml in interface SqlResourceMetaData

getColumnDatabaseName

protected String getColumnDatabaseName(SqlResourceDefinition definition,
                           ResultSetMetaData resultSetMetaData,
                           int colNumber)
                                throws SQLException

Retrieves database name from result set meta data. Hook method for buildTablesAndColumns() allows database-specific overrides.

Throws:

SQLException

getColumnName

protected String getColumnName(SqlResourceDefinition definition,
                   ResultSetMetaData resultSetMetaData,
                   int colNumber)
                        throws SQLException

Retrieves actual column name from result set meta data. Hook method for buildTablesAndColumns() allows database-specific overrides.

Throws:

SQLException

getColumnTableName

protected String getColumnTableName(SqlResourceDefinition definition,
                        ResultSetMetaData resultSetMetaData,
                        int colNumber)
                             throws SQLException

Retrieves table name from result set meta data. Hook method for buildTablesAndColumns() allows database-specific overrides.

Throws:

SQLException

getQualifiedColumnLabel

protected abstract String getQualifiedColumnLabel(String tableName,
                             String qualifiedTableName,
                             boolean readOnly,
                             String label)

Retrieves label disambiguated for duplication. Used in a result set value retrieval.

getQualifiedColumnName

protected String getQualifiedColumnName(String tableName,
                            String qualifiedTableName,
                            boolean readOnly,
                            String name)

Returns fully qualified column name in database-specific form for use in SQL statements. MySQL uses the form database.table.column, for example sakila.film.film_id. PostgreSQL uses the form database.schema.table.column, for example sakila.public.film.film_id.

Parameters:

tableName - table name

qualifiedTableName - qualified table name

readOnly - true if column is a function

name - base column name

Returns:

qualified name

getQualifiedTableName

protected abstract String getQualifiedTableName(Connection connection,
                           String databaseName,
                           String tableName)
                                         throws SQLException

Retrieves database-specific table name used in SQL statements. Used to build join table meta data.

Throws:

SQLException

getQualifiedTableName

protected abstract String getQualifiedTableName(SqlResourceDefinition definition,
                           ResultSetMetaData resultSetMetaData,
                           int colNumber)
                                         throws SQLException

Retrieves database-specific table name used in SQL statements.

Throws:

SQLException

getSqlColumnsQuery

protected abstract String getSqlColumnsQuery()

Retrieves sql for querying columns. Hook method for buildInvisibleForeignKeys() and buildJoinTableMetadata() allows database-specific overrides.

getSqlMainQuery

protected String getSqlMainQuery(SqlResourceDefinition definition,
                     SqlBuilder sqlBuilder)
                          throws InvalidRequestException

Retrieves sql for the main query based on the definition. Optimized to retrieve only one row using limit/offset. Hook method for constructor allows database-specific overrides, however the usual route for customization is through SqlBuilder.buildSelectSql().

Throws:

InvalidRequestException - if main query is invalid

getSqlPkQuery

protected abstract String getSqlPkQuery()

Retrieves sql for querying primary keys. Hook method for buildPrimaryKeys allows database-specific overrides.

isColumnReadOnly

protected boolean isColumnReadOnly(ResultSetMetaData resultSetMetaData,
                       int colNumber)
                            throws SQLException

Return whether a column in the given result set is read-only. The default implementation just calls isReadOnly() on the result set, database specific implementations can override this behavior. Contributed by rhuitl.

Parameters:

resultSetMetaData - Result set metadata

colNumber - Column number (1..N)

Throws:

SQLException - if a database access error occurs

isDbMetaDataUpperCase

protected boolean isDbMetaDataUpperCase()

Returns true if db metadata, e.g. database/owner, table and column names are stored as upper case, and therefore lookups should be forced to upper. Database specific implementation can override this response.

setSequenceMetaData

protected abstract void setSequenceMetaData(ColumnMetaDataImpl column,
                       ResultSet resultSet)
                                     throws SQLException

Sets sequence metadata for a column with the columns query result set.

Throws:

SQLException - when a database error occurs