Mailing-List: contact commits-help@sis.apache.org; run by ezmlm
Precedence: bulk
Reply-To: sis-dev@sis.apache.org
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Subject: svn commit: r1705272 - in
 /sis/branches/JDK8/core/sis-build-helper/src/main/java/org/apache/sis/internal/book:
 Assembler.java BookException.java
Date: Fri, 25 Sep 2015 11:02:17 -0000
To: commits@sis.apache.org
From: desruisseaux@apache.org
Message-Id: <20150925110218.42E883A0046@svn01-us-west.apache.org>

Author: desruisseaux
Date: Fri Sep 25 11:02:12 2015
New Revision: 1705272

URL: http://svn.apache.org/viewvc?rev=1705272&view=rev
Log:
Use a separated exception for problems related to the content of the files used for building the book (e.g. missing identifier for a chapter).

Added:
    sis/branches/JDK8/core/sis-build-helper/src/main/java/org/apache/sis/internal/book/BookException.java   (with props)
Modified:
    sis/branches/JDK8/core/sis-build-helper/src/main/java/org/apache/sis/internal/book/Assembler.java

Modified: sis/branches/JDK8/core/sis-build-helper/src/main/java/org/apache/sis/internal/book/Assembler.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-build-helper/src/main/java/org/apache/sis/internal/book/Assembler.java?rev=1705272&r1=1705271&r2=1705272&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-build-helper/src/main/java/org/apache/sis/internal/book/Assembler.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-build-helper/src/main/java/org/apache/sis/internal/book/Assembler.java [UTF-8] Fri Sep 25 11:02:12 2015
@@ -83,7 +83,7 @@ public final class Assembler {
     private final Document document;
 
     /**
-     * The node where to write the table of content.
+     * The node where to write the table of content for the whole document.
      */
     private final Element tableOfContent;
 
@@ -210,17 +210,17 @@ public final class Assembler {
      * @param filename  the source XML file in the same directory than the input file given to the constructor.
      * @param toReplace the target XML node to be replaced by the content of the given file.
      */
-    private Node replaceByBody(final String filename, final Node toReplace) throws IOException, SAXException {
+    private Node replaceByBody(final String filename, final Node toReplace) throws IOException, SAXException, BookException {
         final NodeList nodes = load(filename).getElementsByTagName("body");
         if (nodes.getLength() != 1) {
-            throw new IOException(filename + ": expected exactly one <body> element.");
+            throw new BookException(filename + ": expected exactly one <body> element.");
         }
         final Node element = document.createElement("section");
         toReplace.getParentNode().replaceChild(element, toReplace);
         for (Node child : toArray(nodes.item(0).getChildNodes())) {
             child = document.importNode(child, true);   // document.adoptNode(child) would have been more efficient but does not seem to work.
             if (child == null) {
-                throw new IOException("Failed to copy subtree.");
+                throw new BookException("Failed to copy subtree.");
             }
             element.appendChild(child);
         }
@@ -264,7 +264,7 @@ public final class Assembler {
      * @param index {@code true} for including the {@code <h1>}, etc. texts in the Table Of Content (TOC).
      *        This is set to {@code false} when parsing the content of {@code <aside>} or {@code <article>} elements.
      */
-    private void process(Node node, boolean index) throws IOException, SAXException {
+    private void process(Node node, boolean index) throws IOException, SAXException, BookException {
         switch (node.getNodeType()) {
             case Node.COMMENT_NODE: {
                 final String text = node.getNodeValue().trim();
@@ -340,20 +340,17 @@ public final class Assembler {
      *
      * @param level level of the {@code <h1>}, {@code <h2>}, {@code <h3>}, etc. element found.
      */
-    private void appendToTableOfContent(int level, final String id, final String text) throws IOException {
+    private void appendToTableOfContent(int level, final String id, final String text) throws BookException {
         if (id.isEmpty()) {
-            throw new IOException("Missing identifier for header: " + text);
+            throw new BookException("Missing identifier for header: " + text);
         }
         final Element item = document.createElement("li");
-        final Element ref = document.createElement("a");
-        ref.setAttribute("href", "#" + id);
-        ref.setTextContent(text);
-        item.appendChild(ref);
+        item.appendChild(createLink(id, text));
         Node node = tableOfContent;
         while (--level > 0) {
             node = node.getLastChild();     // Last <li> element.
             if (node == null) {
-                throw new IOException("Non-continuous header level: " + text);
+                throw new BookException("Non-continuous header level: " + text);
             }
             Node list = node.getLastChild();    // Search for <ul> element in above <li>.
             if (list == null || !"ul".equals(list.getNodeName())) {
@@ -372,7 +369,7 @@ public final class Assembler {
      *
      * @param head the {@code <h1>} element.
      */
-    private void linkToSiblingChapters(final Element head) {
+    private void linkToSiblingChapters(final Element head) throws BookException {
         final Element links = document.createElement("div");
         links.setAttribute("class", "chapter-links");
         if (previousChapter != null) {
@@ -381,13 +378,10 @@ public final class Assembler {
              *
              *     <div class="previous-chapter">⬅ <a href="#id">Previous chapter</a></div>
              */
-            Element ref = document.createElement("a");
-            ref.setAttribute("href", "#" + previousChapter.getAttribute("id"));
-            ref.setTextContent("Previous chapter");
             final Element previous = document.createElement("div");
             previous.setAttribute("class", "previous-chapter");
             previous.appendChild(document.createTextNode("⬅ "));
-            previous.appendChild(ref);
+            previous.appendChild(createLink(previousChapter.getAttribute("id"), "Previous chapter"));
             links.appendChild(previous);
             /*
              * Update the previous <h1> element with the link to the next chapter,
@@ -395,12 +389,9 @@ public final class Assembler {
              *
              *     <div class="next-chapter"><a href="#id">Next chapter</a> ➡</div>
              */
-            ref = document.createElement("a");
-            ref.setAttribute("href", "#" + head.getAttribute("id"));
-            ref.setTextContent("Next chapter");
             final Element next = document.createElement("div");
             next.setAttribute("class", "next-chapter");
-            next.appendChild(ref);
+            next.appendChild(createLink(head.getAttribute("id"), "Next chapter"));
             next.appendChild(document.createTextNode(" ➡"));
 
             Node previousNav = previousChapter;
@@ -417,14 +408,28 @@ public final class Assembler {
     }
 
     /**
+     * Creates a {@code <a href="reference">text</a>} node.
+     */
+    private Element createLink(final String reference, final String text) throws BookException {
+        if (reference.isEmpty()) {
+            throw new BookException("Missing reference for: " + text);
+        }
+        final Element ref = document.createElement("a");
+        ref.setAttribute("href", "#" + reference);
+        ref.setTextContent(text);
+        return ref;
+    }
+
+    /**
      * Assembles the document and writes to the destination.
      *
      * @param  output the output file (e.g. {@code "site/content/en/developer-guide.html"}).
      * @throws IOException if an error occurred while reading or writing file.
      * @throws SAXException if an error occurred while parsing an input XML.
+     * @throws BookException if an error was found in the content of the XML file.
      * @throws TransformerException if an error occurred while formatting the output XML.
      */
-    public void run(final File output) throws IOException, SAXException, TransformerException {
+    public void run(final File output) throws IOException, SAXException, BookException, TransformerException {
         process(document.getDocumentElement(), true);
         tableOfContent.appendChild(document.createTextNode(LINE_SEPARATOR));
         final Transformer transformer = TransformerFactory.newInstance().newTransformer();

Added: sis/branches/JDK8/core/sis-build-helper/src/main/java/org/apache/sis/internal/book/BookException.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-build-helper/src/main/java/org/apache/sis/internal/book/BookException.java?rev=1705272&view=auto
==============================================================================
--- sis/branches/JDK8/core/sis-build-helper/src/main/java/org/apache/sis/internal/book/BookException.java (added)
+++ sis/branches/JDK8/core/sis-build-helper/src/main/java/org/apache/sis/internal/book/BookException.java [UTF-8] Fri Sep 25 11:02:12 2015
@@ -0,0 +1,37 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.sis.internal.book;
+
+
+/**
+ * Throws when an error is found in the content of the HTML files used for building the developer guide.
+ *
+ * @author  Martin Desruisseaux (Geomatys)
+ * @since   0.7
+ * @version 0.7
+ */
+@SuppressWarnings("serial")
+public class BookException extends Exception {
+    /**
+     * Creates an exception with the given message.
+     *
+     * @param message The exception message.
+     */
+    public BookException(final String message) {
+        super(message);
+    }
+}

Propchange: sis/branches/JDK8/core/sis-build-helper/src/main/java/org/apache/sis/internal/book/BookException.java
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: sis/branches/JDK8/core/sis-build-helper/src/main/java/org/apache/sis/internal/book/BookException.java
------------------------------------------------------------------------------
    svn:mime-type = text/plain;charset=UTF-8