org.milyn.rules
Interface RuleProvider

All Known Implementing Classes:

MVELProvider, RegexProvider

public interface RuleProvider

RuleProvider declares the contract which must be followed to make different types of rule/evaluation technologies work with Smooks.

Author:

Daniel Bevenius

Method Summary

RuleEvalResult	evaluate(String ruleName, CharSequence selectedData, org.milyn.container.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.

Method Detail

getName

String getName()

Gets this providers name.

Returns:

String This providers name.

setName

void setName(String name)

The name of this rule provider.

Parameters:

name - The rule providers name.

getSrc

String getSrc()

Gets the source for this rule provider

Returns:

String The src for this rule provider

setSrc

void setSrc(String src)

Sets the src for this rule provider.

Parameters:

src - The source which defines the rules.

evaluate

RuleEvalResult evaluate(String ruleName,
                        CharSequence selectedData,
                        org.milyn.container.ExecutionContext context)
                        throws org.milyn.SmooksException

Evalutate the rule.

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.milyn.SmooksException