/*
    * Copyright 2002-2004 The Apache Software Foundation
    *
    * Licensed under the Apache License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    *
    *     http://www.apache.org/licenses/LICENSE-2.0
    *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package org.apache.commons.clazz.reflect.common;
  
  import java.lang.reflect.Method;
  import java.util.ArrayList;
  import java.util.List;
  
  import org.apache.commons.clazz.Clazz;
  import org.apache.commons.clazz.reflect.ReflectedClazz;
  
  /**
   * Base class for <code>Reflected*PropertyParseResults</code> classes;
   * aggregates parse results for individual accessor methods.
   * 
   * @author <a href="mailto:dmitri@apache.org">Dmitri Plotnikov</a>
   * @version $Id: ReflectedPropertyParseResults.java 155436 2005-02-26 13:17:48Z dirkv $
   */
  public abstract class ReflectedPropertyParseResults implements Comparable {
      private ReflectedClazz clazz;
      private String propertyName;
      private List aliases;
  
      protected AccessorMethodParseResults readMethodParseResults;
      protected AccessorMethodParseResults writeMethodParseResults;
      protected List extraneousAccessors;
  
      private static final String[] EMPTY_STRING_ARRAY = new String[0];
  
      public ReflectedPropertyParseResults(
          ReflectedClazz clazz,
          String propertyName) 
      {
          this.clazz = clazz;
          this.propertyName = propertyName;
      }
  
      public ReflectedClazz getClazz() {
          return clazz;
      }
  
      /**
       * Returns the propertyName.
       * @return String
       */
      public String getPropertyName() {
          return propertyName;
      }
  
      public int compareTo(Object object) {
          String n1 = getPropertyName();
          String n2 = ((ReflectedPropertyParseResults) object).getPropertyName();
          return n1.compareTo(n2);
      }
  
      public String[] getAliases() {
          if (aliases == null) {
              return EMPTY_STRING_ARRAY;
          }
          return (String[]) aliases.toArray(EMPTY_STRING_ARRAY);
      }
  
      public void addAlias(String alias) {
          if (!alias.equals(propertyName)) {
              if (aliases == null) {
                  aliases = new ArrayList();
                  aliases.add(alias);
              }
              else if (!aliases.contains(alias)) {
                  aliases.add(alias);
              }
          }
      }
  
      protected abstract String getPropertyCategory();
  
      public void merge(ReflectedPropertyParseResults other) {
          addAlias(other.getPropertyName());
          String[] aliases = other.getAliases();
          for (int i = 0; i < aliases.length; i++) {
              addAlias(aliases[i]);
          }
      }
  
      public Class getPropertyType() {
          if (readMethodParseResults != null) {
             return readMethodParseResults.getType();
         }
         if (writeMethodParseResults != null) {
             return writeMethodParseResults.getType();
         }
         return null;
     }
 
     public Method getReadMethod() {
         if (readMethodParseResults == null) {
             return null;
         }
         return readMethodParseResults.getMethod();
     }
 
     public Method getWriteMethod() {
         if (writeMethodParseResults == null) {
             return null;
         }
         return writeMethodParseResults.getMethod();
     }
 
     /**
      * Sets the readMethodParseResults.
      * @param readMethodParseResults The readMethodParseResults to set
      */
     public void setReadMethodParseResults(
             AccessorMethodParseResults readMethodParseResults) 
     {
         checkForExtraneousAccessor(
             this.readMethodParseResults,
             readMethodParseResults);
         this.readMethodParseResults = readMethodParseResults;
     }
 
     /**
      * Sets the writeMethodParseResults.
      * @param writeMethodParseResults The writeMethodParseResults to set
      */
     public void setWriteMethodParseResults(
             AccessorMethodParseResults writeMethodParseResults) 
     {
         checkForExtraneousAccessor(
             this.writeMethodParseResults,
             writeMethodParseResults);
         this.writeMethodParseResults = writeMethodParseResults;
     }
 
     /**
      * Checks if there is an existing parse result recorded and if
      * so saves it into the extraneousAccessors for error reporting.
      */
     protected void checkForExtraneousAccessor(
         AccessorMethodParseResults currentValue,
         AccessorMethodParseResults newValue) 
     {
         if (currentValue != null
             && newValue != null
             && currentValue != newValue) {
             if (extraneousAccessors == null) {
                 extraneousAccessors = new ArrayList();
                 extraneousAccessors.add(currentValue);
             }
         }
     }
 
     public boolean checkConsistency() {
         if (extraneousAccessors != null) {
             return false;
         }
 
         return true;
     }
 
     public String toString() {
         boolean consistent = checkConsistency();
 
         StringBuffer buffer = new StringBuffer();
         buffer.append("[");
         if (consistent) {
             buffer.append(propertyName);
             if (!getPropertyCategory().equals("scalar")) {
                 buffer.append(" (");
                 buffer.append(getPropertyCategory());
                 buffer.append(")");
             }
         }
         else {
             buffer.append("*");
             buffer.append(propertyName);
             buffer.append(" - NOT a ");
             if (!getPropertyCategory().equals("scalar")) {
                 buffer.append(getPropertyCategory());
             }
             buffer.append(" property");
             appendInconsistencyDescriptions(buffer);
         }
         if (aliases != null) {
             buffer.append("\n  [aliases: ");
             for (int i = 0; i < aliases.size(); i++) {
                 if (i != 0) {
                     buffer.append(", ");
                 }
                 buffer.append(aliases.get(i));
             }
             buffer.append("]");
         }
         appendDescription(buffer);
         buffer.append("\n  [accessor methods:");
         appendMethodDescriptions(buffer);
         buffer.append("\n  ]");
         buffer.append("\n]");
         return buffer.toString();
     }
 
     protected void appendDescription(StringBuffer buffer) {
         Class type = getPropertyType();
         if (type != null) {
             buffer.append("\n  [type]           ");
             buffer.append(Clazz.getCanonicalClassName(type));
         }
     }
 
     protected void appendMethodDescriptions(StringBuffer buffer) {
         if (readMethodParseResults != null) {
             buffer.append("\n    [get~()]       ");
             buffer.append(readMethodParseResults.getMethod());
         }
         if (writeMethodParseResults != null) {
             buffer.append("\n    [set~(v)]      ");
             buffer.append(writeMethodParseResults.getMethod());
         }
     }
 
     protected boolean appendInconsistencyDescriptions(StringBuffer buffer) {
         if (extraneousAccessors != null) {
             buffer.append("\n     - Has extraneous accessors:");
             for (int i = 0; i < extraneousAccessors.size(); i++) {
                 AccessorMethodParseResults results =
                     (AccessorMethodParseResults) extraneousAccessors.get(i);
                 buffer.append("\n         ");
                 buffer.append(results.getMethod());
             }
         }
         return true;
     }
 }