/* 
 *
 * SchemaCrawler
 * http://sourceforge.net/projects/schemacrawler
 * Copyright (c) 2000-2009, Sualeh Fatehi.
 *
 * This library 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 library 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
 * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 */

package schemacrawler.tools.util;


import schemacrawler.tools.OutputFormat;
import schemacrawler.utility.Utility;

/**
 * Methods to format entire rows of output as HTML.
 * 
 * @author Sualeh Fatehi
 */
public final class HtmlFormattingHelper
  extends BaseTextFormattingHelper
{
  /**
   * HTML footer.
   */
  private static final String HTML_FOOTER = "</body>" + NEWLINE + "</html>";
  /**
   * HTML header.
   */
  private static final String HTML_HEADER = htmlHeader();

  private static String htmlHeader()
  {
    final String styleSheet = Utility.readFully(HtmlFormattingHelper.class
      .getResourceAsStream("/schemacrawler-output.css"));

    final String header = ""
                          + "<?xml version='1.0' encoding='UTF-8'?>"
                          + NEWLINE
                          + "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">"
                          + NEWLINE
                          + "<html xmlns='http://www.w3.org/1999/xhtml'>"
                          + NEWLINE + "<head>" + NEWLINE
                          + "  <title>SchemaCrawler Output</title>" + NEWLINE
                          + "  <style type='text/css'>" + NEWLINE + styleSheet
                          + NEWLINE + "  </style>" + NEWLINE + "</head>"
                          + NEWLINE + "<body>" + NEWLINE;
    return header;
  }

  public HtmlFormattingHelper(final OutputFormat outputFormat)
  {
    super(outputFormat);
  }

  public String createArrow()
  {
    return " → ";
  }

  /**
   * {@inheritDoc}
   * 
   * @see schemacrawler.tools.util.TextFormattingHelper#createDocumentEnd()
   */
  public String createDocumentEnd()
  {
    return HTML_FOOTER;
  }

  /**
   * {@inheritDoc}
   * 
   * @see schemacrawler.tools.util.TextFormattingHelper#createDocumentStart()
   */
  public String createDocumentStart()
  {
    return HTML_HEADER;
  }

  /**
   * {@inheritDoc}
   * 
   * @see schemacrawler.tools.util.TextFormattingHelper#createObjectEnd()
   */
  public String createObjectEnd()
  {
    return "</table>" + NEWLINE + "<p></p>" + NEWLINE;
  }

  /**
   * {@inheritDoc}
   * 
   * @see schemacrawler.tools.util.TextFormattingHelper#createObjectStart(java.lang.String)
   */
  public String createObjectStart(final String name)
  {
    String objectStart = "<table>" + NEWLINE;
    if (!schemacrawler.utility.Utility.isBlank(name))
    {
      objectStart = objectStart + "  <caption>" + name + "</caption>" + NEWLINE;
    }
    return objectStart;
  }

  /**
   * {@inheritDoc}
   * 
   * @see schemacrawler.tools.util.TextFormattingHelper#createPreformattedText(java.lang.String,
   *      java.lang.String)
   */
  public String createPreformattedText(final String id, final String text)
  {
    return String.format("<pre id=\'%s\'>%n%s</pre>", id, text);
  }

}