htmlrenderer.java

编辑视频文件

/*
 * File:     HTMLRenderer.java
 * Project:  MPI Linguistic Application
 * Date:     02 May 2007
 *
 * Copyright (C) 2001-2007  Max Planck Institute for Psycholinguistics
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package mpi.eudico.client.annotator.interlinear;

import mpi.eudico.server.corpora.clom.Tier;

import java.io.BufferedWriter;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.StringWriter;
import java.io.Writer;

import java.nio.charset.UnsupportedCharsetException;

import java.text.DateFormat;

import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Locale;
import java.util.Set;


/**
 * A class that renders interlinearized content as tables in a html file, using
 * UTF-8 encoding.
 *
 * @author Han Sloetjes
 * @version 1.0
 */
public class HTMLRenderer {
    /** new line string */
    private final String NEW_LINE = "\n";

    /** new line string */
    private final String BREAK = "<br>";

    /** white space string */
    private final String NBSP = "&nbsp;";
    private Interlinear interlinear;
    private HashMap tierMap;

    /**
     * Creates a new HTMLRenderer instance
     *
     * @param interlinear the Interlinear object holding the formatted,
     *        interlinearized content
     */
    public HTMLRenderer(Interlinear interlinear) {
        this.interlinear = interlinear;
        tierMap = new HashMap();
    }

    /**
     * Renders (writes) the content to a html File, converting annotation blocks to html tables,
     * using the default utf-8 character encoding
     *
     * @param outFile the File to write the html to
     * @throws IOException any IOException that can occur while writing to a file
     * @throws FileNotFoundException thrown when the export file could not be found
     */
    public void renderToFile(File outFile)
        throws IOException, FileNotFoundException {
        renderToFile(outFile, "UTF-8");
    }

    /**
     * Renders (writes) the content to a html File, converting annotation blocks to html tables.
     *
     * @param outFile the File to write the html to
     * @param charEncoding the character encoding for output
     * @throws IOException any IOException that can occur while writing to a
     *         file
     * @throws FileNotFoundException thrown when the export file could not be
     *         found
     * @throws NullPointerException when the Interlinear object or the export
     *         file  is <code>null</code>
     */
    public void renderToFile(File outFile, String charEncoding)
        throws IOException, FileNotFoundException {
        if (interlinear == null) {
            throw new NullPointerException("Interlinear object is null");
        }

        if (outFile == null) {
            throw new NullPointerException("Export file is null");
        }

        tierMap.clear();

        // fill a map of visible tier names to css class names
        Tier ti;

        for (int i = 0; i < interlinear.getVisibleTiers().size(); i++) {
            ti = (Tier) interlinear.getVisibleTiers().get(i);
            tierMap.put(ti.getName(), ("ti-" + i));
        }

        //      create output stream
        BufferedWriter writer = null;

        try {
            FileOutputStream out = new FileOutputStream(outFile);
            OutputStreamWriter osw = null;

            try {
                osw = new OutputStreamWriter(out, charEncoding);
            } catch (UnsupportedCharsetException uce) {
                osw = new OutputStreamWriter(out, "UTF-8");
            }

            writer = new BufferedWriter(osw);

            writeHTMLHeader(writer);
            writeBlocks(writer);
            writeFooter(writer);
        } finally {
            try {
                writer.close();
            } catch (Exception ee) {
            }
        }
    }

    /**
     * Writes html code to a StringWriter, the content of which is returned.
     * Special html generation is applied in order to be able to use the Java JEditorPane
     * to render the preview. This pane with the HTMLEditorkit does not seem to support all
     * css style attributes.
     * @return the html code as a single string
     */
    public String renderToText() {
        tierMap.clear();

        // fill a map of visible tier names to css class names
        Tier ti;

        for (int i = 0; i < interlinear.getVisibleTiers().size(); i++) {
            ti = (Tier) interlinear.getVisibleTiers().get(i);
            tierMap.put(ti.getName(), ("ti-" + i));
        }

        StringWriter writer = new StringWriter(10000);

        try {
            writePreviewHTML(writer);
        } catch (IOException ioe) {
            return writer.toString();
        }

        // System.out.println(writer.toString());
        return writer.toString();
    }

    /**
     * Writes the header part of the html file
     * @param writer the writer
     * @throws IOException io exception
     */
    private void writeHTMLHeader(Writer writer) throws IOException {
        // doctype
        writer.write(
            "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\"" +
            NEW_LINE +
            "\"http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd\">");
        writer.write(NEW_LINE);
        writer.write("<html>" + NEW_LINE + "<head>" + NEW_LINE);
        writer.write(
            "<meta http-equiv=\"content-type\" content=\"text/html;charset=utf-8\">" +
            NEW_LINE);
        writer.write("<title>" + interlinear.getTranscription().getName() +
            "</title>" + NEW_LINE);
        writeStyles(writer);
        writer.write("</head>" + NEW_LINE);
        writer.write("<body>" + NEW_LINE);
        writer.write("<h3>");
        writer.write(interlinear.getTranscription().getFullPath());
        writer.write("</h3>");
        writer.write(NEW_LINE);
        writer.write("<p>");
        writer.write(DateFormat.getDateTimeInstance(DateFormat.FULL,
                DateFormat.SHORT, Locale.getDefault()).format(new Date(
                    System.currentTimeMillis())));
        writer.write("</p>");
        writer.write(NEW_LINE);
        writer.write(NEW_LINE);

        // start outer table
        writer.write("<table class=\"out\">");
        writer.write(NEW_LINE);
    }

    /**
     * Inserts css style sheets into the header of the html document (rather than to a separate css file).
     * Creates a separate style for each tier in the output.
     * @param writer the writer
     * @throws IOException any ioexception
     */
    private void writeStyles(Writer writer) throws IOException {
        writer.write("<style type=\"text/css\" media=\"screen\"><!--" +
            NEW_LINE);

        // body defaults
        writer.write("body {" + NEW_LINE);
        writer.write("background-color: #FFFFF2;" + NEW_LINE);
        writer.write(
            "font-family: \"Arial Unicode MS\", Verdana, Helvetica, sans-serif;" +
            NEW_LINE);
        writer.write("font-weight: normal;" + NEW_LINE);
        writer.write("font-size: 12px;" + NEW_LINE); // default
        writer.write("color: #000000;" + NEW_LINE);
        writer.write("line-height: 15px;" + NEW_LINE);
        writer.write("font-style: normal;" + NEW_LINE);
        writer.write("}" + NEW_LINE);

        // tables for the annotation blocks
        writer.write("table {" + NEW_LINE);
        writer.write("width: auto;" +
            " /* change to 100% to horizontally stretch the table */" +
            NEW_LINE);
        writer.write("border-collapse: collapse;" + NEW_LINE);
        writer.write("border: 1px solid #666666;" + NEW_LINE);
        writer.write("}" + NEW_LINE);

        // the table enclosing the annotation tables
        writer.write("table.out {" + NEW_LINE);
        writer.write("border: 0px;" + NEW_LINE);
        writer.write("width: 100%;" + NEW_LINE);
        writer.write("}" + NEW_LINE);

        // row defaults
        writer.write("tr {" + NEW_LINE);
        writer.write("border-collapse: collapse;" + NEW_LINE);
        writer.write("border: 1px solid #dddddd;" + NEW_LINE);
        writer.write("}" + NEW_LINE);
        writer.write("tr.out {" + NEW_LINE);
        writer.write("border: 0px;" + NEW_LINE);
        writer.write("}" + NEW_LINE);

        // cell defaults
        writer.write("td {" + NEW_LINE);
        writer.write("padding: 2px 8px 2px 2px;" + NEW_LINE);
        writer.write("border-collapse: collapse;" + NEW_LINE);
        writer.write("border: 1px solid #666666;" + NEW_LINE);
        writer.write("}" + NEW_LINE);
        writer.write("td.out {" + NEW_LINE); // cell containing a annotation table
        writer.write("border: 0px;" + NEW_LINE);
        writer.write("}" + NEW_LINE);

        // the tier labels
        writer.write("td.label {" + NEW_LINE);
        writer.write("width: " +
            (int) (1.2 * interlinear.getMetrics().getLeftMargin()) + ";" +
            NEW_LINE);
        writer.write(
            "font-family: \"Arial Unicode MS\", Verdana, Helvetica, sans-serif;" +
            NEW_LINE);
        writer.write("font-weight: bold;" + NEW_LINE);
        writer.write("font-size: 12px;" + NEW_LINE);
        writer.write("color: #444444;" + NEW_LINE);
        writer.write("}" + NEW_LINE);

        // timecode values and labels
        writer.write("td.tclabel {" + NEW_LINE);
        writer.write("width: " +
            (int) (1.2 * interlinear.getMetrics().getLeftMargin()) + ";" +
            NEW_LINE);
        writer.write(
            "font-family: \"Arial Unicode MS\", Verdana, Helvetica, sans-serif;" +
            NEW_LINE);