org.josef.web.jsf.validator

Class RelationalValidator

java.lang.Object

org.josef.web.jsf.AbstractStateHolder

org.josef.web.jsf.validator.AbstractValidator

org.josef.web.jsf.validator.RelationalValidator

All Implemented Interfaces:

Serializable, EventListener, javax.faces.component.StateHolder, javax.faces.validator.Validator

public class RelationalValidator
extends AbstractValidator
implements Serializable

A validator that validates two values using a relational operator
Usage: <jf:relationalValidator leftId="..." relationalOperator="{EQUAL|UNEQUAL|LESS_THAN|GREATER_THAN|LESS_THAN_OR_EQUAL|GREATER_THAN_OR_EQUAL}" [message="..."] />
leftValue: The value of the left component.
relationalOperator: The relational operator to use.
message: Error message in case a validation error occurs. This message supports three arguments:
{0}=The left value
{1}=The relational operator
{2}=The right value
In the absence of the message attribute, this validator will use a build in, standard error message.
Note: You must add this validator to the second component. The following example compares two strings for equality:

 <h:outputLabel value="Left:"/>
 <jh:InputText id="idLeftString" value="#{relationalValidatorTestBean.leftString}" label="Left:"/>
 <h:outputLabel value="Right:"/>
 <jh:InputText id="idRightString" value="#{relationalValidatorTestBean.rightString}" label="Right">
   <jf:relationalValidator
     for="idInputText"
     leftValue="#{relationalValidatorTestBean.leftString}"
     relationalOperator="EQUAL" />
 </jh:InputText>
 

Note: Both left and right values must be of the same type and be Comparable.

Version:

1.0 $Revision: 6483 $

Author:

Kees Schotanus

See Also:

Serialized Form

Field Summary

Fields inherited from interface javax.faces.validator.Validator

NOT_IN_RANGE_MESSAGE_ID

Constructor Summary

Constructors

Constructor and Description
RelationalValidator()

Method Summary

Modifier and Type	Method and Description
Object	getLeftValue() Gets the value of the left operand.
RelationalValidationOperator	getRelationalOperator() Gets the relational operator.
void	restoreState(javax.faces.context.FacesContext facesContext, Object state) Restores the state saved by saveState(FacesContext).
Object	saveState(javax.faces.context.FacesContext facesContext) Saves the state of this validator.
void	setLeftValue(Object leftValue) Sets the value of the left operand.
void	setRelationalOperator(RelationalValidationOperator relationalValidationOperator) Sets the relational operator.
void	validate(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent rightComponent, Object rightValue) Validates two values using a relational operator.

Methods inherited from class org.josef.web.jsf.validator.AbstractValidator

getFormattedErrorMessage, getMessage, hasMessage, isComponentOfTypeUIInput, setMessage

Methods inherited from class org.josef.web.jsf.AbstractStateHolder

isTransient, setTransient

Methods inherited from class java.lang.Object

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

Constructor Detail

RelationalValidator

public RelationalValidator()

Method Detail

getLeftValue

public Object getLeftValue()

Gets the value of the left operand.

Returns:

The value of the left operand.

setLeftValue

public void setLeftValue(Object leftValue)

Sets the value of the left operand.

Parameters:

leftValue - The value of the left operand.

getRelationalOperator

public RelationalValidationOperator getRelationalOperator()

Gets the relational operator.

Returns:

The relational operator.

setRelationalOperator

public void setRelationalOperator(RelationalValidationOperator relationalValidationOperator)

Sets the relational operator.

Parameters:

relationalValidationOperator - The relational operator.

validate

public void validate(javax.faces.context.FacesContext facesContext,
                     javax.faces.component.UIComponent rightComponent,
                     Object rightValue)

Validates two values using a relational operator.
The relational operator is specified by the "relationalOperator" attribute.
In the following cases, no validation will take place:

• The leftId attribute has not been set (*)
• The relationalOperator attribute has not been set (*)
• Either left or right component contains a null value

Conditions marked with (*) are logged as a severe message.

Specified by:

validate in interface javax.faces.validator.Validator

Parameters:

facesContext - The FacesContext.

rightComponent - The component at the right of the relational operator.

rightValue - The value of the right operand.

Throws:

javax.faces.validator.ValidatorException - When the two values are not valid with respect to the relational operator.

saveState

public Object saveState(javax.faces.context.FacesContext facesContext)

Saves the state of this validator.
Note: the leftValue has deliberately been left out to prevent the leftValue from being null at validation time.

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class AbstractValidator

Parameters:

facesContext - The FacesContext.

Returns:

The saved state of this validator.

restoreState

public void restoreState(javax.faces.context.FacesContext facesContext,
                         Object state)

Restores the state saved by saveState(FacesContext).
Note: the leftValue has deliberately been left out to prevent the leftValue from being null at validation time.

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class AbstractValidator

Parameters:

facesContext - The FacesContext.

state - The state saved by saveState(FacesContext).