org.specrunner.sql

Class PluginCompareBase

java.lang.Object

org.specrunner.parameters.core.ParameterHolder

org.specrunner.plugins.core.AbstractPlugin

org.specrunner.plugins.core.AbstractPluginNamed

org.specrunner.plugins.core.AbstractPluginScoped

org.specrunner.plugins.core.AbstractPluginValue

org.specrunner.sql.PluginCompareBase

All Implemented Interfaces:

INullEmptyFeature, IParameterHolder, IActionType, IParalelPlugin, IPlugin, ISleepPlugin, ITestPlugin, ITimedPlugin, IWaitPlugin, IDatabaseReader

public class PluginCompareBase
extends AbstractPluginValue
implements INullEmptyFeature, IDatabaseReader

Provided a Schema instance, and two databases, this plugin compare these databases. The database used by the system under test name is ' system' and the reference database is 'reference'. If some tables are expected to be ignored in comparison provide an instance of IFilter using PluginFilter.

Author:

Thiago Santos

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.
static String	FEATURE_FILTER Feature for comparison filter.
static String	FEATURE_REFERENCE Feature for reference datasource name.
static String	FEATURE_SCHEMA Feature for schema name.
static String	FEATURE_SYSTEM Feature for system datasource name.
static String	FEATURE_VIRTUAL Feature for virtual keys usage.
protected INullEmptyHandler	nullEmptyHandler A null/empty handler.

Fields inherited from class org.specrunner.plugins.core.AbstractPluginValue

eval, value

Fields inherited from class org.specrunner.plugins.core.AbstractPluginScoped

scope

Fields inherited from class org.specrunner.plugins.core.AbstractPluginNamed

name

Fields inherited from class org.specrunner.plugins.core.AbstractPlugin

FEATURE_CONDITION, FEATURE_NORMALIZED, FEATURE_NORMALIZER, FEATURE_SLEEP, FEATURE_THREADSAFE, FEATURE_TIMEOUT, FEATURE_WAIT

Fields inherited from class org.specrunner.parameters.core.ParameterHolder

parameters

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
PluginCompareBase()

Method Summary

Modifier and Type	Method and Description
String	createTableSelect(Schema schema, Table table) Creates the SQL to be used by comparison algorithm.
ENext	doStart(IContext context, IResultSet result)
ActionType	getActionType()
IColumnReader	getColumnReader() Column reader resource.
IResultEnumerator	getEnumerator(Table table, ResultSet rsExpected, ResultSet rsReceived) Abstraction of enumeration.
String	getFilter() Get the filter name.
INullEmptyHandler	getNullEmptyHandler() Get handler.
String	getReference() Get the reference database name.
String	getSchema() Get the schema name.
String	getSystem() Get the system database name.
Boolean	getVirtual() Indicate if reference fields can be used for select construction.
void	initialize(IContext context)
void	populateTableReport(Schema schema, IDataFilter dataFilter, SchemaReport report, Table table, ResultSet rsExpected, ResultSet rsReceived) Populate schema report.
void	setColumnReader(IColumnReader columnReader) Set a column reader.
void	setFilter(String filter) Set the filter name.
void	setNullEmptyHandler(INullEmptyHandler nullEmptyHandler)
void	setReference(String reference) Set the reference database name.
void	setSchema(String schema) Set the schema name.
void	setSystem(String system) Set the system database name.
void	setVirtual(Boolean virtual) Set the virtual flag.

Methods inherited from class org.specrunner.plugins.core.AbstractPluginValue

getValue, getValue, isEval, setEval, setValue

Methods inherited from class org.specrunner.plugins.core.AbstractPluginScoped

getScope, saveGlobal, saveLocal, saveStrict, setScope

Methods inherited from class org.specrunner.plugins.core.AbstractPluginNamed

getName, setName

Methods inherited from class org.specrunner.plugins.core.AbstractPlugin

copy, doEnd, getCondition, getConditionModel, getNormalized, getNormalized, getNormalizer, getParent, getSleep, getSleepModel, getThreadsafe, getTimeout, getTimeoutModel, getWait, getWaitModel, setCondition, setConditionModel, setNormalized, setNormalizer, setParent, setSleep, setSleepModel, setThreadsafe, setTimeout, setTimeoutModel, setWait, setWaitModel, toString

Methods inherited from class org.specrunner.parameters.core.ParameterHolder

getParameters, setParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.specrunner.parameters.IParameterHolder

getParameters, setParameters

Field Detail

FEATURE_SCHEMA

public static final String FEATURE_SCHEMA

Feature for schema name.

FEATURE_SYSTEM

public static final String FEATURE_SYSTEM

Feature for system datasource name.

FEATURE_REFERENCE

public static final String FEATURE_REFERENCE

Feature for reference datasource name.

FEATURE_FILTER

public static final String FEATURE_FILTER

Feature for comparison filter.

nullEmptyHandler

protected INullEmptyHandler nullEmptyHandler

A null/empty handler.

columnReader

protected IColumnReader columnReader

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

FEATURE_VIRTUAL

public static final String FEATURE_VIRTUAL

Feature for virtual keys usage.

Constructor Detail

PluginCompareBase

public PluginCompareBase()

Method Detail

getSchema

public String getSchema()

Get the schema name.

Returns:

The schema.

setSchema

public void setSchema(String schema)

Set the schema name.

Parameters:

schema - The name.

getSystem

public String getSystem()

Get the system database name.

Returns:

The system database name.

setSystem

public void setSystem(String system)

Set the system database name.

Parameters:

system - The database name.

getReference

public String getReference()

Get the reference database name.

Returns:

The reference name.

setReference

public void setReference(String reference)

Set the reference database name.

Parameters:

reference - The reference.

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 handler.

Returns:

A null/empty handler.

setNullEmptyHandler

public void setNullEmptyHandler(INullEmptyHandler nullEmptyHandler)

Specified by:

setNullEmptyHandler in interface INullEmptyFeature

getColumnReader

public IColumnReader getColumnReader()

Column reader resource.

Returns:

A 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.

getVirtual

public Boolean getVirtual()

Indicate if reference fields can be used for select construction.

Returns:

true, if the answer is yes, false, otherwise.

setVirtual

public void setVirtual(Boolean virtual)

Set the virtual flag.

Parameters:

virtual - The flag.

getActionType

public ActionType getActionType()

Specified by:

getActionType in interface IActionType

initialize

public void initialize(IContext context)
                throws PluginException

Specified by:

initialize in interface IPlugin

Overrides:

initialize in class AbstractPlugin

Throws:

PluginException

doStart

public ENext doStart(IContext context,
                     IResultSet result)
              throws PluginException

Specified by:

doStart in interface IPlugin

Overrides:

doStart in class AbstractPlugin

Throws:

PluginException

createTableSelect

public String createTableSelect(Schema schema,
                                Table table)

Creates the SQL to be used by comparison algorithm.

Parameters:

schema - The schema.

table - The table.

Returns:

The corresponding SQL.

populateTableReport

public void populateTableReport(Schema schema,
                                IDataFilter dataFilter,
                                SchemaReport report,
                                Table table,
                                ResultSet rsExpected,
                                ResultSet rsReceived)
                         throws SQLException

Populate schema report.

Parameters:

schema - The schema object.

dataFilter - The filter object.

report - The report.

table - The current table under analysis.

rsExpected - The result set of reference database.

rsReceived - The result set of system database.

Throws:

SQLException - On comparison errors.

getEnumerator

public IResultEnumerator getEnumerator(Table table,
                                       ResultSet rsExpected,
                                       ResultSet rsReceived)

Abstraction of enumeration.

Parameters:

table - The table source of result sets.

rsExpected - The result from querying reference database.

rsReceived - The result from querying system database.

Returns:

A enumerator.