/*
    * Copyright 2010-2013 smartics, Kronseder & Reiner GmbH
    *
    * Licensed under the Apache License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    *
    *     http://www.apache.org/licenses/LICENSE-2.0
    *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package de.smartics.testdoc.core.export;
  
  import java.util.List;
  
  import org.w3c.dom.DOMException;
  import org.w3c.dom.Document;
  import org.w3c.dom.Element;
  import org.w3c.dom.Text;
  
  import de.smartics.testdoc.core.doc.ScenarioTestDoc;
  import de.smartics.testdoc.core.doc.TestMethodDoc;
  import de.smartics.testdoc.core.doc.Type;
  import de.smartics.testdoc.core.doc.UnitTestDoc;
  
  /**
   * Creates an XML document instance.
   *
   * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
   * @version $Revision:591 $
   */
  class XmlDocumentBuilder
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * The URI of the XML schema instance.
     * <p>
     * The value of this constant is {@value}.
     * </p>
     */
    private static final String XML_SCHEMA_INSTANCE =
        "http://www.w3.org/2001/XMLSchema-instance";
  
    /**
     * The URI of the test documentation doctype.
     * <p>
     * The value of this constant is {@value}.
     * </p>
     */
    private static final String CODE_URI =
        "http://www.smartics.de/project/process/implementation/testdoc";
  
    // --- members --------------------------------------------------------------
  
    /**
     * The empty document to write to.
     */
    private final Document document;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     */
    XmlDocumentBuilder(final Document document)
    {
      this.document = document;
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    // --- get&set --------------------------------------------------------------
  
    // --- business -------------------------------------------------------------
  
    Document build(final UnitTestDoc testDoc) throws DOMException
    {
      final Element root = createDocRoot();
  
      addUutElement(testDoc, root);
      addScenarioElements(testDoc, root);
  
      return document;
    }
  
    private Element createDocRoot() throws DOMException
   {
     final Element docRoot = document.createElement("testdoc");
     docRoot.setAttribute("xmlns:xsi", XML_SCHEMA_INSTANCE);
     docRoot.setAttribute("xmlns", CODE_URI);
     docRoot.setAttribute("xsi:schemaLocation", CODE_URI + ' ' + CODE_URI);
     document.appendChild(docRoot);
     return docRoot;
   }
 
   private void addUutElement(final UnitTestDoc testDoc, final Element root)
   {
     final Type uutType = testDoc.getUutType();
     final Element uut = createTextElement("uut", uutType.toString());
     root.appendChild(uut);
   }
 
   private void addScenarioElements(final UnitTestDoc testDoc, final Element root)
   {
     final List<ScenarioTestDoc> scenarios = testDoc.getScenarios();
     if (!scenarios.isEmpty())
     {
       final Element scenariosElement = document.createElement("scenarios");
 
       for (final ScenarioTestDoc scenario : scenarios)
       {
         final Element scenarioElement = createScenarioElement(scenario);
         scenariosElement.appendChild(scenarioElement);
       }
       root.appendChild(scenariosElement);
     }
   }
 
   private Element createScenarioElement(final ScenarioTestDoc scenario)
   {
     final Element scenarioElement = document.createElement("scenario");
 
     final Element testCase =
         createTextElement("testCase", scenario.getTestCaseType().toString());
     scenarioElement.appendChild(testCase);
     final TestMethodDoc testMethod = scenario.getTestMethod();
     final Element testName =
         createTextElement("testName", testMethod.getTestName());
     scenarioElement.appendChild(testName);
     final Element sentence =
         createTextElement("sentence", testMethod.getTestSentence());
     scenarioElement.appendChild(sentence);
 
     appendCategories(scenarioElement, scenario);
 
     return scenarioElement;
   }
 
   private void appendCategories(final Element scenarioElement,
       final ScenarioTestDoc scenario)
   {
     final List<String> categories = scenario.getCategories();
     if (!categories.isEmpty())
     {
       final Element categoriesElement = document.createElement("categories");
 
       for (final String category : categories)
       {
         final Element categoryElement = createTextElement("category", category);
         categoriesElement.appendChild(categoryElement);
       }
 
       scenarioElement.appendChild(categoriesElement);
     }
   }
 
   private Element createTextElement(final String elementName,
       final String content)
   {
     final Element element = document.createElement(elementName);
     final Text text = document.createTextNode(content);
     element.appendChild(text);
     return element;
   }
 
   // --- object basics --------------------------------------------------------
 
 }