org.specrunner.sql

Class PluginFilter

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

All Implemented Interfaces:

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

public class PluginFilter
extends AbstractPluginValue

Add a IFilter instance to the environment.

Author:

Thiago Santos.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_FILTER_NAME Default filter provider name.
static String	FEATURE_FILTER Provider name feature.
static String	FEATURE_FILTER_INSTANCE Filter instance feature.
static String	FEATURE_REUSE Default filter setting for reuse.

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

Constructor Summary

Constructors

Constructor and Description
PluginFilter()

Method Summary

Modifier and Type	Method and Description
ENext	doStart(IContext context, IResultSet result)
ActionType	getActionType()
static IDataFilter	getFilter(IContext context, String name) Gets the filter saved in context.
String	getProvider() The provide class name.
IDataFilter	getProviderInstance() The instance of a data source.
Boolean	getReuse() Gets the reuse status.
void	initialize(IContext context)
void	setProvider(String provider) Sets the filter provider class name.
void	setProviderInstance(IDataFilter providerInstance) The instance of data source.
void	setReuse(Boolean reuse) Set reusable state.

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

DEFAULT_FILTER_NAME

public static final String DEFAULT_FILTER_NAME

Default filter provider name.

See Also:

Constant Field Values

FEATURE_FILTER

public static final String FEATURE_FILTER

Provider name feature.

FEATURE_FILTER_INSTANCE

public static final String FEATURE_FILTER_INSTANCE

Filter instance feature.

FEATURE_REUSE

public static final String FEATURE_REUSE

Default filter setting for reuse.

Constructor Detail

PluginFilter

public PluginFilter()

Method Detail

getProvider

public String getProvider()

The provide class name. Something that implements the interface IFilter.

Returns:

The provider class name, fully qualified.

setProvider

public void setProvider(String provider)

Sets the filter provider class name.

Parameters:

provider - The class which implements IFilter provider name.

getProviderInstance

public IDataFilter getProviderInstance()

The instance of a data source.

Returns:

Filter provider instance.

setProviderInstance

public void setProviderInstance(IDataFilter providerInstance)

The instance of data source.

Parameters:

providerInstance - The instance.

getReuse

public Boolean getReuse()

Gets the reuse status. If reuse is true, the object can be reused by multiple tests.

Returns:

The reuse status.

setReuse

public void setReuse(Boolean reuse)

Set reusable state.

Parameters:

reuse - true, for reuse, false, otherwise.

getActionType

public ActionType getActionType()

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

getFilter

public static IDataFilter getFilter(IContext context,
                                    String name)
                             throws PluginException

Gets the filter saved in context.

Parameters:

context - The context.

name - The filter provider name.

Returns:

The filter provider.

Throws:

PluginException - On lookup errors.