/*
 * 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 Filter configuration to XML file
 *
 */
package com.nokia.traceviewer.engine.preferences;

import java.util.List;

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.FilterTreeComponentItem;
import com.nokia.traceviewer.dialog.treeitem.FilterTreeItem;
import com.nokia.traceviewer.dialog.treeitem.FilterTreeTextItem;
import com.nokia.traceviewer.dialog.treeitem.TreeItem;
import com.nokia.traceviewer.engine.TraceViewerGlobals;
import com.nokia.traceviewer.engine.dataprocessor.FilterRuleObject;
import com.nokia.traceviewer.engine.dataprocessor.FilterRuleSet;

/**
 * Exports Filter configuration to XML file
 * 
 */
public final class XMLFilterConfigurationExporter extends
		XMLBaseConfigurationExporter {

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

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

		// Get root node of filter rules
		NodeList list = doc.getElementsByTagName(FILTER_TAG);
		if (list.getLength() == 0) {
			parent = doc.createElement(FILTER_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 filter information
		NodeList filterChilds = parent.getChildNodes();
		int len = filterChilds.getLength();
		for (int i = 0; i < len; i++) {
			parent.removeChild(filterChilds.item(0));
		}

		// Add Type, Action and AdvancedFilter attributes
		addCommonAttributes(doc, parent);

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

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

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

	/**
	 * Adds common attributes to the XML
	 * 
	 * @param doc
	 *            document
	 * @param parent
	 *            parent node
	 */
	private void addCommonAttributes(Document doc, Node parent) {
		// Get attributes
		NamedNodeMap attr = parent.getAttributes();

		// Type attribute
		Attr type = doc.createAttribute(TYPE_TAG);
		String operator = AND_TAG;
		if (TraceViewerGlobals.getTraceViewer().getDataProcessorAccess()
				.getFilterProcessor().isLogicalOrInUse()) {
			operator = OR_TAG;
		}
		type.setValue(operator);
		attr.setNamedItem(type);

		// Action attribute
		Attr action = doc.createAttribute(ACTION_TAG);
		String actionStr = HIDE_TAG;
		if (TraceViewerGlobals.getTraceViewer().getDataProcessorAccess()
				.getFilterProcessor().isShowTracesContainingRule()) {
			actionStr = SHOW_TAG;
		}
		action.setValue(actionStr);
		attr.setNamedItem(action);

		// Advanced filter attribute
		Attr string = doc.createAttribute(ADVANCEDFILTER_TAG);
		string.setValue(TraceViewerGlobals.getTraceViewer()
				.getDataProcessorAccess().getFilterProcessor()
				.getAdvancedFilterString());
		attr.setNamedItem(string);
	}

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

		// Process through the tree
		Node newItem = null;
		// Group rule
		if (item.getRule() == FilterTreeItem.Rule.GROUP) {
			newItem = doc.createElement(GROUP_TAG);
			// Create a configuration
		} else {
			newItem = doc.createElement(CONFIGURATION_TAG);
		}

		// 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() != FilterTreeItem.Rule.GROUP) {
			Attr rule = doc.createAttribute(RULE_TAG);
			if (item.getRule() == FilterTreeItem.Rule.TEXT_RULE) {
				rule.setValue(TEXTRULE_TAG);
			} else if (item.getRule() == FilterTreeItem.Rule.COMPONENT_RULE) {
				rule.setValue(COMPONENTRULE_TAG);
			} else {
				String unknownText = Messages
						.getString("XMLFilterConfigurationExporter.UnknownText"); //$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() == FilterTreeItem.Rule.TEXT_RULE) {
			FilterTreeTextItem textItem = (FilterTreeTextItem) 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);

			// Component rule
		} else if (item.getRule() == FilterTreeItem.Rule.COMPONENT_RULE) {
			FilterTreeComponentItem componentItem = (FilterTreeComponentItem) item;

			// Component ID
			Node component = doc.createElement(COMPONENTID_TAG);
			component.setTextContent(String.valueOf(componentItem
					.getComponentId()));
			newItem.appendChild(component);

			// Group ID
			Node group = doc.createElement(GROUPID_TAG);
			group.setTextContent(String.valueOf(componentItem.getGroupId()));
			newItem.appendChild(group);
		}

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

	/**
	 * Checks it the given item is checked in the filter dialog
	 * 
	 * @param item
	 *            item to be checked
	 * @return true if the given item is checked
	 */
	private boolean isChecked(FilterTreeItem item) {
		boolean checked = false;

		List<FilterRuleObject> rules = TraceViewerGlobals.getTraceViewer()
				.getDataProcessorAccess().getFilterProcessor().getFilterRules()
				.getFilterRules();

		// First object must be rule set
		if (!rules.isEmpty() && rules.get(0) instanceof FilterRuleSet) {
			if (((FilterRuleSet) rules.get(0)).getFilterRules().contains(item)) {
				checked = true;
			}
		}

		return checked;
	}
}