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

import com.naryx.tagfusion.cfm.engine.cfArgStructData;
import com.naryx.tagfusion.cfm.engine.cfArrayData;
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.cfStructData;
import com.naryx.tagfusion.cfm.engine.cfmRunTimeException;
import com.naryx.tagfusion.cfm.xml.cfXmlData;
import com.naryx.tagfusion.cfm.xml.cfXmlDataArray;
import com.naryx.tagfusion.expression.function.functionBase;

public class structKeyArray extends functionBase {
	private static final long serialVersionUID = 1L;

	public structKeyArray() {
		min = max = 1;
		setNamedParams( new String[]{ "struct" } );
	}

	public String[] getParamInfo(){
		return new String[]{
			"struct1"
		};
	}
	
	public java.util.Map getInfo(){
		return makeInfo(
				"structure", 
				"Returns back an array of all the keys in the structure", 
				ReturnType.ARRAY );
	}
	
	public cfData execute(cfSession _session, cfArgStructData argStruct) throws cfmRunTimeException {
		cfData structure = getNamedParam(argStruct, "struct");
		cfArrayData rtn = cfArrayData.createArray(1);
		if (structure instanceof cfXmlData) {
			cfXmlDataArray arr = (cfXmlDataArray) ((cfXmlData) structure).getData("XmlChildren");
			if (arr != null) {
				for (int i = 0; i < arr.size(); i++)
					rtn.addElement(new cfStringData(((cfXmlData) arr.getElement(i + 1)).getName()));
				return rtn;
			}
			cfXmlData root = (cfXmlData) ((cfXmlData) structure).getData("XmlRoot");
			if (root != null) {
				rtn.addElement(new cfStringData(root.getName()));
				return rtn;
			}
			return rtn;
		}
		if (!structure.isStruct())
			throwException(_session, "Parameter isn't of type STRUCTURE");

		return ((cfStructData) structure).getKeyArray();
	}
}