AbstractXDOMDocbookBuilderContext.java

/*
 * Copyright (C) 2010 eXo Platform SAS.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.wikbook.xwiki;

import org.wikbook.core.model.DocbookBuilder;
import org.wikbook.core.model.DocbookBuilderContext;
import org.wikbook.core.ResourceType;
import org.wikbook.core.Utils;
import org.xwiki.rendering.block.Block;
import org.xwiki.rendering.syntax.Syntax;

import java.io.IOException;
import java.io.Reader;
import java.net.URL;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;

/**
 * @author <a href="mailto:julien.viet@exoplatform.com">Julien Viet</a>
 * @version $Revision$
 */
public abstract class AbstractXDOMDocbookBuilderContext extends DocbookBuilderContext
{

   /** . */
   final LinkedList<String> syntaxStack;

   protected AbstractXDOMDocbookBuilderContext()
   {
      this.syntaxStack = new LinkedList<String>();
   }

   protected abstract String getCharsetName();

   /**
    * Load the document with the specified id.
    *
    * @param path the relative document path
    * @param id the document id
    * @return a reader for the document
    * @throws java.io.IOException any io exception
    */
   Reader read(Iterable<String> path, String id) throws IOException
   {
      URL main = resolveResource(ResourceType.WIKI, path, id);
      if (main == null)
      {
         throw new IOException("Could not load wiki document: " + id);
      }

      //
      String charsetName = getCharsetName();
      if (charsetName == null)
      {
         throw new IOException("No charset name specified");
      }

      //
      return Utils.read(main, charsetName);
   }

   public abstract List<URL> resolveResources(ResourceType type, Iterable<String> path, String id) throws IOException;

   public final URL resolveResource(ResourceType type, Iterable<String> path, String id) throws IOException
   {
      List<URL> found = resolveResources(type, path, id);
      return found.isEmpty() ? null : found.get(0);
   }

   public final List<URL> resolveResources(ResourceType type, String id) throws IOException
   {
      return resolveResources(type, null, id);
   }

   public void build(Reader reader, String syntaxId, DocbookBuilder builder)
   {
      if (syntaxId == null)
      {
         if (syntaxStack.isEmpty())
         {
            syntaxId = Syntax.XWIKI_2_0.toIdString();
         }
         else
         {
            syntaxId = syntaxStack.getLast();
         }
      }

      //
      WikiLoader loader = new WikiLoader(this);
      Block block = loader.load(reader, syntaxId);
      XDOMTransformer transformer = new XDOMTransformer(this, builder);
      block.traverse(transformer);
   }
}