Source code: com/aendvari/griffin/validation/validator/Handler.java

   /*
    * Handler.java
    *
    * Copyright (c) 2001, 2002 Aendvari, Ltd. All Rights Reserved.
    *
    * See the file LICENSE for terms of use.
    *
    */
   
  package com.aendvari.griffin.validation.validator;
  
  import java.io.*;
  import java.util.*;
  import java.beans.*;
  
  import java.lang.reflect.*;
  import java.lang.NoSuchMethodException;
  import java.lang.IllegalAccessException;
  
  import com.aendvari.common.*;
  
  import com.aendvari.common.model.*;
  
  import com.aendvari.griffin.validation.*;
  import com.aendvari.griffin.validation.dataset.*;
  import com.aendvari.griffin.validation.validator.*;
  
  
  /**
   * <p>This is the base class for handler classes.</p>
   *
   * <p>The {@link ErrorMethod} and {@link Handler} are both Handlers.</p>
   *
   * <p>
   * 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.
   * </p>
   *
   * @author  Scott Milne
   *
   */
  
  public abstract class Handler
  {
    /* Variables */
  
    /** The name of the handler. */
    protected String name;
  
    /** The name of the object (if defined) to use for calling validation methods */
    protected String handlerObject;
  
    /** The name of the class (if defined) to use for calling validation methods */
    protected String handlerClass;
  
    /** The {@link HandlerMethod} to call from the handlerObject or handlerClass */
    protected HandlerMethod handlerMethod;
  
    /** The list of parameter "define" name/value pairs to use for the method */
    protected HashMap parameterDefines;
  
  
    /* Constructors. */
  
  
    /**
     * Constructs a <code>Handler</code> instance.
     *
     */
  
    public Handler()
    {
      parameterDefines = new HashMap();
  
      name = "";
      handlerObject = "";
      handlerClass = "";
    }
  
    /**
     * Get the name of the handler.
     *
     * @return                  The name of the handler.
     *
     */
  
    public String getName()
    {
      return name;
    }
  
    /**
     * Set the name of the handler.
     *
     * @param    setName            The name of the handler.
     *
     */
  
    public void setName( String setName )
   {
     name = setName;
   }
 
   /**
    * Get the handlerObject of the handler.
    *
    * @return                  The handlerObject of the handler.
    *
    */
 
   public String getHandlerObject()
   {
     return handlerObject;
   }
 
   /**
    * Set the handlerObject of the handler.
    *
    * @param    setHandlerObject      The handlerObject of the handler.
    *
    */
 
   public void setHandlerObject( String setHandlerObject )
   {
     handlerObject = setHandlerObject;
   }
 
   /**
    * Get the classpath for the Class of the handler.
    *
    * @return                  The handlerClass of the handler.
    *
    */
 
   public String getHandlerClass()
   {
     return handlerClass;
   }
 
   /**
    * Set the classpath for the Class of the handler.
    *
    * @param    setHandlerClass        The classpath to the Class of the handler.
    *
    */
 
   public void setHandlerClass( String setHandlerClass )
   {
     handlerClass = setHandlerClass;
   }
 
   /**
    * Get the handler method.
    *
    * @return                  The {@link HandlerMethod} instance.
    *
    */
 
   public HandlerMethod getValidateMethod()
   {
     return handlerMethod;
   }
 
   /**
    * Set the handler method.
    *
    * @param    setMethod          A {@link HandlerMethod} instance.
    *
    */
 
   public void setHandlerMethod( HandlerMethod setMethod )
   {
     handlerMethod = setMethod;
   }
 
   /**
    * Add a param define.
    *
    * @param    name            The name of the parameter define.
    * @param    define            The {@link ParameterDefine} instance to add.
    *
    */
 
   public void setParameterDefine( String name, ParameterDefine define )
   {
     parameterDefines.put(name, define);
   }
 
   /**
    * Get the default value of a parameter define.
    *
    * @param    name            The name of the parameter define.
    *
    * @return                  String for the default value of the parameter define.
    *
    */
 
   public ParameterDefine getParameterDefine( String name )
   {
     return (ParameterDefine)parameterDefines.get(name);
   }
 
   /**
    * Get the count of parameter defines.
    *
    * @return                  The parameter defines.
    *
    */
 
   public int getParameterDefineCount()
   {
     return parameterDefines.size();
   }
 
   /**
    * Verify that the given name is a parameter define.
    *
    * @param    name            The name of the parameter define.
    *
    */
 
   public boolean isValidParameterDefine( String name )
   {
     return parameterDefines.containsKey(name);
   }
 
   /**
    * Executes this classes' part of a <code>Dataset</code> validation.
    *
    * @param    property          A {@link Property} instance for the value to test.
    * @param    handlers          A <code>HashMap</code> of {@link ValidationHandler} instances.
    *
    * @return                  Returns boolean for determining if the validate was successful.
    *
    */
 
   public abstract boolean executeValidation( Property property, HashMap handlers ) throws Exception;
 
   /**
    * Convert this object into a String representation.
    *
    */
 
   public String toString()
   {
     String data = "Handler [";
     data += "name=" + name + ",";
     data += "handlerObject=" + handlerObject + ",";
     data += "handlerClass=" + handlerClass + ",";
     data += "handlerMethod=" + handlerMethod + ",";
     data += "parameterDefines="+parameterDefines;
     data += "]";
     return data;
   }
 }