org.specrunner.plugins.core.logical

Class PluginVerifyObjects

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

org.specrunner.plugins.core.logical.PluginVerifyObjects

All Implemented Interfaces:

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

public class PluginVerifyObjects
extends AbstractPluginTable

Field Summary

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

Constructor Summary

Constructors

Constructor and Description
PluginVerifyObjects()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	compare(IContext context, IResultSet result, IComparator comparator, CellAdapter headerExpected, CellAdapter cellExpected, Object received) Compare terminal elements.
void	doEnd(IContext context, IResultSet result, TableAdapter tableAdapter) Perform an ending action.
protected void	extraItems(IContext context, IResultSet result, TableAdapter tableAdapter, Iterator iterator) Add error for extra items in enumeration.
ActionType	getActionType() Get the plugin type.
protected String	getIterableXPath() Return the XPath expression for object attributes of type 'iterable'.
protected boolean	hasHeader(TableAdapter tableAdapter) Check if the given table has a header or not.
protected void	missingItems(IContext context, IResultSet result, TableAdapter tableAdapter, int start) Add information of missing object or terminal items.
protected List<Object>	objectToList(Object received) Convert an object to a list, if it is an array.
protected void	process(IContext context, IResultSet result, TableAdapter tableAdapter, Iterator iterator) Perform recursive comparison.
protected void	processIterable(IContext context, IResultSet result, TableAdapter tableAdapter, Iterator iterator)
protected void	processTerminal(IContext context, IResultSet result, TableAdapter tableAdapter, Iterator iterator) Process terminal values.
protected Exception	verify(IContext context, IComparator comparator, Object expected, Object received) Check if expected and received values are equal.

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

doEnd, doStart, doStart, getTableAdapter, initialize, initialize, toString

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, 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

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

Constructor Detail

PluginVerifyObjects

public PluginVerifyObjects()

Method Detail

getActionType

public ActionType getActionType()

Description copied from interface: IActionType

Get the plugin type.

Returns:

The type.

doEnd

public void doEnd(IContext context,
         IResultSet result,
         TableAdapter tableAdapter)
           throws PluginException

Description copied from class: AbstractPluginTable

Perform an ending action.

Overrides:

doEnd in class AbstractPluginTable

Parameters:

context - The context.

result - The result set.

tableAdapter - The adapter.

Throws:

PluginException - On plugin errors.

objectToList

protected List<Object> objectToList(Object received)

Convert an object to a list, if it is an array.

Parameters:

received - The object.

Returns:

The object as list, if array, the corresponding list, if not null.

process

protected void process(IContext context,
           IResultSet result,
           TableAdapter tableAdapter,
           Iterator iterator)
                throws PluginException,
                       ComparatorException

Perform recursive comparison.

Parameters:

context - A context.

result - A result.

tableAdapter - A table adapter.

iterator - An iterable object.

Throws:

PluginException - On expected value recovery error.

ComparatorException - On comparisons processing errors.

hasHeader

protected boolean hasHeader(TableAdapter tableAdapter)

Check if the given table has a header or not.

Parameters:

tableAdapter - A table adapter.

Returns:

true, if exist header, false, otherwise.

processTerminal

protected void processTerminal(IContext context,
                   IResultSet result,
                   TableAdapter tableAdapter,
                   Iterator iterator)
                        throws PluginException,
                               ComparatorException

Process terminal values.

Parameters:

context - A context.

result - A result.

tableAdapter - A table adapter.

iterator - An iterable object.

Throws:

PluginException - On expected value recovery error.

ComparatorException - On comparisons processing errors.

missingItems

protected void missingItems(IContext context,
                IResultSet result,
                TableAdapter tableAdapter,
                int start)

Add information of missing object or terminal items.

Parameters:

context - A context.

result - A result.

tableAdapter - A table adapter.

start - Starting position of missing items.

compare

protected void compare(IContext context,
           IResultSet result,
           IComparator comparator,
           CellAdapter headerExpected,
           CellAdapter cellExpected,
           Object received)
                throws PluginException,
                       ComparatorException

Compare terminal elements.

Parameters:

context - A context.

result - A result.

comparator - A comparator.

cellExpected - The expected cell adapter.

received - The received value.

eval - true, to perform evaluation on cell content, false, otherwise.

Throws:

PluginException - On expected value recovery error.

ComparatorException - On comparisons processing errors.

verify

protected Exception verify(IContext context,
               IComparator comparator,
               Object expected,
               Object received)
                    throws ComparatorException

Check if expected and received values are equal.

Parameters:

context - A context.

comparator - A comparator.

expected - The expected value.

received - The received value.

Returns:

An exception if expected and received do not match.

Throws:

ComparatorException - On comparison errors.

processIterable

protected void processIterable(IContext context,
                   IResultSet result,
                   TableAdapter tableAdapter,
                   Iterator iterator)
                        throws PluginException,
                               ComparatorException

Throws:

PluginException

ComparatorException

getIterableXPath

protected String getIterableXPath()

Return the XPath expression for object attributes of type 'iterable'.

Returns:

The xpath to select sublists/tables.

extraItems

protected void extraItems(IContext context,
              IResultSet result,
              TableAdapter tableAdapter,
              Iterator iterator)

Add error for extra items in enumeration.

Parameters:

context - A context.

result - A result.

tableAdapter - A table adapter.

iterator - An iterator.