/*
 * FormulaFunction_DateAdd.java
 *
 * Created on May 1, 2006, 9:46 AM
 *
 * Copyright 2006 Lee Lofgern and Accounting Enhancements Inc 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 com.accountingenhancements.formula;

import com.accountingenhancements.common.SupportParameters;
import java.text.ParseException;
import java.util.HashMap;

/**
 *
 *  @author Lee lofgren lofgren_opensource@accountingenhancements.com
 * @version 0.1009102006
 */
public class FormulaFunction_DateAdd extends FormulaFunction{
    
     protected static String[][] requiredArguments = {{"ARG1: The Interval to be changed. [Year, Quarter (4 per year), Month (12 per year), DayOfYear (365 or 366 per year), Day (28, 29, 30, or 31 per month, treated like DayOfYear) , Weekday (7 per week, treated like DayOfYear), Week (a little over 52 per year)]","TYPE_STRING"},{"ARG2: The value added (or subtracted) from the date","TYPE_LONG"},{"ARG3: The Date","TYPE_DATE"}};
     protected static String[] returnValueDescription = {"New Date","TYPE_DATE"};
     
    /**
     *Create a new FormulaFunction with an already defined functionArgumentStack.
     *@param functionArgumentStack a list of <code>FormulaVariable</code>s that are needed by the function.
     */
    public FormulaFunction_DateAdd(FormulaVariableStack functionArgumentStack){
        super(functionArgumentStack);
    }
    
    /**
     *Create a new FormulaFunction with a comma-delimited string representing the arguments needed by the function
     *@param functionArgumentString the string representing the functions arguments. The outer parentheses must be removed.<br/>
     *Example: If the function is IIF(A<B,"true","false") then functionArgumentString is A<B,"true","false".
     *@throws ParseException if arguments can't be parsed using parseCommaDelimitedFunctionFields(String,int)
     */
    public FormulaFunction_DateAdd(String functionArgumentString) throws ParseException{
        super(functionArgumentString);
    }
    
    /**
     *Create a new FormulaFunction with a comma-delimited string representing the arguments needed by the function
     *@param functionArgumentString the string representing the functions arguments. The outer parentheses must be removed.<br/>
     *Example: If the function is IIF(A<B,"true","false") then functionArgumentString is A<B,"true","false".
     *@param level the level applied to the creation of FormulaVariables for the arguments.
     *@throws ParseException if arguments can't be parsed using parseCommaDelimitedFunctionFields(String,int)
     */
    public FormulaFunction_DateAdd(String functionArgumentString, int level) throws ParseException{
        super(functionArgumentString,level);
    }
    
    /**
     *Create a new FormulaFunction from the functionVariable (A FormulaVariable of TYPE_FUNCTION).<br/>
     *This is the most common constructor used.
     *@param functionVariable a FormulaVariable of TYPE_FUNCTION
     *@throws ParseException if arguments can't be parsed using parseCommaDelimitedFunctionFields(String,int)
     */
    public FormulaFunction_DateAdd(FormulaVariable functionVariable) throws ParseException{
        super(functionVariable);
        
    }

    protected FormulaVariable solve(FormulaVariableList variableList, int iteration, SupportParameters supportParameters, FormulaFunctionList functionList, int resolveEverythingAboveLevel) throws java.text.ParseException, java.lang.ArithmeticException, ClassNotFoundException{
        FormulaVariable result=null;
        FormulaVariable date=null;
        FormulaVariable interval=null;
        FormulaVariable deltaAmount=null;
        int highestLevel;
        int deltaAmountInt;
        java.util.Date dateDate=null;
        java.util.Calendar calendar=null;
        String intervalString;
        
        if(functionArgumentStack==null)throw new java.lang.ArithmeticException("functionArgumentStack is null");
        interval=functionArgumentStack.get("ARG1");
        if(interval==null)throw new java.lang.ArithmeticException("ARG1 is missing from functionArgumentStack");
        interval=interval.solve(variableList,iteration,supportParameters,functionList,resolveEverythingAboveLevel);
        if (interval==null||interval.getString().length()==0)throw new java.lang.ArithmeticException("result of solving ARG1 is invalid");
        highestLevel=interval.getHighestLevel();
        deltaAmount=functionArgumentStack.get("ARG2");
        if(deltaAmount==null)throw new java.lang.ArithmeticException("ARG2 is missing from functionArgumentStack");
        deltaAmount=deltaAmount.solve(variableList,iteration,supportParameters,functionList,resolveEverythingAboveLevel);
        if(deltaAmount==null||(deltaAmount.getVariableType()!=FormulaVariable.TYPE_LONG&&deltaAmount.getVariableType()!=FormulaVariable.TYPE_DOUBLE))throw new java.lang.ArithmeticException("ARG2 not of TYPE_LONG");
        if(highestLevel<deltaAmount.getHighestLevel())highestLevel=deltaAmount.getHighestLevel();
        deltaAmountInt=deltaAmount.getLong().intValue();
        date=functionArgumentStack.get("ARG3");
        if(date==null)throw new java.lang.ArithmeticException("ARG3 is missing from functionArgumentStack");
        date=date.solve(variableList,iteration,supportParameters,functionList,resolveEverythingAboveLevel);
        if(date==null||date.detectVariableType(date.getString(),false)!=FormulaVariable.TYPE_DATE)throw new java.lang.ArithmeticException("ARG3 not of TYPE_DATE");
        if(highestLevel<date.getHighestLevel())highestLevel=date.getHighestLevel();
        dateDate=date.getDate();
        if(dateDate==null)throw new java.text.ParseException("ARG2 is an invalid date",0);
        calendar = java.util.GregorianCalendar.getInstance(java.util.Locale.US);
        calendar.setTime(dateDate);
        intervalString=interval.getString();
        if(intervalString==null||intervalString.length()==0)throw new java.text.ParseException("interval invalid",0);
        if(intervalString.substring(0,1).equalsIgnoreCase("Y")){
            calendar.add(calendar.YEAR,deltaAmountInt);
        } else if(intervalString.substring(0,1).equalsIgnoreCase("Q")){
            calendar.add(calendar.MONTH,deltaAmountInt*3);
        } else if(intervalString.substring(0,1).equalsIgnoreCase("M")){
            calendar.add(calendar.MONTH,deltaAmountInt);
        } else if(intervalString.substring(0,1).equalsIgnoreCase("D")){
            calendar.add(calendar.DAY_OF_YEAR,deltaAmountInt);
        } else if(intervalString.length()>4&&intervalString.substring(0,5).equalsIgnoreCase("WEEKD")){
            calendar.add(calendar.DAY_OF_YEAR,deltaAmountInt);
        } else if(intervalString.substring(0,1).equalsIgnoreCase("W")){
            calendar.add(calendar.WEEK_OF_YEAR,deltaAmountInt);
        } else throw new java.lang.ArithmeticException("Invalid interval option");
        
        result=new FormulaVariable("",calendar.getTime(),highestLevel);
        return result;
    }
    
    /**
     *@return the name of this function
     */
    public static String getName() {
        return "DateAdd";
    }
    
    /**
     *@return String[][] of needed arguments and their dataTypes which as {{"Test Argument ARG1","TYPE_BOOLEAN"},{"True Argument ARG2","TYPE_?"},{"False Argument ARG3","TYPE_?"}}<br/>
     *If handing this routine a FormulaVariableStack functionArgumentStack then the FormulaVariable arguments should be named, ARG1, ARG2, etc...
     */
    public static String[][] getRequiredArguments(){
        return requiredArguments;
    }
    
    /**
     *@return String[] description of the return value as well as it's data type
     */
    public static String[] getReturnValueDescription(){
        return returnValueDescription;
    }
    
}