/*
 * Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies). 
 * All rights reserved.
 * This component and the accompanying materials are made available
 * under the terms of "Eclipse Public License v1.0"
 * which accompanies this distribution, and is available
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
 *
 * Initial Contributors:
 * Nokia Corporation - initial contribution.
 *
 * Contributors:
 *
 * Description:
 *
 * Exports Variable Tracing configuration to XML file
 *
 */
package com.nokia.traceviewer.engine.preferences;

import javax.xml.transform.stream.StreamResult;

import org.w3c.dom.Attr;
import org.w3c.dom.Document;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

import com.nokia.traceviewer.dialog.treeitem.TreeItem;
import com.nokia.traceviewer.dialog.treeitem.VariableTracingTreeItem;
import com.nokia.traceviewer.dialog.treeitem.VariableTracingTreeTextItem;
import com.nokia.traceviewer.engine.TraceViewerGlobals;

/**
 * Exports Variable Tracing configuration to XML file
 */
public final class XMLVariableTracingConfigurationExporter extends
		XMLBaseConfigurationExporter {

	/**
	 * Constructor
	 * 
	 * @param root
	 *            root of the LineCount elements
	 * @param configurationFileName
	 *            file name where to export data
	 * @param pathRelative
	 *            tells is the path relative
	 */
	public XMLVariableTracingConfigurationExporter(TreeItem root,
			String configurationFileName, boolean pathRelative) {
		super(root, configurationFileName, pathRelative);
	}

	/**
	 * Exports data
	 */
	public void export() {
		Document doc = getDocument();
		Node parent;

		// Get root node of line count rules
		NodeList list = doc.getElementsByTagName(VARIABLETRACING_TAG);

		// Tag not found
		if (list.getLength() == 0) {
			parent = doc.createElement(VARIABLETRACING_TAG);
			// Get the main configurations tag
			NodeList list2 = doc.getElementsByTagName(CONFIGURATIONS_TAG);
			Node mainRoot = list2.item(0);
			mainRoot.appendChild(parent);
		} else {
			parent = list.item(0);
		}

		// Delete old rule information
		NodeList children = parent.getChildNodes();
		int len = children.getLength();
		for (int i = 0; i < len; i++) {
			parent.removeChild(children.item(0));
		}

		// Process through the tree
		for (int i = 0; i < root.getChildren().length; i++) {
			processChild((VariableTracingTreeItem) root.getChildren()[i], doc,
					parent);
		}

		// Get result from document
		StreamResult result = getResultFromDocument(doc);

		// Print out
		String xmlString = result.getWriter().toString();
		writeFile(xmlString);
	}

	/**
	 * Process child
	 * 
	 * @param item
	 *            child to process
	 * @param doc
	 *            document
	 * @param root
	 *            node to insert this child to
	 */
	private void processChild(VariableTracingTreeItem item, Document doc,
			Node root) {

		// Process through the tree
		Node newItem = null;
		if (item.getRule() == VariableTracingTreeItem.Rule.GROUP) {
			newItem = doc.createElement(GROUP_TAG);
		} else if (item.getRule() == VariableTracingTreeItem.Rule.TEXT_RULE) {
			newItem = doc.createElement(CONFIGURATION_TAG);
		}
		if (newItem != null) {

			// Get attributes
			NamedNodeMap itemAttributes = newItem.getAttributes();

			// Set name
			Attr name = doc.createAttribute(NAME_TAG);
			name.setValue(item.getName());
			itemAttributes.setNamedItem(name);

			// Set rule if not group item
			if (item.getRule() != VariableTracingTreeItem.Rule.GROUP) {
				Attr rule = doc.createAttribute(RULE_TAG);
				if (item.getRule() == VariableTracingTreeItem.Rule.TEXT_RULE) {
					rule.setValue(TEXTRULE_TAG);
				} else {
					String unknownText = Messages
							.getString("XMLVariableTracingConfigurationExporter.Unkn"); //$NON-NLS-1$ 
					rule.setValue(unknownText);
				}
				itemAttributes.setNamedItem(rule);

				// Add enabled attribute
				Attr enabled = doc.createAttribute(ENABLED_TAG);
				boolean checked = isChecked(item);
				if (checked) {
					enabled.setValue(YES_TAG);
				} else {
					enabled.setValue(NO_TAG);
				}
				itemAttributes.setNamedItem(enabled);
			}

			// Set as child to parent
			root.appendChild(newItem);

			// Set nodes when text rule
			if (item.getRule() == VariableTracingTreeItem.Rule.TEXT_RULE) {
				VariableTracingTreeTextItem textItem = (VariableTracingTreeTextItem) item;

				// Text
				Node text = doc.createElement(TEXT_TAG);
				text.setTextContent(textItem.getText());
				newItem.appendChild(text);

				// Match case
				Node matchCase = doc.createElement(MATCHCASE_TAG);
				if (textItem.isMatchCase()) {
					matchCase.setTextContent(YES_TAG);
				} else {
					matchCase.setTextContent(NO_TAG);
				}
				newItem.appendChild(matchCase);

				// Save History
				Node saveHistory = doc.createElement(SAVEHISTORY_TAG);
				saveHistory.setTextContent(String.valueOf(textItem
						.getHistoryCount()));
				newItem.appendChild(saveHistory);
			}

			// Loop through own children
			for (int i = 0; i < item.getChildren().length; i++) {
				processChild((VariableTracingTreeItem) item.getChildren()[i],
						doc, newItem);
			}
		}
	}

	/**
	 * Checks it the given item is checked in the dialog
	 * 
	 * @param item
	 *            item to be checked
	 * @return true if the given item is checked
	 */
	private boolean isChecked(VariableTracingTreeItem item) {
		boolean checked = false;
		if (TraceViewerGlobals.getTraceViewer().getDataProcessorAccess()
				.getVariableTracingProcessor().getTextRules().contains(item)) {
			checked = true;
		}
		return checked;
	}
}