org.apache.commons.validator
Class ValidatorAction

java.lang.Object
  extended by org.apache.commons.validator.ValidatorAction
All Implemented Interfaces:
Serializable

public class ValidatorAction
extends Object
implements Serializable

Contains the information to dynamically create and run a validation method. This is the class representation of a pluggable validator that can be defined in an xml file with the <validator> element. Note: The validation method is assumed to be thread safe.

Version:
$Revision: 493905 $ $Date: 2007-01-08 03:11:38 +0100 (Mo, 08. Jan 2007) $
See Also:
Serialized Form

Constructor Summary
ValidatorAction()
           
 
Method Summary
 String getClassname()
          Gets the class of the validator action.
 List getDependencyList()
          Returns the dependent validator names as an unmodifiable List.
 String getDepends()
          Gets the dependencies of the validator action as a comma separated list of validator names.
 String getJavascript()
          Gets the Javascript equivalent of the java class and method associated with this action.
 String getJsFunctionName()
          Gets the Javascript function name.
 String getMethod()
          Gets the name of method being called for the validator action.
 String getMethodParams()
          Gets the method parameters for the method.
 String getMsg()
          Gets the message associated with the validator action.
 String getName()
          Gets the name of the validator action.
protected  void init()
          Initialize based on set.
 boolean isDependency(String validatorName)
          Checks whether or not the value passed in is in the depends field.
protected  void loadJavascriptFunction()
          Load the javascript function specified by the given path.
 void setClassname(String classname)
          Sets the class of the validator action.
 void setDepends(String depends)
          Sets the dependencies of the validator action.
 void setJavascript(String javascript)
          Sets the Javascript equivalent of the java class and method associated with this action.
 void setJsFunction(String jsFunction)
          Sets the fully qualified class path of the Javascript function.
 void setJsFunctionName(String jsFunctionName)
          Sets the Javascript function name.
 void setMethod(String method)
          Sets the name of method being called for the validator action.
 void setMethodParams(String methodParams)
          Sets the method parameters for the method.
 void setMsg(String msg)
          Sets the message associated with the validator action.
 void setName(String name)
          Sets the name of the validator action.
 String toString()
          Returns a string representation of the object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ValidatorAction

public ValidatorAction()
Method Detail

getName

public String getName()
Gets the name of the validator action.

Returns:
Validator Action name.

setName

public void setName(String name)
Sets the name of the validator action.

Parameters:
name - Validator Action name.

getClassname

public String getClassname()
Gets the class of the validator action.

Returns:
Class name of the validator Action.

setClassname

public void setClassname(String classname)
Sets the class of the validator action.

Parameters:
classname - Class name of the validator Action.

getMethod

public String getMethod()
Gets the name of method being called for the validator action.

Returns:
The method name.

setMethod

public void setMethod(String method)
Sets the name of method being called for the validator action.

Parameters:
method - The method name.

getMethodParams

public String getMethodParams()
Gets the method parameters for the method.

Returns:
Method's parameters.

setMethodParams

public void setMethodParams(String methodParams)
Sets the method parameters for the method.

Parameters:
methodParams - A comma separated list of parameters.

getDepends

public String getDepends()
Gets the dependencies of the validator action as a comma separated list of validator names.

Returns:
The validator action's dependencies.

setDepends

public void setDepends(String depends)
Sets the dependencies of the validator action.

Parameters:
depends - A comma separated list of validator names.

getMsg

public String getMsg()
Gets the message associated with the validator action.

Returns:
The message for the validator action.

setMsg

public void setMsg(String msg)
Sets the message associated with the validator action.

Parameters:
msg - The message for the validator action.

getJsFunctionName

public String getJsFunctionName()
Gets the Javascript function name. This is optional and can be used instead of validator action name for the name of the Javascript function/object.

Returns:
The Javascript function name.

setJsFunctionName

public void setJsFunctionName(String jsFunctionName)
Sets the Javascript function name. This is optional and can be used instead of validator action name for the name of the Javascript function/object.

Parameters:
jsFunctionName - The Javascript function name.

setJsFunction

public void setJsFunction(String jsFunction)
Sets the fully qualified class path of the Javascript function.

This is optional and can be used instead of the setJavascript(). Attempting to call both setJsFunction and setJavascript will result in an IllegalStateException being thrown.

If neither setJsFunction or setJavascript is set then validator will attempt to load the default javascript definition.

 Examples
   If in the validator.xml :
 #1:
      <validator name="tire"
            jsFunction="com.yourcompany.project.tireFuncion">
     Validator will attempt to load com.yourcompany.project.validateTireFunction.js from
     its class path.
 #2:
    <validator name="tire">
      Validator will use the name attribute to try and load
         org.apache.commons.validator.javascript.validateTire.js
      which is the default javascript definition.
 

Parameters:
jsFunction - The Javascript function's fully qualified class path.

getJavascript

public String getJavascript()
Gets the Javascript equivalent of the java class and method associated with this action.

Returns:
The Javascript validation.

setJavascript

public void setJavascript(String javascript)
Sets the Javascript equivalent of the java class and method associated with this action.

Parameters:
javascript - The Javascript validation.

init

protected void init()
Initialize based on set.


loadJavascriptFunction

protected void loadJavascriptFunction()
Load the javascript function specified by the given path. For this implementation, the jsFunction property should contain a fully qualified package and script name, separated by periods, to be loaded from the class loader that created this instance. TODO if the path begins with a '/' the path will be intepreted as absolute, and remain unchanged. If this fails then it will attempt to treat the path as a file path. It is assumed the script ends with a '.js'.


isDependency

public boolean isDependency(String validatorName)
Checks whether or not the value passed in is in the depends field.

Parameters:
validatorName - Name of the dependency to check.
Returns:
Whether the named validator is a dependant.

getDependencyList

public List getDependencyList()
Returns the dependent validator names as an unmodifiable List.

Returns:
List of the validator action's depedents.

toString

public String toString()
Returns a string representation of the object.

Overrides:
toString in class Object
Returns:
a string representation.


Copyright © 2002-2010 Apache Software Foundation. All Rights Reserved.