org.specrunner.sql.database.impl

Class DatabaseDefault

java.lang.Object

org.specrunner.sql.database.impl.DatabaseDefault

All Implemented Interfaces:

Serializable, IDestructable, INullEmptyFeature, IDatabase, IDatabaseReader, IResetable

public class DatabaseDefault
extends Object
implements IDatabase

Basic implementation of IDatabase using cached prepared statements, an ID manager to work with generated keys, a sequence provider to enable sequence interactions and a column reader to recover column objects.

Author:

Thiago Santos

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected IColumnReader	columnReader Recover object from a result set column to be compared against the specification object.
protected MessageDigest	digester Message digester.
static String	FEATURE_FILTER Feature for comparison filter.
static String	FEATURE_LIMIT Feature for database error dump limit.
static String	FEATURE_MD5_KEYS Feature to use MD5 keys on cache.
protected IIdManager	idManager Manage object lookup and reuse.
protected List<IDatabaseListener>	listeners List of listeners.
protected Boolean	md5Keys Use tables MD5 as keys.
protected String	name Database name.
protected INullEmptyHandler	nullEmptyHandler A null/empty handler.
protected Boolean	reuseScripts Reuse script status.
protected ISequenceProvider	sequenceProvider Sequence next value generator.
protected ISqlWrapperFactory	sqlWrapperFactory Factory of SQLs.
protected IStatementFactory	statementFactory Factory of statements.
protected static ICache<String,String>	xmlToSql Cache of tables tables to scripts.

Fields inherited from interface org.specrunner.sql.database.IDatabase

FEATURE_ID_MANAGER, FEATURE_LISTENERS, FEATURE_REUSE_SCRIPTS, FEATURE_SEQUENCE_PROVIDER, FEATURE_SQL_WRAPPER_FACTORY, FEATURE_STATEMENT_FACTORY

Fields inherited from interface org.specrunner.expressions.INullEmptyFeature

FEATURE_NULL_EMPTY_HANDLER

Fields inherited from interface org.specrunner.sql.database.IDatabaseReader

FEATURE_COLUMN_READER

Constructor Summary

Constructors

Constructor and Description
DatabaseDefault()

Method Summary

Modifier and Type	Method and Description
protected void	addMissingValues(EMode mode, Table table, IDataFilter afilter, IRegister register, Map<String,Value> filled, Map<String,CellAdapter> missing) Add missing values to insert value set.
protected void	compareRegister(IContext context, IResultSet result, Connection connection, IRegister register, Map<String,Integer> namesToIndexes, ResultSet rs) Compare register with current result set item.
void	destroy()
protected String	dumpRs(String prefix, ResultSet rs) Dump result set.
protected void	fireInitialize() Fire initialize event.
protected void	fireRegisterIn(DatabaseRegisterEvent event) Fire register in event.
protected void	fireRegisterOut(DatabaseRegisterEvent event) Fire register out event.
protected void	fireTableIn(DatabaseTableEvent event) Fire table in event.
protected void	fireTableOut(DatabaseTableEvent event) Fire table out event.
protected String	getAdjustContent(IContext context, EMode mode, CommandType command, Column column, IDataFilter afilter, INodeHolder nh) Get the string value of a node holder, and adjust text if required.
IColumnReader	getColumnReader() Get current column reader.
String	getFilter() Get the filter name.
protected IDataFilter	getFilter(IContext context, EMode mode, Schema schema) Recover filter from context.
IIdManager	getIdManager() Get the id manager.
Integer	getLimit() Get the error dump limit.
List<IDatabaseListener>	getListeners() Get listeners.
Boolean	getMd5Keys() Check if MD5 keys are enabled.
String	getName() Get database name.
INullEmptyHandler	getNullEmptyHandler() Get the null/empty handler.
Object	getObject()
Boolean	getReuseScripts() Get reuse status.
ISequenceProvider	getSequenceProvider() Get the sequence values provider.
ISqlWrapperFactory	getSqlWrapperFactory() Get the SQL wrapper factory.
IStatementFactory	getStatementFactory() Get statement factory.
protected Value	getValue(IContext context, EMode mode, CommandType command, Column column, IDataFilter afilter, CellAdapter td, String content) Get value object for a given cell.
void	initialize()
void	perform(IContext context, IResultSet result, TableAdapter adapter, Connection connection, Schema schema, EMode mode) Perform some actions in a database.
protected void	performDelete(IContext context, IResultSet result, Connection connection, Table table, IRegister register, int expectedCount) Perform database deletes.
protected void	performIn(IContext context, IResultSet result, Connection connection, SqlWrapper wrapper, Table table, IRegister register) Perform database commands.
protected void	performInsert(IContext context, IResultSet result, Connection connection, EMode mode, Table table, IDataFilter afilter, IRegister register, Map<String,Value> filled, Map<String,CellAdapter> missing) Perform database inserts.
protected void	performOut(IContext context, IResultSet result, Connection connection, SqlWrapper wrapper, Table table, IRegister register) Perform database selects.
protected void	performSelect(IContext context, IResultSet result, Connection connection, Table table, CommandType command, IRegister register, int expectedCount) Perform database select verifications.
protected void	performUpdate(IContext context, IResultSet result, Connection connection, Table table, IRegister register, int expectedCount) Perform database updates.
protected Map<Integer,Object>	prepareInputValues(IContext context, Table table, IRegister register, Map<String,Integer> namesToIndexes) Prepare values to use in insert/update/delete.
protected Map<Integer,Object>	prepareSelectValues(IContext context, Connection connection, IRegister register, Map<String,Integer> namesToIndexes) Prepare values to use in select.
protected void	processTable(IContext context, IResultSet result, TableAdapter adapter, Connection connection, EMode mode, IDataFilter afilter, Table table) Process a data table.
protected void	readHeadersColumns(IContext context, EMode mode, Table table, List<CellAdapter> headers, Column[] columns, IDataFilter afilter) Read headers information.
void	release() Release database resources.
void	setColumnReader(IColumnReader columnReader) Set a column reader.
void	setFilter(String filter) Set the filter name.
void	setIdManager(IIdManager idManager) Set the manager.
void	setLimit(Integer limit) Set error limit.
void	setListeners(List<IDatabaseListener> listeners) Set database listeners.
void	setMd5Keys(Boolean md5Keys) Set MD5 flag.
void	setName(String name) Set database name.
void	setNullEmptyHandler(INullEmptyHandler nullEmptyHandler)
void	setReuseScripts(Boolean reuseScripts) Flag to set reuse scripts status.
void	setSequenceProvider(ISequenceProvider sequenceProvider) Set the sequence provider.
void	setSqlWrapperFactory(ISqlWrapperFactory sqlWrapperFactory) Set SQL wrapper.
void	setStatementFactory(IStatementFactory statementFactory) Set statement factory.
protected void	shortView(CellAdapter cell, Object expected, String expStr, String recStr) Create an error information to append to a cell.
protected Object	value(Column c, Object exp) Recover better representation for a value.

Methods inherited from class java.lang.Object

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

Field Detail

FEATURE_FILTER

public static final String FEATURE_FILTER

Feature for comparison filter.

nullEmptyHandler

protected INullEmptyHandler nullEmptyHandler

A null/empty handler.

sequenceProvider

protected ISequenceProvider sequenceProvider

Sequence next value generator.

columnReader

protected IColumnReader columnReader

Recover object from a result set column to be compared against the specification object.

sqlWrapperFactory

protected ISqlWrapperFactory sqlWrapperFactory

Factory of SQLs.

statementFactory

protected IStatementFactory statementFactory

Factory of statements.

idManager

protected IIdManager idManager

Manage object lookup and reuse.

listeners

protected List<IDatabaseListener> listeners

List of listeners.

reuseScripts

protected Boolean reuseScripts

Reuse script status.

name

protected String name

Database name.

xmlToSql

protected static ICache<String,String> xmlToSql

Cache of tables tables to scripts.

FEATURE_MD5_KEYS

public static final String FEATURE_MD5_KEYS

Feature to use MD5 keys on cache.

md5Keys

protected Boolean md5Keys

Use tables MD5 as keys.

digester

protected MessageDigest digester

Message digester.

FEATURE_LIMIT

public static final String FEATURE_LIMIT

Feature for database error dump limit.

Constructor Detail

DatabaseDefault

public DatabaseDefault()

Method Detail

initialize

public void initialize()

Specified by:

initialize in interface IResetable

getFilter

public String getFilter()

Get the filter name.

Returns:

The name.

setFilter

public void setFilter(String filter)

Set the filter name.

Parameters:

filter - Name.

getNullEmptyHandler

public INullEmptyHandler getNullEmptyHandler()

Get the null/empty handler.

Returns:

Current null/empty handler.

setNullEmptyHandler

public void setNullEmptyHandler(INullEmptyHandler nullEmptyHandler)

Specified by:

setNullEmptyHandler in interface INullEmptyFeature

getSequenceProvider

public ISequenceProvider getSequenceProvider()

Get the sequence values provider.

Returns:

The provider.

setSequenceProvider

public void setSequenceProvider(ISequenceProvider sequenceProvider)

Description copied from interface: IDatabase

Set the sequence provider.

Specified by:

setSequenceProvider in interface IDatabase

Parameters:

sequenceProvider - A provider.

getColumnReader

public IColumnReader getColumnReader()

Get current column reader.

Returns:

The current reader.

setColumnReader

public void setColumnReader(IColumnReader columnReader)

Description copied from interface: IDatabaseReader

Set a column reader.

Specified by:

setColumnReader in interface IDatabaseReader

Parameters:

columnReader - A reader.

getSqlWrapperFactory

public ISqlWrapperFactory getSqlWrapperFactory()

Get the SQL wrapper factory.

Returns:

The current factory.

setSqlWrapperFactory

public void setSqlWrapperFactory(ISqlWrapperFactory sqlWrapperFactory)

Description copied from interface: IDatabase

Set SQL wrapper.

Specified by:

setSqlWrapperFactory in interface IDatabase

Parameters:

sqlWrapperFactory - A factory.

getStatementFactory

public IStatementFactory getStatementFactory()

Get statement factory.

Returns:

The current factory.

setStatementFactory

public void setStatementFactory(IStatementFactory statementFactory)

Description copied from interface: IDatabase

Set statement factory.

Specified by:

setStatementFactory in interface IDatabase

Parameters:

statementFactory - A factory.

getIdManager

public IIdManager getIdManager()

Get the id manager.

Returns:

The manager.

setIdManager

public void setIdManager(IIdManager idManager)

Description copied from interface: IDatabase

Set the manager.

Specified by:

setIdManager in interface IDatabase

Parameters:

idManager - The manager.

getListeners

public List<IDatabaseListener> getListeners()

Get listeners.

Returns:

Listeners.

setListeners

public void setListeners(List<IDatabaseListener> listeners)

Description copied from interface: IDatabase

Set database listeners.

Specified by:

setListeners in interface IDatabase

Parameters:

listeners - A list of listeners.

getReuseScripts

public Boolean getReuseScripts()

Get reuse status.

Returns:

true, if enabled, false, otherwise.

setReuseScripts

public void setReuseScripts(Boolean reuseScripts)

Description copied from interface: IDatabase

Flag to set reuse scripts status. Default is 'false'.

Specified by:

setReuseScripts in interface IDatabase

Parameters:

reuseScripts - Reuse scripts flag.

getName

public String getName()

Description copied from interface: IDatabase

Get database name.

Specified by:

getName in interface IDatabase

Returns:

The database name.

setName

public void setName(String name)

Description copied from interface: IDatabase

Set database name.

Specified by:

setName in interface IDatabase

Parameters:

name - Name.

getMd5Keys

public Boolean getMd5Keys()

Check if MD5 keys are enabled.

Returns:

true, if enabled, false, otherwise. Default is 'false'.

setMd5Keys

public void setMd5Keys(Boolean md5Keys)

Set MD5 flag.

Parameters:

md5Keys - true, for MD5 keys, false, otherwise.

getLimit

public Integer getLimit()

Get the error dump limit.

Returns:

The limit.

setLimit

public void setLimit(Integer limit)

Set error limit.

Parameters:

limit - The limit.

fireInitialize

protected void fireInitialize()

Fire initialize event.

fireTableIn

protected void fireTableIn(DatabaseTableEvent event)
                    throws DatabaseException

Fire table in event.

Parameters:

event - Event.

Throws:

DatabaseException - On processing errors.

fireRegisterIn

protected void fireRegisterIn(DatabaseRegisterEvent event)
                       throws DatabaseException

Fire register in event.

Parameters:

event - Event.

Throws:

DatabaseException - On processing errors.

fireRegisterOut

protected void fireRegisterOut(DatabaseRegisterEvent event)
                        throws DatabaseException

Fire register out event.

Parameters:

event - Event.

Throws:

DatabaseException - On processing errors.

fireTableOut

protected void fireTableOut(DatabaseTableEvent event)
                     throws DatabaseException

Fire table out event.

Parameters:

event - Event.

Throws:

DatabaseException - On processing errors.

perform

public void perform(IContext context,
                    IResultSet result,
                    TableAdapter adapter,
                    Connection connection,
                    Schema schema,
                    EMode mode)
             throws DatabaseException

Description copied from interface: IDatabase

Perform some actions in a database.

Specified by:

perform in interface IDatabase

Parameters:

context - The test context.

result - The result set.

adapter - The specification table.

connection - The connection.

schema - The database meta model.

mode - The database mode (in - actions|out - asserts)

Throws:

DatabaseException - On perform errors.

processTable

protected void processTable(IContext context,
                            IResultSet result,
                            TableAdapter adapter,
                            Connection connection,
                            EMode mode,
                            IDataFilter afilter,
                            Table table)
                     throws DatabaseException

Process a data table.

Parameters:

context - A context.

result - A result.

adapter - A table adapter.

connection - A connection.

mode - A mode.

afilter - A filter.

table - A schema table.

Throws:

DatabaseException - On processing errors.

getFilter

protected IDataFilter getFilter(IContext context,
                                EMode mode,
                                Schema schema)
                         throws DatabaseException

Recover filter from context.

Parameters:

context - A context.

mode - Database mode of action.

schema - A schema.

Returns:

A filter.

Throws:

DatabaseException - On lookup errors.

readHeadersColumns

protected void readHeadersColumns(IContext context,
                                  EMode mode,
                                  Table table,
                                  List<CellAdapter> headers,
                                  Column[] columns,
                                  IDataFilter afilter)
                           throws DatabaseException

Read headers information.

Parameters:

context - The test context.

mode - Database mode of action.

table - The current table.

headers - The headers list.

columns - The columns list.

afilter - A filter.

Throws:

DatabaseException - On reading errors.

getAdjustContent

protected String getAdjustContent(IContext context,
                                  EMode mode,
                                  CommandType command,
                                  Column column,
                                  IDataFilter afilter,
                                  INodeHolder nh)
                           throws DatabaseException

Get the string value of a node holder, and adjust text if required.

Parameters:

context - The context.

mode - The database mode.

command - Current line command.

column - The column definition.

afilter - A filter.

nh - A node holder.

Returns:

The cell as string value.

Throws:

DatabaseException - On evaluation errors.

getValue

protected Value getValue(IContext context,
                         EMode mode,
                         CommandType command,
                         Column column,
                         IDataFilter afilter,
                         CellAdapter td,
                         String content)
                  throws ConverterException,
                         DatabaseException,
                         FormatterException

Get value object for a given cell.

Parameters:

context - A context.

mode - Action mode.

command - Command type.

column - Column meta-data.

afilter - A filter.

td - The cell.

content - Cell content.

Returns:

A value, if valid, null, otherwise.

Throws:

ConverterException - On conversion errors.

DatabaseException - On default value.

FormatterException - On format errors.

performInsert

protected void performInsert(IContext context,
                             IResultSet result,
                             Connection connection,
                             EMode mode,
                             Table table,
                             IDataFilter afilter,
                             IRegister register,
                             Map<String,Value> filled,
                             Map<String,CellAdapter> missing)
                      throws DatabaseException,
                             SQLException

Perform database inserts.

Parameters:

context - The context.

result - The result set.

connection - The connection.

mode - Database mode of action.

table - The specification.

afilter - A filter.

register - The values.

filled - Filled fields.

missing - Unfilled columns.

Throws:

DatabaseException - On database errors.

SQLException - On SQL errors.

addMissingValues

protected void addMissingValues(EMode mode,
                                Table table,
                                IDataFilter afilter,
                                IRegister register,
                                Map<String,Value> filled,
                                Map<String,CellAdapter> missing)
                         throws DatabaseException

Add missing values to insert value set.

Parameters:

mode - Database mode of action.

table - The table.

afilter - A filter.

register - The set of values.

filled - A map of filled fields.

missing - A map of unfilled fields.

Throws:

DatabaseException - On default value construction error.

performUpdate

protected void performUpdate(IContext context,
                             IResultSet result,
                             Connection connection,
                             Table table,
                             IRegister register,
                             int expectedCount)
                      throws DatabaseException,
                             SQLException

Perform database updates.

Parameters:

context - The context.

result - The result set.

connection - The connection.

table - The specification.

register - The values.

expectedCount - The expected action counter.

Throws:

DatabaseException - On database errors.

SQLException - On SQL errors.

performDelete

protected void performDelete(IContext context,
                             IResultSet result,
                             Connection connection,
                             Table table,
                             IRegister register,
                             int expectedCount)
                      throws DatabaseException,
                             SQLException

Perform database deletes.

Parameters:

context - The context.

result - The result set.

connection - The connection.

table - The specification.

register - The values.

expectedCount - The delete expected count.

Throws:

DatabaseException - On database errors.

SQLException - On SQL errors.

performIn

protected void performIn(IContext context,
                         IResultSet result,
                         Connection connection,
                         SqlWrapper wrapper,
                         Table table,
                         IRegister register)
                  throws DatabaseException,
                         SQLException

Perform database commands.

Parameters:

context - The context.

result - The result set.

connection - The connection.

wrapper - The SQL wrapper.

table - The target table.

register - The values.

Throws:

DatabaseException - On database errors.

SQLException - On SQL errors.

prepareInputValues

protected Map<Integer,Object> prepareInputValues(IContext context,
                                                 Table table,
                                                 IRegister register,
                                                 Map<String,Integer> namesToIndexes)
                                          throws DatabaseException

Prepare values to use in insert/update/delete.

Parameters:

context - The test alias.

table - A table.

register - A register.

namesToIndexes - Map from indexes to values.

Returns:

A map of object to use in statement setup.

Throws:

DatabaseException - On prepare errors.

performSelect

protected void performSelect(IContext context,
                             IResultSet result,
                             Connection connection,
                             Table table,
                             CommandType command,
                             IRegister register,
                             int expectedCount)
                      throws DatabaseException,
                             SQLException

Perform database select verifications.

Parameters:

context - The context.

result - The result set.

connection - The connection.

table - The specification.

command - Command type.

register - The values.

expectedCount - The select expected count.

Throws:

DatabaseException - On database errors.

SQLException - On SQL errors.

performOut

protected void performOut(IContext context,
                          IResultSet result,
                          Connection connection,
                          SqlWrapper wrapper,
                          Table table,
                          IRegister register)
                   throws DatabaseException,
                          SQLException

Perform database selects.

Parameters:

context - The context.

result - The result set.

connection - The connection.

wrapper - The SQL wrapper.

table - The output table.

register - The values.

Throws:

DatabaseException - On database errors.

SQLException - On SQL errors.

prepareSelectValues

protected Map<Integer,Object> prepareSelectValues(IContext context,
                                                  Connection connection,
                                                  IRegister register,
                                                  Map<String,Integer> namesToIndexes)
                                           throws DatabaseException,
                                                  SQLException

Prepare values to use in select.

Parameters:

connection - A connection.

register - A register.

namesToIndexes - Map from indexes to values.

Returns:

A map of object to use in statement setup.

Throws:

DatabaseException - On prepare errors.

SQLException - On database errors.

compareRegister

protected void compareRegister(IContext context,
                               IResultSet result,
                               Connection connection,
                               IRegister register,
                               Map<String,Integer> namesToIndexes,
                               ResultSet rs)
                        throws DatabaseException,
                               SQLException

Compare register with current result set item.

Parameters:

context - The test context.

result - The result.

connection - The connection.

register - The register.

namesToIndexes - A mapping from column names to indexes.

rs - A result.

Throws:

DatabaseException - On compare errors.

SQLException - On database errors.

value

protected Object value(Column c,
                       Object exp)

Recover better representation for a value.

Parameters:

c - A column.

exp - A value.

Returns:

Object representation.

shortView

protected void shortView(CellAdapter cell,
                         Object expected,
                         String expStr,
                         String recStr)

Create an error information to append to a cell.

Parameters:

cell - A cell.

expected - Expected object.

expStr - Expected as string.

recStr - Received as string.

dumpRs

protected String dumpRs(String prefix,
                        ResultSet rs)
                 throws SQLException

Dump result set.

Parameters:

prefix - The message prefix.

rs - The result set.

Returns:

A string for result set.

Throws:

SQLException - On reading errors.

release

public void release()
             throws PluginException

Description copied from interface: IDatabase

Release database resources.

Specified by:

release in interface IDatabase

Throws:

PluginException - On release errors.

getObject

public Object getObject()

Specified by:

getObject in interface IDestructable

destroy

public void destroy()

Specified by:

destroy in interface IDestructable