// $Id: UMLEnumerationBooleanProperty.java,v 1.15 2004/09/14 20:12:16 mvw Exp $
// Copyright (c) 1996-2004 The Regents of the University of California. All
// Rights Reserved. Permission to use, copy, modify, and distribute this
// software and its documentation without fee, and without a written
// agreement is hereby granted, provided that the above copyright notice
// and this paragraph appear in all copies.  This software program and
// documentation are copyrighted by The Regents of the University of
// California. The software program and documentation are supplied "AS
// IS", without any accompanying services from The Regents. The Regents
// does not warrant that the operation of the program will be
// uninterrupted or error-free. The end-user understands that the program
// was developed for research purposes and is advised not to rely
// exclusively on the program for any reason.  IN NO EVENT SHALL THE
// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

package org.argouml.uml.ui;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyVetoException;
import java.lang.reflect.*;

import org.apache.log4j.Logger;
import org.argouml.model.uml.AbstractWellformednessRule;
import org.argouml.model.uml.UmlHelper;
import org.argouml.model.ModelFacade;

/**
 * @deprecated as of ArgoUml 0.13.5 (10-may-2003),
 * TODO: What is this replaced by?,
 * this class is part of the 'old'(pre 0.13.*) implementation of proppanels
 * that used reflection a lot.
 */
public class UMLEnumerationBooleanProperty extends UMLBooleanProperty {
    private Method theGetMethod;
    private Method theSetMethod;
    private static final Object[] NOARG = {};
    private Object[] trueArg = new Object[1];
    private Object[] falseArg = new Object[1];
    private Object/*Class*/ theEnumClass;
    
    private static final Logger LOG =
	Logger.getLogger(UMLEnumerationBooleanProperty.class);
                  
    /**
     * WellformednessRules are rules that should be hold true if the
     * property is set they are defined in the model helpers
     * (CoreHelper etc) and conform to the wellformednessRules defined
     * in the UML 1.3 spec. They are of the form:
     * wellformednessRule(modelelement, newvalue)
     */
    private AbstractWellformednessRule[] wellformednessRules = null;
    
    /** 
     * Creates new BooleanChangeListener.
     * 
     * @param propertyName the name of the property
     * @param elementClass the element
     * @param getMethod the get method
     * @param setMethod the set method
     * @param enumClass the enumeration
     * @param trueValue the value for true
     * @param falseValue the value for false
     */
    public UMLEnumerationBooleanProperty(String propertyName,
                                         Class elementClass,
                                         String getMethod,
                                         String setMethod, 
                                         Object/*Class*/ enumClass,
                                         Object trueValue, 
                                         Object falseValue) {
        this(propertyName, elementClass, getMethod, setMethod, enumClass,
	     trueValue, falseValue, null);
    }
    
    /**
     * The constructor.
     * 
     * @param propertyName the name of the property
     * @param elementClass the element
     * @param getMethod the get method
     * @param setMethod the set method
     * @param enumClass the enumeration
     * @param trueValue the value for true
     * @param falseValue the value for false
     * @param w the welllformednessrules
     */
    public UMLEnumerationBooleanProperty(String propertyName,
					 Class elementClass,
                                         String getMethod, String setMethod, 
                                         Object/*Class*/ enumClass,
                                         Object trueValue, Object falseValue,
					 AbstractWellformednessRule[] w) {
	super(propertyName);
	theEnumClass = enumClass;
	trueArg[0] = trueValue;
	falseArg[0] = falseValue;
	Class[] noClass = {};
	wellformednessRules = w;
	try {
	    theGetMethod = elementClass.getMethod(getMethod, noClass);
	}
	catch (Exception e) {
	    LOG.fatal(getMethod
			 + " not found in UMLEnumerationBooleanProperty(): ",
			 e);
	}
	Class[] boolClass = {
	    (Class) enumClass 
	};
	try {
	    theSetMethod = elementClass.getMethod(setMethod, boolClass);
	}
	catch (Exception e) {
	    LOG.fatal(setMethod
			 + " not found in UMLEnumerationBooleanProperty(): ",
			 e);
	}
    }  
    
    
    /**
     * @see org.argouml.uml.ui.UMLBooleanProperty#setProperty(
     * java.lang.Object, boolean)
     */
    public void setProperty(Object element, boolean newState)
	throws PropertyVetoException {
    
    	if (wellformednessRules != null && ModelFacade.isABase(element)) {
	    Object helper = UmlHelper.getHelper().getHelper(element);  
	    if (helper != null) {
		for (int i = 0; i < wellformednessRules.length; i++) {
		    Object arg = falseArg[0];
		    if (newState) {
			arg = trueArg[0];
		    }
		    if (arg != null) {
			if (!wellformednessRules[i].isWellformed(element,
								  arg)) {
			    throw new PropertyVetoException(
				wellformednessRules[i].getUserMessage(),
				new PropertyChangeEvent(element,
							getPropertyName(),
							new Boolean(!newState),
							new Boolean(newState)));
			}
		    }
		}
	    }
    	}
    	
    	
        if (theSetMethod != null && element != null) {
            try {
                //
                //   this allows enumerations to work properly
                //      if newState is false, it won't override
                //      a different enumeration value
                boolean oldState = getProperty(element);
                if (newState != oldState) {
                    if (newState) {
                        theSetMethod.invoke(element, trueArg);
                    }
                    else {
                        theSetMethod.invoke(element, falseArg);
                    }
                }
            }
            catch (Exception e) {
                LOG.fatal("Error in "
			     + "UMLEnumerationBooleanProperty.setProperty for "
			     + getPropertyName() + ": " + e.toString(),
			     e);
            }
        }
    }
    
    /**
     * @see org.argouml.uml.ui.UMLBooleanProperty#getProperty(java.lang.Object)
     */
    public boolean getProperty(Object element) {
        boolean state = false;
        if (theGetMethod != null && element != null) {
            try {
                Object retval = theGetMethod.invoke(element, NOARG);
                if (retval != null
		    && (retval == trueArg[0] || retval.equals(trueArg[0]))) {
                    state = true;
                }
            }
            catch (Exception e) {
                LOG.fatal("Error in "
			     + "UMLEnumerationBooleanProperty.getProperty for "
			     + getPropertyName() + ": " + e.toString(),
			     e);
            }
        }
        return state;
    }
    
}