org.apache.commons.validator
Class ValidatorAction

java.lang.Object
  extended byorg.apache.commons.validator.ValidatorAction
All Implemented Interfaces:
java.io.Serializable

public class ValidatorAction
extends java.lang.Object
implements java.io.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.

See Also:
Serialized Form

Constructor Summary
ValidatorAction()
           
 
Method Summary
 java.lang.String getClassname()
          Gets the class of the validator action.
 java.lang.Object getClassnameInstance()
          Deprecated. This will be removed after Validator 1.1.2
 java.util.Collection getDependencies()
          Deprecated. Use getDependencyList() instead.
 java.util.List getDependencyList()
          Returns the dependent validator names as an unmodifiable List.
 java.lang.String getDepends()
          Gets the dependencies of the validator action as a comma separated list of validator names.
 java.lang.String getJavascript()
          Gets the Javascript equivalent of the java class and method associated with this action.
 java.lang.String getJsFunctionName()
          Gets the Javascript function name.
 java.lang.String getMethod()
          Gets the name of method being called for the validator action.
 java.lang.String getMethodParams()
          Gets the method parameters for the method.
 java.util.List getMethodParamsList()
          Deprecated. This will be removed after Validator 1.1.2
 java.lang.String getMsg()
          Gets the message associated with the validator action.
 java.lang.String getName()
          Gets the name of the validator action.
protected  void init()
          Initialize based on set.
 boolean isDependency(java.lang.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 process(java.util.Map globalConstants)
          Deprecated. This functionality has been moved to other methods. It's no longer required to call this method to initialize this object.
 void setClassname(java.lang.String classname)
          Sets the class of the validator action.
 void setClassnameInstance(java.lang.Object instance)
          Deprecated. This will be removed after Validator 1.1.2
 void setDepends(java.lang.String depends)
          Sets the dependencies of the validator action.
 void setJavascript(java.lang.String javascript)
          Sets the Javascript equivalent of the java class and method associated with this action.
 void setJsFunction(java.lang.String jsFunction)
          Sets the fully qualified class path of the Javascript function.
 void setJsFunctionName(java.lang.String jsFunctionName)
          Sets the Javascript function name.
 void setMethod(java.lang.String method)
          Sets the name of method being called for the validator action.
 void setMethodParams(java.lang.String methodParams)
          Sets the method parameters for the method.
 void setMsg(java.lang.String msg)
          Sets the message associated with the validator action.
 void setName(java.lang.String name)
          Sets the name of the validator action.
 java.lang.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 java.lang.String getName()
Gets the name of the validator action.


setName

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


getClassname

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


setClassname

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


getMethod

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


setMethod

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


getMethodParams

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


setMethodParams

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

Parameters:
methodParams - A comma separated list of parameters.

getMethodParamsList

public java.util.List getMethodParamsList()
Deprecated. This will be removed after Validator 1.1.2

Gets the method parameters for the method as an unmodifiable List.


getDepends

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


setDepends

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

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

getMsg

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


setMsg

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


getJsFunctionName

public java.lang.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.


setJsFunctionName

public void setJsFunctionName(java.lang.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.


setJsFunction

public void setJsFunction(java.lang.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.
 


getJavascript

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


setJavascript

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


getClassnameInstance

public java.lang.Object getClassnameInstance()
Deprecated. This will be removed after Validator 1.1.2

Gets an instance based on the validator action's classname.


setClassnameInstance

public void setClassnameInstance(java.lang.Object instance)
Deprecated. This will be removed after Validator 1.1.2

Sets an instance based on the validator action's classname.


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'.


process

public void process(java.util.Map globalConstants)
Deprecated. This functionality has been moved to other methods. It's no longer required to call this method to initialize this object.

Creates a FastHashMap for the isDependency method based on depends.


isDependency

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


getDependencies

public java.util.Collection getDependencies()
Deprecated. Use getDependencyList() instead.

Gets the dependencies as a Collection.


getDependencyList

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


toString

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



Copyright © 2002-2004 The Apache Software Foundation. All Rights Reserved.