/* 
 *  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.ls;

import java.util.List;
import java.util.Locale;

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

public class GetLocaleDisplayName extends functionBase {

	private static final long serialVersionUID = 1L;
	
	public GetLocaleDisplayName(){
		max = 2;
		min = 1;
	}

  
	public String[] getParamInfo(){
		return new String[]{
			"locale",
			"display locale - defaults to the current session locale"
		};
	}
	
	public java.util.Map getInfo(){
		return makeInfo(
				"locale", 
				"Returns back the display name of the locale, optionally in the locale specfied", 
				ReturnType.STRING );
	}
 
	
	public cfData execute( cfSession _session, List<cfData> parameters ) throws cfmRunTimeException {
		
		Locale locale = _session.getLocale();
		Locale inlocale = _session.getLocale();
		
		if ( parameters.size() == 1 ){
			locale = setLocale.getLocale( ( (cfData) parameters.get(0) ).getString() );
		}else if ( parameters.size() == 2 ){
			locale = setLocale.getLocale( ( (cfData) parameters.get(1) ).getString() );
			inlocale = setLocale.getLocale( ( (cfData) parameters.get(0) ).getString() );
		}

		return new cfStringData( locale.getDisplayName( inlocale ) ); 
	}
}