/* 
 *  Copyright (C) 2000 - 2008 TagServlet Ltd
 *
 *  This file is part of Open BlueDragon (OpenBD) CFML Server Engine.
 *  
 *  OpenBD is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  Free Software Foundation,version 3.
 *  
 *  OpenBD is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *  
 *  You should have received a copy of the GNU General Public License
 *  along with OpenBD.  If not, see http://www.gnu.org/licenses/
 *  
 *  Additional permission under GNU GPL version 3 section 7
 *  
 *  If you modify this Program, or any covered work, by linking or combining 
 *  it with any of the JARS listed in the README.txt (or a modified version of 
 *  (that library), containing parts covered by the terms of that JAR, the 
 *  licensors of this Program grant you additional permission to convey the 
 *  resulting work. 
 *  README.txt @ http://www.openbluedragon.org/license/README.txt
 *  
 *  http://www.openbluedragon.org/
 */

package com.naryx.tagfusion.expression.function.string;

import com.naryx.tagfusion.cfm.engine.cfArgStructData;
import com.naryx.tagfusion.cfm.engine.cfData;
import com.naryx.tagfusion.cfm.engine.cfNumberData;
import com.naryx.tagfusion.cfm.engine.cfSession;
import com.naryx.tagfusion.cfm.engine.cfmRunTimeException;
import com.naryx.tagfusion.expression.function.functionBase;

public class compareNoCase extends functionBase {
  
  private static final long serialVersionUID = 1L;
	
  public compareNoCase(){ 
  	min = max = 2;
  	setNamedParams( new String[]{ "string1" , "string2"} );
  }
  
  public String[] getParamInfo(){
		return new String[]{
			"string1",
			"string2"
		};
	}
	
	public java.util.Map getInfo(){
		return makeInfo(
				"string", 
				"Performs a lexical comparison, ignoring the case.  If string1 is less than string2 then -1 returned.  If string1 greater than string then 1 is return.  0 if equals", 
				ReturnType.NUMERIC );
	}
  
	public cfData execute(cfSession _session, cfArgStructData argStruct ) throws cfmRunTimeException {
  	
  	String value1 	= getNamedStringParam( argStruct, "string1" , "" );
		String value2		=  getNamedStringParam( argStruct, "string2" , "" );

		int result = value1.compareToIgnoreCase(value2);
		if ( result < 0 )	result = -1;
		else if ( result > 0 )	result = 1;
	
		return new cfNumberData( result );
	}
}