Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.aendvari.griffin.validation.validator
Class Handler  view Handler download Handler.java

java.lang.Object
  extended bycom.aendvari.griffin.validation.validator.Handler
Direct Known Subclasses:
ErrorHandler, Validator

public abstract class Handler
extends java.lang.Object

This is the base class for handler classes.

The ErrorMethod and Handler are both Handlers.

A Handler is a described object that has a method and it's parameters. It is used to execute a Class's method with the required parameter values.


Field Summary
protected  java.lang.String handlerClass
          The name of the class (if defined) to use for calling validation methods
protected  HandlerMethod handlerMethod
          The HandlerMethod to call from the handlerObject or handlerClass
protected  java.lang.String handlerObject
          The name of the object (if defined) to use for calling validation methods
protected  java.lang.String name
          The name of the handler.
protected  java.util.HashMap parameterDefines
          The list of parameter "define" name/value pairs to use for the method
 
Constructor Summary
Handler()
          Constructs a Handler instance.
 
Method Summary
abstract  boolean executeValidation(com.aendvari.griffin.validation.dataset.Property property, java.util.HashMap handlers)
          Executes this classes' part of a Dataset validation.
 java.lang.String getHandlerClass()
          Get the classpath for the Class of the handler.
 java.lang.String getHandlerObject()
          Get the handlerObject of the handler.
 java.lang.String getName()
          Get the name of the handler.
 ParameterDefine getParameterDefine(java.lang.String name)
          Get the default value of a parameter define.
 int getParameterDefineCount()
          Get the count of parameter defines.
 HandlerMethod getValidateMethod()
          Get the handler method.
 boolean isValidParameterDefine(java.lang.String name)
          Verify that the given name is a parameter define.
 void setHandlerClass(java.lang.String setHandlerClass)
          Set the classpath for the Class of the handler.
 void setHandlerMethod(HandlerMethod setMethod)
          Set the handler method.
 void setHandlerObject(java.lang.String setHandlerObject)
          Set the handlerObject of the handler.
 void setName(java.lang.String setName)
          Set the name of the handler.
 void setParameterDefine(java.lang.String name, ParameterDefine define)
          Add a param define.
 java.lang.String toString()
          Convert this object into a String representation.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

name

protected java.lang.String name
The name of the handler.


handlerObject

protected java.lang.String handlerObject
The name of the object (if defined) to use for calling validation methods


handlerClass

protected java.lang.String handlerClass
The name of the class (if defined) to use for calling validation methods


handlerMethod

protected HandlerMethod handlerMethod
The HandlerMethod to call from the handlerObject or handlerClass


parameterDefines

protected java.util.HashMap parameterDefines
The list of parameter "define" name/value pairs to use for the method

Constructor Detail

Handler

public Handler()
Constructs a Handler instance.

Method Detail

getName

public java.lang.String getName()
Get the name of the handler.


setName

public void setName(java.lang.String setName)
Set the name of the handler.


getHandlerObject

public java.lang.String getHandlerObject()
Get the handlerObject of the handler.


setHandlerObject

public void setHandlerObject(java.lang.String setHandlerObject)
Set the handlerObject of the handler.


getHandlerClass

public java.lang.String getHandlerClass()
Get the classpath for the Class of the handler.


setHandlerClass

public void setHandlerClass(java.lang.String setHandlerClass)
Set the classpath for the Class of the handler.


getValidateMethod

public HandlerMethod getValidateMethod()
Get the handler method.


setHandlerMethod

public void setHandlerMethod(HandlerMethod setMethod)
Set the handler method.


setParameterDefine

public void setParameterDefine(java.lang.String name,
                               ParameterDefine define)
Add a param define.


getParameterDefine

public ParameterDefine getParameterDefine(java.lang.String name)
Get the default value of a parameter define.


getParameterDefineCount

public int getParameterDefineCount()
Get the count of parameter defines.


isValidParameterDefine

public boolean isValidParameterDefine(java.lang.String name)
Verify that the given name is a parameter define.


executeValidation

public abstract boolean executeValidation(com.aendvari.griffin.validation.dataset.Property property,
                                          java.util.HashMap handlers)
                                   throws java.lang.Exception
Executes this classes' part of a Dataset validation.


toString

public java.lang.String toString()
Convert this object into a String representation.