com.samskivert.jdbc

Class BaseLiaison

java.lang.Object

com.samskivert.jdbc.BaseLiaison

All Implemented Interfaces:

DatabaseLiaison

Direct Known Subclasses:

DefaultLiaison, HsqldbLiaison, MySQLLiaison, PostgreSQLLiaison

public abstract class BaseLiaison
extends Object
implements DatabaseLiaison

A superclass to help with the shrinking subset of SQL our supported dialects can agree on, or when there is disagreement, implement the most standard-compliant version and let the dialectal sub-classes override.

Constructor Summary

Constructors

Constructor and Description
BaseLiaison()

Method Summary

Modifier and Type	Method and Description
boolean	addColumn(Connection conn, String table, String column, ColumnDefinition newColumnDef, boolean check) Adds a column to a table with the given definition.
boolean	addColumn(Connection conn, String table, String column, String definition, boolean check) Adds a column to a table with the given definition.
boolean	addIndexToTable(Connection conn, String table, List<String> columns, String ixName, boolean unique) Adds a named index to a table on the given columns.
void	addPrimaryKey(Connection conn, String table, List<String> columns) Adds a primary key to a table of the given name and on the given columns.
boolean	changeColumn(Connection conn, String table, String column, String type, Boolean nullable, Boolean unique, String defaultValue) Alter the definition, but not the name, of a given column on a given table.
abstract String	columnSQL(String column) Returns the proper SQL to identify a column.
abstract void	createGenerator(Connection conn, String tableName, String columnName, int initialValue) Initializes the column value auto-generator described in DatabaseLiaison.lastInsertedId(java.sql.Connection, java.lang.String, java.lang.String).
boolean	createTableIfMissing(Connection conn, String table, List<String> columns, List<ColumnDefinition> definitions, List<List<String>> uniqueConstraintColumns, List<String> primaryKeyColumns) Created a new table of the given name with the given column names and column definitions; the given set of unique constraints (or null) and the given primary key columns (or null).
boolean	createTableIfMissing(Connection conn, String table, List<String> columns, List<ColumnDefinition> declarations, List<String> primaryKeyColumns) Created a new table of the given name with the given column names and column definitions; the given set of unique constraints (or null) and the given primary key columns (or null).
abstract void	deleteGenerator(Connection conn, String tableName, String columnName) Deletes the column value auto-generator described in DatabaseLiaison.lastInsertedId(java.sql.Connection, java.lang.String, java.lang.String).
boolean	dropColumn(Connection conn, String table, String column) Drops the given column from the given table.
void	dropIndex(Connection conn, String table, String index) Drops the named index from the given table.
void	dropPrimaryKey(Connection conn, String table, String pkName) Deletes the primary key from a table, if it exists.
boolean	dropTable(Connection conn, String name) Drops the given table and returns true if the table exists, else returns false.
String	expandDefinition(ColumnDefinition def) Create an SQL string that summarizes a column definition in that format generally accepted in table creation and column addition statements, e.g.
abstract String	indexSQL(String index) Returns the proper SQL to identify an index.
abstract boolean	isDuplicateRowException(SQLException sqe) Determines whether or not the supplied SQL exception was caused by a duplicate row being inserted into a table with a unique key.
abstract boolean	isTransientException(SQLException sqe) Determines whether or not the supplied SQL exception is a transient failure, meaning one that is not related to the SQL being executed, but instead to the environment at the time of execution, like the connection to the database having been lost.
int	lastInsertedId(Connection conn, Statement istmt, String table, String column) Attempts as dialect-agnostic an interface as possible to the ability of certain databases to auto-generated numerical values for i.e.
int	lastInsertedId(Connection conn, String table, String column) Deprecated.
abstract boolean	matchesURL(String url) Indicates whether or not this database liaison is the proper liaison for the specified database URL.
boolean	renameColumn(Connection conn, String table, String from, String to, ColumnDefinition newColumnDef) Alter the name, but not the definition, of a given column on a given table.
boolean	tableContainsColumn(Connection conn, String table, String column) Returns true if the specified table exists and contains a column with the specified name; false if either condition does not hold true.
boolean	tableContainsIndex(Connection conn, String table, String index) Returns true if the specified table exists and contains an index of the specified name; false if either conditions does not hold true.
boolean	tableExists(Connection conn, String name) Returns true if the table with the specified name exists, false if it does not.
abstract String	tableSQL(String table) Returns the proper SQL to identify a table.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseLiaison

public BaseLiaison()

Method Detail

matchesURL

public abstract boolean matchesURL(String url)

Description copied from interface: DatabaseLiaison

Indicates whether or not this database liaison is the proper liaison for the specified database URL.

Specified by:

matchesURL in interface DatabaseLiaison

Returns:

true if we should use this liaison for connections created with the supplied URL, false if we should not.

isDuplicateRowException

public abstract boolean isDuplicateRowException(SQLException sqe)

Description copied from interface: DatabaseLiaison

Determines whether or not the supplied SQL exception was caused by a duplicate row being inserted into a table with a unique key.

Specified by:

isDuplicateRowException in interface DatabaseLiaison

Returns:

true if the exception was caused by the insertion of a duplicate row, false if not.

isTransientException

public abstract boolean isTransientException(SQLException sqe)

Description copied from interface: DatabaseLiaison

Determines whether or not the supplied SQL exception is a transient failure, meaning one that is not related to the SQL being executed, but instead to the environment at the time of execution, like the connection to the database having been lost.

Specified by:

isTransientException in interface DatabaseLiaison

Returns:

true if the exception was thrown due to a transient failure, false if not.

lastInsertedId

@Deprecated
public int lastInsertedId(Connection conn,
                                      String table,
                                      String column)
                               throws SQLException

Deprecated.

Specified by:

lastInsertedId in interface DatabaseLiaison

Throws:

SQLException

lastInsertedId

public int lastInsertedId(Connection conn,
                          Statement istmt,
                          String table,
                          String column)
                   throws SQLException

Description copied from interface: DatabaseLiaison

Attempts as dialect-agnostic an interface as possible to the ability of certain databases to auto-generated numerical values for i.e. key columns; there is MySQL's AUTO_INCREMENT and PostgreSQL's DEFAULT nextval(sequence), for example.

Specified by:

lastInsertedId in interface DatabaseLiaison

istmt - the insert statement that generated the keys. May be null if the ORM doesn't have the statement handy.

Returns:

the requested inserted id.

Throws:

SQLException - if we are unable to obtain the last inserted id.

tableExists

public boolean tableExists(Connection conn,
                           String name)
                    throws SQLException

Description copied from interface: DatabaseLiaison

Returns true if the table with the specified name exists, false if it does not. Note: the table name is case sensitive.

Specified by:

tableExists in interface DatabaseLiaison

Throws:

SQLException

tableContainsColumn

public boolean tableContainsColumn(Connection conn,
                                   String table,
                                   String column)
                            throws SQLException

Description copied from interface: DatabaseLiaison

Returns true if the specified table exists and contains a column with the specified name; false if either condition does not hold true. Note: the names are case sensitive.

Specified by:

tableContainsColumn in interface DatabaseLiaison

Throws:

SQLException

tableContainsIndex

public boolean tableContainsIndex(Connection conn,
                                  String table,
                                  String index)
                           throws SQLException

Description copied from interface: DatabaseLiaison

Returns true if the specified table exists and contains an index of the specified name; false if either conditions does not hold true. Note: the names are case sensitive.

Specified by:

tableContainsIndex in interface DatabaseLiaison

Throws:

SQLException

addIndexToTable

public boolean addIndexToTable(Connection conn,
                               String table,
                               List<String> columns,
                               String ixName,
                               boolean unique)
                        throws SQLException

Description copied from interface: DatabaseLiaison

Adds a named index to a table on the given columns. Returns true or false if the database did or did not report a schema modification.

Specified by:

addIndexToTable in interface DatabaseLiaison

Throws:

SQLException

addPrimaryKey

public void addPrimaryKey(Connection conn,
                          String table,
                          List<String> columns)
                   throws SQLException

Description copied from interface: DatabaseLiaison

Adds a primary key to a table of the given name and on the given columns. Returns true or false if the database did nor did not report a schema modification.

Specified by:

addPrimaryKey in interface DatabaseLiaison

Throws:

SQLException

dropIndex

public void dropIndex(Connection conn,
                      String table,
                      String index)
               throws SQLException

Description copied from interface: DatabaseLiaison

Drops the named index from the given table.

Specified by:

dropIndex in interface DatabaseLiaison

Throws:

SQLException

dropPrimaryKey

public void dropPrimaryKey(Connection conn,
                           String table,
                           String pkName)
                    throws SQLException

Description copied from interface: DatabaseLiaison

Deletes the primary key from a table, if it exists.

Specified by:

dropPrimaryKey in interface DatabaseLiaison

Throws:

SQLException

addColumn

public boolean addColumn(Connection conn,
                         String table,
                         String column,
                         String definition,
                         boolean check)
                  throws SQLException

Description copied from interface: DatabaseLiaison

Adds a column to a table with the given definition. Tests for the previous existence of the column iff 'check' is true.

Specified by:

addColumn in interface DatabaseLiaison

Throws:

SQLException

addColumn

public boolean addColumn(Connection conn,
                         String table,
                         String column,
                         ColumnDefinition newColumnDef,
                         boolean check)
                  throws SQLException

Description copied from interface: DatabaseLiaison

Adds a column to a table with the given definition. Tests for the previous existence of the column iff 'check' is true.

Specified by:

addColumn in interface DatabaseLiaison

Throws:

SQLException

changeColumn

public boolean changeColumn(Connection conn,
                            String table,
                            String column,
                            String type,
                            Boolean nullable,
                            Boolean unique,
                            String defaultValue)
                     throws SQLException

Description copied from interface: DatabaseLiaison

Alter the definition, but not the name, of a given column on a given table. Returns true or false if the database did or did not report a schema modification. Any of the nullable, unique and defaultValue arguments may be null, in which case the implementation will attempt to leave that aspect of the column unchanged.

Specified by:

changeColumn in interface DatabaseLiaison

Throws:

SQLException

renameColumn

public boolean renameColumn(Connection conn,
                            String table,
                            String from,
                            String to,
                            ColumnDefinition newColumnDef)
                     throws SQLException

Description copied from interface: DatabaseLiaison

Alter the name, but not the definition, of a given column on a given table. Returns true or false if the database did or did not report a schema modification.

Specified by:

renameColumn in interface DatabaseLiaison

newColumnDef - the full definition of the new column, including its new name (MySQL requires this for a column rename).

Throws:

SQLException

createGenerator

public abstract void createGenerator(Connection conn,
                                     String tableName,
                                     String columnName,
                                     int initialValue)
                              throws SQLException

Description copied from interface: DatabaseLiaison

Initializes the column value auto-generator described in DatabaseLiaison.lastInsertedId(java.sql.Connection, java.lang.String, java.lang.String). This should be idempotent (meaning the generator may already exist in which case this method should have no negative effect like resetting it).

Specified by:

createGenerator in interface DatabaseLiaison

Throws:

SQLException

deleteGenerator

public abstract void deleteGenerator(Connection conn,
                                     String tableName,
                                     String columnName)
                              throws SQLException

Description copied from interface: DatabaseLiaison

Deletes the column value auto-generator described in DatabaseLiaison.lastInsertedId(java.sql.Connection, java.lang.String, java.lang.String).

Specified by:

deleteGenerator in interface DatabaseLiaison

Throws:

SQLException

dropColumn

public boolean dropColumn(Connection conn,
                          String table,
                          String column)
                   throws SQLException

Description copied from interface: DatabaseLiaison

Drops the given column from the given table. Returns true or false if the database did or did not report a schema modification.

Specified by:

dropColumn in interface DatabaseLiaison

Throws:

SQLException

createTableIfMissing

public boolean createTableIfMissing(Connection conn,
                                    String table,
                                    List<String> columns,
                                    List<ColumnDefinition> declarations,
                                    List<String> primaryKeyColumns)
                             throws SQLException

Description copied from interface: DatabaseLiaison

Created a new table of the given name with the given column names and column definitions; the given set of unique constraints (or null) and the given primary key columns (or null). Returns true if the table was successfully created, false if it already existed.

Specified by:

createTableIfMissing in interface DatabaseLiaison

Throws:

SQLException

createTableIfMissing

public boolean createTableIfMissing(Connection conn,
                                    String table,
                                    List<String> columns,
                                    List<ColumnDefinition> definitions,
                                    List<List<String>> uniqueConstraintColumns,
                                    List<String> primaryKeyColumns)
                             throws SQLException

Description copied from interface: DatabaseLiaison

Created a new table of the given name with the given column names and column definitions; the given set of unique constraints (or null) and the given primary key columns (or null). Returns true if the table was successfully created, false if it already existed.

Specified by:

createTableIfMissing in interface DatabaseLiaison

Throws:

SQLException

dropTable

public boolean dropTable(Connection conn,
                         String name)
                  throws SQLException

Description copied from interface: DatabaseLiaison

Drops the given table and returns true if the table exists, else returns false. Note: the table name is case sensitive.

Specified by:

dropTable in interface DatabaseLiaison

Throws:

SQLException

tableSQL

public abstract String tableSQL(String table)

Description copied from interface: DatabaseLiaison

Returns the proper SQL to identify a table. Some databases require table names to be quoted.

Specified by:

tableSQL in interface DatabaseLiaison

columnSQL

public abstract String columnSQL(String column)

Description copied from interface: DatabaseLiaison

Returns the proper SQL to identify a column. Some databases require columns names to be quoted.

Specified by:

columnSQL in interface DatabaseLiaison

indexSQL

public abstract String indexSQL(String index)

Description copied from interface: DatabaseLiaison

Returns the proper SQL to identify an index. Some databases require index names to be quoted.

Specified by:

indexSQL in interface DatabaseLiaison

expandDefinition

public String expandDefinition(ColumnDefinition def)

Create an SQL string that summarizes a column definition in that format generally accepted in table creation and column addition statements, e.g. INTEGER UNIQUE NOT NULL DEFAULT 100.

Specified by:

expandDefinition in interface DatabaseLiaison