org.milyn.validation

Class Validator

java.lang.Object

org.milyn.validation.Validator

All Implemented Interfaces:

ContentHandler, DOMVisitAfter, DOMVisitor, SAXVisitAfter, SAXVisitBefore, SAXVisitor, Visitor

public final class Validator
extends Object
implements SAXVisitBefore, SAXVisitAfter, DOMVisitAfter

A Validator uses a predefined Rule that performs the actual validator for a Validator. This way a Validator does not know about the technology used for the validation and users can mix and max different rules as appropriate to the use case they have. For example, one problem might be solve nicely with a regular expression but another might be easier to sovle using a MVEL expression. Example configuration:

 <rules:ruleBases>
    <rules:ruleBase name="addressing" src="usa_address.properties" provider="org.milyn.smooks.validation.RegexProvider" />
 </rules:ruleBases>

 <validation:field on="order/header/email" rule="addressing.email" onFail="WARN" />

 

Options:

• on The fragement that the validation will be performed upon.
• rule Is the name of a previously defined in a rules element. The rule itself is identified by ruleProviderName.ruleName. So taking the above example addressing is the ruleProviderName and email is the rule name. In this case email identifies a regular expression but if you were to change the provider that might change and a differnet technology could be used to validate an email address.
• onFail The onFail attribute in the validation configuration specified what action should be taken when a rule matches. This is all about reporting back valdiation failures.

Author:

Daniel Bevenius

Constructor Summary

Constructors

Constructor and Description
Validator() No-args constructor required by Smooks.
Validator(String compositRuleName, OnFail onFail) Public constructor.

Method Summary

Modifier and Type	Method and Description
String	getCompositRuleName()
OnFail	getOnFail()
void	initialize() Initialize the visitor instance.
Validator	setAppContext(ApplicationContext appContext)
void	setCompositRuleName(String compositRuleName)
void	setOnFail(OnFail onFail)
String	toString()
void	visitAfter(Element element, ExecutionContext executionContext) Visit the supplied element after visiting its child elements.
void	visitAfter(SAXElement element, ExecutionContext executionContext) Visit the supplied element after visiting its child elements.
void	visitBefore(SAXElement element, ExecutionContext executionContext) Visit the supplied element before visiting its child elements.

Methods inherited from class java.lang.Object

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

Constructor Detail

Validator

public Validator()

No-args constructor required by Smooks.

Validator

public Validator(String compositRuleName,
                 OnFail onFail)

Public constructor.

Parameters:

compositRuleName - The name of the rule that will be used by this validator.

onFail - The failure level.

Method Detail

initialize

@Initialize
public void initialize()

Initialize the visitor instance.

visitBefore

public void visitBefore(SAXElement element,
                        ExecutionContext executionContext)
                 throws SmooksException

Description copied from interface: SAXVisitBefore

Visit the supplied element before visiting its child elements.

Specified by:

visitBefore in interface SAXVisitBefore

Parameters:

element - The SAX element being visited.

executionContext - Execution context.

Throws:

SmooksException - Event processing failure.

visitAfter

public void visitAfter(SAXElement element,
                       ExecutionContext executionContext)
                throws SmooksException

Description copied from interface: SAXVisitAfter

Visit the supplied element after visiting its child elements.

Specified by:

visitAfter in interface SAXVisitAfter

Parameters:

element - The SAX element being visited.

executionContext - Execution context.

Throws:

SmooksException - Event processing failure.

visitAfter

public void visitAfter(Element element,
                       ExecutionContext executionContext)
                throws SmooksException

Description copied from interface: DOMVisitAfter

Visit the supplied element after visiting its child elements.

Specified by:

visitAfter in interface DOMVisitAfter

Parameters:

element - The DOM element being visited.

executionContext - Request relative instance.

Throws:

SmooksException - Element processing failure.

toString

public String toString()

Overrides:

toString in class Object

setCompositRuleName

@ConfigParam(name="name")
public void setCompositRuleName(String compositRuleName)

getCompositRuleName

public String getCompositRuleName()

setOnFail

@ConfigParam(defaultVal="ERROR")
public void setOnFail(OnFail onFail)

getOnFail

public OnFail getOnFail()

setAppContext

public Validator setAppContext(ApplicationContext appContext)