/*
 * FormulaFunction_LCase.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_LCase extends FormulaFunction{
    
     protected static String[][] requiredArguments = {{"ARG1: the source String that is to be converted to lower case","TYPE_STRING"}};
     protected static String[] returnValueDescription={"Lower case value of ARG1","TYPE_STRING"};
    /**
     *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_LCase(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_LCase(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_LCase(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_LCase(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;
        String resultString;
        if(functionArgumentStack==null)throw new java.lang.ArithmeticException("functionArgumentStack is null");
        result=functionArgumentStack.get("ARG1");
        if(result==null)throw new java.lang.ArithmeticException("ARG1 is missing from functionArgumentStack");
        result=result.solve(variableList,iteration,supportParameters,functionList,resolveEverythingAboveLevel);
        if(result!=null){
            resultString=result.getString();
            if(resultString!=null){
                result = new FormulaVariable("",result.getString().toLowerCase(),FormulaVariable.TYPE_STRING,0,result.getLevel());
            }
        }
        return result;
    }
    
    /**
     *@return the name of this function
     */
    public static String getName() {
        return "LCase";
    }
    
    /**
     *@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;
    }
    
}