org.smooks.cartridges.rules.mvel

Class MVELProvider

java.lang.Object

org.smooks.cartridges.rules.mvel.MVELProvider

All Implemented Interfaces:

RuleProvider

public class MVELProvider
extends Object
implements RuleProvider

MVEL Rule Provider.

Rules must be specified in Comma Separated Value files (CSV). These can be edited using a Spreadsheet application (Excel or OpenOffice).

Author:

tom.fennelly@jboss.com

Constructor Summary

Constructors

Constructor and Description
MVELProvider()

Method Summary

Modifier and Type	Method and Description
RuleEvalResult	evaluate(String ruleName, CharSequence selectedData, org.smooks.api.ExecutionContext context) Evalutate the rule.
String	getName() Gets this providers name.
String	getSrc() Gets the source for this rule provider
void	setName(String name) The name of this rule provider.
void	setSrc(String src) Sets the src for this rule provider.

Methods inherited from class java.lang.Object

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

Constructor Detail

MVELProvider

public MVELProvider()

Method Detail

getName

public String getName()

Description copied from interface: RuleProvider

Gets this providers name.

Specified by:

getName in interface RuleProvider

Returns:

String This providers name.

setName

public void setName(String name)

Description copied from interface: RuleProvider

The name of this rule provider.

Specified by:

setName in interface RuleProvider

Parameters:

name - The rule providers name.

getSrc

public String getSrc()

Description copied from interface: RuleProvider

Gets the source for this rule provider

Specified by:

getSrc in interface RuleProvider

Returns:

String The src for this rule provider

setSrc

public void setSrc(String src)

Description copied from interface: RuleProvider

Sets the src for this rule provider.

Specified by:

setSrc in interface RuleProvider

Parameters:

src - The source which defines the rules.

evaluate

public RuleEvalResult evaluate(String ruleName,
                               CharSequence selectedData,
                               org.smooks.api.ExecutionContext context)
                        throws org.smooks.api.SmooksException

Description copied from interface: RuleProvider

Evalutate the rule.

Specified by:

evaluate in interface RuleProvider

Parameters:

ruleName - The ruleName to be used in this evaluation.

selectedData - The data that this evalute method will evaluate upon.

context - The Smooks Excecution context.

Returns:

RuleEvalResult Object representing an evaluation result.

Throws:

org.smooks.api.SmooksException