// Copyright 2006 Daniel Gredler

 //

 // 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 net.sf.beanform.prop;

 import java.beans.PropertyDescriptor;

 import java.io.Serializable;

 import java.lang.annotation.Annotation;

 import java.lang.reflect.Field;

 import java.lang.reflect.InvocationTargetException;

 import java.util.ArrayList;

 import java.util.Arrays;

 import java.util.Date;

 import java.util.List;

 import net.sf.beanform.integration.IntegratorChain;

 import net.sf.beanform.util.ReflectionUtils;

 import org.apache.commons.logging.Log;

 import org.apache.commons.logging.LogFactory;

 import org.apache.hivemind.ApplicationRuntimeException;

 import org.apache.hivemind.util.Defense;

 /**

  * <p>A property of a Java bean, identified by the owner class and the name of the property.</p>

  *

  * <p>Note that the name of the property may be recursive; for example, if the owner class is <tt>Person</tt>,

  * and the property name is <tt>address.state.abbreviation</tt>, then this bean property represents a person's

  * address's state's 2-letter abbreviation, and its type is <tt>java.lang.String</tt> (not <tt>Address</tt>

  * or <tt>State</tt>).</p>

  *

  * @author Daniel Gredler

  */

 public class BeanProperty implements Serializable {

     private static final long serialVersionUID = -9064407627959060313L;

     private static final Log LOG = LogFactory.getLog( BeanProperty.class );

     private static final Annotation[] EMPTY = new Annotation[ 0 ];

     private static final String STRING = String.class.getName();

     private static final String BOOLEAN = Boolean.class.getName();

     private static final String BOOL = boolean.class.getName();

     private static final String SHORT = Short.class.getName();

     private static final String SRT = short.class.getName();

     private static final String INTEGER = Integer.class.getName();

     private static final String INT = int.class.getName();

     private static final String LONG = Long.class.getName();

     private static final String LNG = long.class.getName();

     private static final String FLOAT = Float.class.getName();

     private static final String FLT = float.class.getName();

     private static final String DOUBLE = Double.class.getName();

     private static final String DBL = double.class.getName();

     private static final String DATE = Date.class.getName();

     private static final String BYTE_ARRAY = byte[].class.getName();

     private final static String INPUT_TEXTFIELD = "TextField";

     private final static String INPUT_TEXTAREA = "TextArea";

     private final static String INPUT_CHECKBOX = "Checkbox";

     private final static String INPUT_DATEPICKER = "DatePicker";

     private final static String INPUT_UPLOAD = "Upload";

     private final static String INPUT_INSERT = "Insert";

     private final static List<String> INPUTS = Arrays.asList(

         INPUT_TEXTFIELD,

         INPUT_TEXTAREA,

         INPUT_CHECKBOX,

         INPUT_DATEPICKER,

         INPUT_UPLOAD,

         INPUT_INSERT

     );

     private final Class ownerClass;

     private final String name;

     private final String[] names;

     private final String validators;

     private final String input;

     private transient PropertyDescriptor descriptor;

     private transient Field field;

     public BeanProperty( Class ownerClass, String name, String validators, String input ) {

         Defense.notNull( ownerClass, "ownerClass" );

         Defense.notNull( name, "name" );

         this.ownerClass = ownerClass;

         this.name = name;

         this.names = name.split( "\\." );

         if( validators != null ) this.validators = validators;

         else this.validators = IntegratorChain.getValidation( this );

         if( input != null ) this.input = input;

         else this.input = this.inferInputFromType();

         if( (!this.usesTextField()) && (!this.usesTextArea()) && (!this.usesCheckbox()) &&

             (!this.usesDatePicker()) && (!this.usesUpload()) && (!this.usesInsert()) ) {

             String msg = BeanPropertyMessages.unrecognizedInputType( this, INPUTS );

             throw new ApplicationRuntimeException( msg );

         }

     }

     private String inferInputFromType() {

         if( this.isShortString() || this.isNumber() ) return INPUT_TEXTFIELD;

         else if( this.isLongString() ) return INPUT_TEXTAREA;

         else if( this.isBoolean() ) return INPUT_CHECKBOX;

         else if( this.isDate() ) return INPUT_DATEPICKER;

         else if( this.isByteArray() ) return INPUT_UPLOAD;

         else return INPUT_INSERT;

     }

     private PropertyDescriptor getPropertyDescriptor() {

         if( this.descriptor == null ) {

             this.descriptor = ReflectionUtils.getPropertyDescriptor( this.ownerClass, this.names );

         }

         return this.descriptor;

     }

     private Field getField() {

         if( this.field == null ) {

             try {

                 this.field = ReflectionUtils.getField( this.ownerClass, this.names );

             }

             catch( NoSuchFieldException e ) {

                 if( LOG.isDebugEnabled() ) {

                     String msg = "The field '" + this.getName() + "' does not exist. ";

                     msg += "Perhaps the field name does not match the property name?";

                     LOG.debug( msg );

                 }

             }

         }

         return this.field;

     }

     public Class getOwnerClass() {

         return this.ownerClass;

     }

     public String getName() {

         return this.name;

     }

     public String getValidators() {

         return this.validators;

     }

     public String getInput() {

         return this.input;

     }

     public boolean usesTextField() {

         return INPUT_TEXTFIELD.equalsIgnoreCase( this.input );

     }

     public boolean usesTextArea() {

         return INPUT_TEXTAREA.equalsIgnoreCase( this.input );

     }

     public boolean usesCheckbox() {

         return INPUT_CHECKBOX.equalsIgnoreCase( this.input );

     }

     public boolean usesDatePicker() {

         return INPUT_DATEPICKER.equalsIgnoreCase( this.input );

     }

     public boolean usesUpload() {

         return INPUT_UPLOAD.equalsIgnoreCase( this.input );

     }

     public boolean usesInsert() {

         return INPUT_INSERT.equalsIgnoreCase( this.input );

     }

     public List<Annotation> getAnnotations() {

         PropertyDescriptor pd = this.getPropertyDescriptor();

         Annotation[] a1 = ( pd.getReadMethod() == null ? EMPTY : pd.getReadMethod().getAnnotations() );

         Annotation[] a2 = ( pd.getWriteMethod() == null ? EMPTY : pd.getWriteMethod().getAnnotations() );

         Annotation[] a3 = ( this.getField() == null ? EMPTY : this.getField().getAnnotations() );

         List<Annotation> list = new ArrayList<Annotation>();

         list.addAll( Arrays.asList( a1 ) );

         list.addAll( Arrays.asList( a2 ) );

         list.addAll( Arrays.asList( a3 ) );

         return list;

     }

     @SuppressWarnings( "unchecked" )

     public <T extends Annotation> T getAnnotation( Class<T> clazz ) {

         Annotation result = null;

         for( Annotation a : this.getAnnotations() ) {

             if( clazz.isAssignableFrom( a.getClass() ) ) {

                 result = a;

                 break;

             }

         }

         return (T) result;

     }

     public boolean isReadable() {

         return this.getPropertyDescriptor().getReadMethod() != null;

     }

     public boolean isWriteable() {

         return this.getPropertyDescriptor().getWriteMethod() != null;

     }

     public boolean isNullable() {

         return IntegratorChain.isNullable( this );

     }

     public Class getType() {

         return this.getPropertyDescriptor().getPropertyType();

     }

     public String getTypeName() {

         Class type = this.getType();

         return ( type != null ? type.getName() : null );

     }

     public boolean isEnum() {

         Class type = this.getType();

         return ( type != null && type.isEnum() );

     }

     public boolean isString() {

         String typeName = this.getTypeName();

         return STRING.equals( typeName );

     }

     public boolean isShortString() {

         if( this.isString() == false ) return false;

         Integer maxLength = IntegratorChain.getMaxLength( this );

         if( maxLength == null ) return true;

         if( maxLength < 256 ) return true;

         return false;

     }

     public boolean isLongString() {

         return this.isString() && ! this.isShortString();

     }

     public boolean isBoolean() {

         String typeName = this.getTypeName();

         return BOOLEAN.equals( typeName ) || BOOL.equals( typeName );

     }

     public boolean isShort() {

         String typeName = this.getTypeName();

         return SHORT.equals( typeName ) || SRT.equals( typeName );

     }

     public boolean isInteger() {

         String typeName = this.getTypeName();

         return INTEGER.equals( typeName ) || INT.equals( typeName );

     }

     public boolean isLong() {

         String typeName = this.getTypeName();

         return LONG.equals( typeName ) || LNG.equals( typeName );

     }

     public boolean isFloat() {

         String typeName = this.getTypeName();

         return FLOAT.equals( typeName ) || FLT.equals( typeName );

     }

     public boolean isDouble() {

         String typeName = this.getTypeName();

         return DOUBLE.equals( typeName ) || DBL.equals( typeName );

     }

     public boolean isNumber() {

         return this.isShort() || this.isInteger() || this.isLong() || this.isFloat() || this.isDouble();

     }

     public boolean isDate() {

         String typeName = this.getTypeName();

         return DATE.equals( typeName );

     }

     public boolean isByteArray() {

         String typeName = this.getTypeName();

         return BYTE_ARRAY.equals( typeName );

     }

     public boolean isEditableType() {

         return this.isString() || this.isBoolean() || this.isNumber() || this.isDate() || this.isByteArray();

     }

     @Override

     public String toString() {

         return this.name +

             ( this.input != null ? "=" + this.input : "" ) +

             ( this.validators != null ? "{" + this.validators + "}" : "" );

     }

     /**

      * Compares two <tt>BeanProperty</tt> instances based on the same fields that {@link #hashCode()}

      * uses: <tt>ownerClass</tt>, <tt>name</tt>, <tt>validators</tt> and <tt>input</tt>.

      */

     @Override

     public boolean equals( Object o ) {

         if( o instanceof BeanProperty == false ) return false;

         BeanProperty prop = (BeanProperty) o;

         boolean c = ( this.ownerClass == null ? prop.ownerClass == null : this.ownerClass.equals( prop.ownerClass ) );

         boolean n = ( this.name == null       ? prop.name == null       : this.name.equals( prop.name ) );

         boolean v = ( this.validators == null ? prop.validators == null : this.validators.equals( prop.validators ) );

         boolean i = ( this.input == null      ? prop.input == null      : this.input.equals( prop.input ) );

         return c && n && v && i;

     }

     /**

      * Builds a hashCode based on the same fields that {@link #equals(Object)} uses: <tt>ownerClass</tt>,

      * <tt>name</tt>, <tt>validators</tt> and <tt>input</tt>.

      *

      * @see http://jakarta.apache.org/commons/lang/xref/org/apache/commons/lang/builder/HashCodeBuilder.html

      */

     @Override

     public int hashCode() {

         int result = 17;

         result = ( this.ownerClass != null ? 37 * result + this.ownerClass.hashCode() : result * 37 );

         result = ( this.name       != null ? 37 * result + this.name.hashCode()       : result * 37 );

         result = ( this.validators != null ? 37 * result + this.validators.hashCode() : result * 37 );

         result = ( this.input      != null ? 37 * result + this.input.hashCode()      : result * 37 );

         return result;

     }

     /* -------------------------------------------------------------------------------------- */

     /* ------ Allow getting and setting the value of this property on a specific bean. ------ */

     /* -------------------------------------------------------------------------------------- */

     private transient Object bean;

     public void setBean( Object bean ) {

         if( bean == null ) {

             LOG.warn( BeanPropertyMessages.setBeanNullBean() );

         }

         this.bean = bean;

     }

     public Object getValue() {

         if( this.bean == null ) {

             String msg = BeanPropertyMessages.getValueNullBean();

             throw new ApplicationRuntimeException( msg );

         }

         if( this.isReadable() == false ) {

             String msg = BeanPropertyMessages.getValueNotReadable( this );

             throw new ApplicationRuntimeException( msg );

         }

         try {

             return ReflectionUtils.getPropertyValue( this.bean, this.names );

         }

         catch( IllegalAccessException iae ) {

             throw new ApplicationRuntimeException( iae );

         }

         catch( InvocationTargetException ite ) {

             throw new ApplicationRuntimeException( ite );

         }

         finally {

             this.bean = null;

         }

     }

     public void setValue( Object value ) {

         if( this.bean == null ) {

             String msg = BeanPropertyMessages.setValueNullBean();

             throw new ApplicationRuntimeException( msg );

         }

         if( this.isWriteable() == false ) {

             String msg = BeanPropertyMessages.setValueNotWriteable( this );

             throw new ApplicationRuntimeException( msg );

         }

         try {

             ReflectionUtils.setPropertyValue( value, this.bean, this.names );

         }

         catch( IllegalAccessException iae ) {

             throw new ApplicationRuntimeException( iae );

         }

         catch( InvocationTargetException ite ) {

             throw new ApplicationRuntimeException( ite );

         }

         catch( InstantiationException ie ) {

             throw new ApplicationRuntimeException( ie );

         }

         catch( IllegalArgumentException iae ) {

             String msg = BeanPropertyMessages.setValueIllegalArgument( value );

             throw new ApplicationRuntimeException( msg, iae );

         }

         finally {

             this.bean = null;

         }

     }

 }