Fix a pile of Javadoc warnings

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.core / src / org / eclipse / linuxtools / tmf / core / filter / xml / TmfFilterXMLWriter.java

/*******************************************************************************\r
 * Copyright (c) 2010 Ericsson\r
 *\r
 * All rights reserved. This program and the accompanying materials are\r
 * made available under the terms of the Eclipse Public License v1.0 which\r
 * accompanies this distribution, and is available at\r
 * http://www.eclipse.org/legal/epl-v10.html\r
 *\r
 * Contributors:\r
 *   Yuriy Vashchuk (yvashchuk@gmail.com) - Initial API and implementation\r
 *******************************************************************************/\r
\r
package org.eclipse.linuxtools.tmf.core.filter.xml;\r
\r
import java.io.File;\r
\r
import javax.xml.parsers.DocumentBuilder;\r
import javax.xml.parsers.DocumentBuilderFactory;\r
import javax.xml.parsers.ParserConfigurationException;\r
import javax.xml.transform.Transformer;\r
import javax.xml.transform.TransformerConfigurationException;\r
import javax.xml.transform.TransformerException;\r
import javax.xml.transform.TransformerFactory;\r
import javax.xml.transform.dom.DOMSource;\r
import javax.xml.transform.stream.StreamResult;\r
\r
import org.eclipse.linuxtools.tmf.core.filter.model.ITmfFilterTreeNode;\r
import org.eclipse.linuxtools.tmf.core.filter.model.TmfFilterAndNode;\r
import org.eclipse.linuxtools.tmf.core.filter.model.TmfFilterCompareNode;\r
import org.eclipse.linuxtools.tmf.core.filter.model.TmfFilterContainsNode;\r
import org.eclipse.linuxtools.tmf.core.filter.model.TmfFilterEqualsNode;\r
import org.eclipse.linuxtools.tmf.core.filter.model.TmfFilterEventTypeNode;\r
import org.eclipse.linuxtools.tmf.core.filter.model.TmfFilterMatchesNode;\r
import org.eclipse.linuxtools.tmf.core.filter.model.TmfFilterNode;\r
import org.eclipse.linuxtools.tmf.core.filter.model.TmfFilterOrNode;\r
import org.w3c.dom.Document;\r
import org.w3c.dom.Element;\r
\r
/**\r
 * The SAX based XML writer\r
 *\r
 * @version 1.0\r
 * @author Yuriy Vashchuk\r
 * @author Patrick Tasse\r
 */\r
public class TmfFilterXMLWriter {\r
\r
	private Document document = null;\r
\r
	/**\r
	 * The XMLParser constructor\r
	 *\r
     * @param root The tree root\r
   	 * @throws ParserConfigurationException if a DocumentBuilder\r
     *   cannot be created which satisfies the configuration requested.\r
	 */\r
	public TmfFilterXMLWriter(final ITmfFilterTreeNode root) throws ParserConfigurationException {\r
		DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();\r
		DocumentBuilder documentBuilder = documentBuilderFactory.newDocumentBuilder();\r
		document = documentBuilder.newDocument();\r
\r
		Element rootElement = document.createElement(root.getNodeName());\r
		document.appendChild(rootElement);\r
\r
		for (ITmfFilterTreeNode node : root.getChildren()) {\r
			buildXMLTree(document, node, rootElement);\r
		}\r
	}\r
\r
	/**\r
	 * The Tree to XML parser\r
	 *\r
	 * @param document The XML document\r
	 * @param treenode The node to write\r
	 * @param parentElement The XML element of the parent\r
	 */\r
	public static void buildXMLTree(final Document document, final ITmfFilterTreeNode treenode, Element parentElement) {\r
		Element element = document.createElement(treenode.getNodeName());\r
\r
		if (treenode instanceof TmfFilterNode) {\r
\r
			TmfFilterNode node = (TmfFilterNode) treenode;\r
			element.setAttribute(TmfFilterNode.NAME_ATTR, node.getFilterName());\r
\r
		} else if (treenode instanceof TmfFilterEventTypeNode) {\r
\r
			TmfFilterEventTypeNode node = (TmfFilterEventTypeNode) treenode;\r
			element.setAttribute(TmfFilterEventTypeNode.TYPE_ATTR, node.getEventType());\r
			element.setAttribute(TmfFilterEventTypeNode.NAME_ATTR, node.getName());\r
\r
		} else if (treenode instanceof TmfFilterAndNode) {\r
\r
			TmfFilterAndNode node = (TmfFilterAndNode) treenode;\r
			element.setAttribute(TmfFilterAndNode.NOT_ATTR, Boolean.toString(node.isNot()));\r
\r
		} else if (treenode instanceof TmfFilterOrNode) {\r
\r
			TmfFilterOrNode node = (TmfFilterOrNode) treenode;\r
			element.setAttribute(TmfFilterOrNode.NOT_ATTR, Boolean.toString(node.isNot()));\r
\r
		} else if (treenode instanceof TmfFilterContainsNode) {\r
\r
			TmfFilterContainsNode node = (TmfFilterContainsNode) treenode;\r
			element.setAttribute(TmfFilterContainsNode.NOT_ATTR, Boolean.toString(node.isNot()));\r
			element.setAttribute(TmfFilterContainsNode.FIELD_ATTR, node.getField());\r
			element.setAttribute(TmfFilterContainsNode.VALUE_ATTR, node.getValue());\r
			element.setAttribute(TmfFilterContainsNode.IGNORECASE_ATTR, Boolean.toString(node.isIgnoreCase()));\r
\r
		} else if (treenode instanceof TmfFilterEqualsNode) {\r
\r
			TmfFilterEqualsNode node = (TmfFilterEqualsNode) treenode;\r
			element.setAttribute(TmfFilterEqualsNode.NOT_ATTR, Boolean.toString(node.isNot()));\r
			element.setAttribute(TmfFilterEqualsNode.FIELD_ATTR, node.getField());\r
			element.setAttribute(TmfFilterEqualsNode.VALUE_ATTR, node.getValue());\r
			element.setAttribute(TmfFilterEqualsNode.IGNORECASE_ATTR, Boolean.toString(node.isIgnoreCase()));\r
\r
		} else if (treenode instanceof TmfFilterMatchesNode) {\r
\r
			TmfFilterMatchesNode node = (TmfFilterMatchesNode) treenode;\r
			element.setAttribute(TmfFilterMatchesNode.NOT_ATTR, Boolean.toString(node.isNot()));\r
			element.setAttribute(TmfFilterMatchesNode.FIELD_ATTR, node.getField());\r
			element.setAttribute(TmfFilterMatchesNode.REGEX_ATTR, node.getRegex());\r
\r
		} else if (treenode instanceof TmfFilterCompareNode) {\r
\r
			TmfFilterCompareNode node = (TmfFilterCompareNode) treenode;\r
			element.setAttribute(TmfFilterCompareNode.NOT_ATTR, Boolean.toString(node.isNot()));\r
			element.setAttribute(TmfFilterCompareNode.FIELD_ATTR, node.getField());\r
			element.setAttribute(TmfFilterCompareNode.RESULT_ATTR, Integer.toString(node.getResult()));\r
			element.setAttribute(TmfFilterCompareNode.TYPE_ATTR, node.getType().toString());\r
			element.setAttribute(TmfFilterCompareNode.VALUE_ATTR, node.getValue());\r
\r
		}\r
\r
		parentElement.appendChild(element);\r
\r
		for (int i = 0; i < treenode.getChildrenCount(); i++) {\r
			buildXMLTree(document, treenode.getChild(i), element);\r
		}\r
	}\r
\r
	/**\r
	 * Save the tree\r
	 *\r
	 * @param uri The new Filter XML path\r
	 */\r
	public void saveTree(final String uri) {\r
		TransformerFactory transformerFactory = TransformerFactory.newInstance();\r
\r
		try {\r
			Transformer transformer = transformerFactory.newTransformer();\r
	        DOMSource source = new DOMSource(document);\r
	        StreamResult result =  new StreamResult(new File(uri));\r
			transformer.transform(source, result);\r
		} catch (TransformerConfigurationException e) {\r
			e.printStackTrace();\r
		} catch (TransformerException e) {\r
			e.printStackTrace();\r
		}\r
	}\r
\r
}\r