UserShortcutConfigDOM.java

/*
*
* Copyright 2005 AgileTec s.r.l. (http://www.agiletec.it) All rights reserved.
*
* This file is part of jAPS software.
* jAPS is a free software; 
* you can redistribute it and/or modify it
* under the terms of the GNU General Public License (GPL) as published by the Free Software Foundation; version 2.
* 
* See the file License for the specific language governing permissions   
* and limitations under the License
* 
* 
* 
* Copyright 2005 AgileTec s.r.l. (http://www.agiletec.it) All rights reserved.
*
*/
package com.agiletec.apsadmin.system.services.shortcut;

import java.io.StringReader;
import java.util.List;

import org.jdom.Document;
import org.jdom.Element;
import org.jdom.input.SAXBuilder;
import org.jdom.output.Format;
import org.jdom.output.XMLOutputter;

import com.agiletec.aps.system.ApsSystemUtils;
import com.agiletec.aps.system.exception.ApsSystemException;

/**
 * @author E.Santoboni
 */
public class UserShortcutConfigDOM {
	
	protected static String createUserConfigXml(String[] config) throws ApsSystemException {
		XMLOutputter out = new XMLOutputter();
		Document document = new Document();
		try {
			Element rootElement = new Element(ROOT_ELEMENT_NAME);
			document.setRootElement(rootElement);
			for (int i = 0; i < config.length; i++) {
				String shortcut = config[i];
				if (null != shortcut) {
					Element element = new Element(BOX_ELEMENT_NAME);
					element.setAttribute(POS_ATTRIBUTE_NAME, String.valueOf(i));
					element.setText(shortcut);
					rootElement.addContent(element);
				}
			}
		} catch (Throwable t) {
			ApsSystemUtils.logThrowable(t, UserShortcutConfigDOM.class, "extractUserShortcutConfig");
			throw new ApsSystemException("Error parsing user config", t);
		}
		Format format = Format.getPrettyFormat();
		format.setIndent("\t");
		out.setFormat(format);
		return out.outputString(document);
	}
	
	protected static String[] extractUserConfig(String xml, Integer definiteSize) throws ApsSystemException {
		String[] config = new String[definiteSize];
		try {
			if (null == xml || xml.trim().length() == 0) return config;
			Document doc = decodeDOM(xml);
			List<Element> elements = doc.getRootElement().getChildren(BOX_ELEMENT_NAME);
			for (int i=0; i<elements.size(); i++) {
				if (i > definiteSize) break;
				Element element = elements.get(i);
				Integer pos = null;
				try {
					pos = Integer.parseInt(element.getAttributeValue(POS_ATTRIBUTE_NAME));
				} catch (Exception e) {
					//nothing to catch
				}
				String shortcutCode = element.getText();
				if (null != pos) {
					config[pos] = shortcutCode;
				}
			}
		} catch (Throwable t) {
			ApsSystemUtils.logThrowable(t, UserShortcutConfigDOM.class, "extractUserShortcutConfig");
			throw new ApsSystemException("Error parsing user config", t);
		}
		return config;
	}
	
	private static Document decodeDOM(String xmlText) throws ApsSystemException {
		Document doc = null;
		SAXBuilder builder = new SAXBuilder();
		builder.setValidation(false);
		StringReader reader = new StringReader(xmlText);
		try {
			doc = builder.build(reader);
		} catch (Throwable t) {
			ApsSystemUtils.getLogger().severe("Error while parsing: " + t.getMessage());
			throw new ApsSystemException("Error detected while parsing the XML", t);
		}
		return doc;
	}
	
	public static String ROOT_ELEMENT_NAME = "shortcuts";
	public static String BOX_ELEMENT_NAME = "box";
	public static String POS_ATTRIBUTE_NAME = "pos";
	
}