/* 
 * This file is part of the Echo Point Project.  This project is a collection
 * of Components that have extended the Echo Web Application Framework.
 *
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 */
package echopointng.ui.template;

import java.io.InputStream;
import java.io.InputStreamReader;

import javax.xml.parsers.DocumentBuilder;

import nextapp.echo2.webcontainer.RenderContext;
import nextapp.echo2.webrender.output.HtmlDocument;
import nextapp.echo2.webrender.util.DomUtil;

import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.xml.sax.InputSource;

import echopointng.template.TemplateDataSource;

/**
 * <code>XHTMLTemplateCompiler</code> can compile source XHTML template data
 * into.. well a XHTML DOM Element.
 */

public class XHTMLTemplateCompiler implements TemplateCompiler {

	/**
	 * @see echopointng.ui.template.TemplateCompiler#compileTemplateDataIntoXHTML(nextapp.echo2.webcontainer.RenderContext,
	 *      echopointng.template.TemplateDataSource)
	 */
	public Element compileTemplateDataIntoXHTML(RenderContext rc, TemplateDataSource tds) throws Exception {
		return compileXHTML(tds.getInputStream(), tds.getCharacterEncoding());
	}

	/**
	 * This does the actual compiling of a stream of XHTML into a XHTML DOM
	 * Element.
	 * 
	 * @param inputStream -
	 *            this must be a stream of XHTML data
	 * @param characterEncoding -
	 *            the encoding to use
	 * @return
	 * @throws Exception
	 */
	protected Element compileXHTML(InputStream inputStream, String characterEncoding) throws Exception {
		long startMS = System.currentTimeMillis();

		InputSource inputSource = new InputSource();
		inputSource.setCharacterStream(new InputStreamReader(inputStream,characterEncoding));
		inputSource.setByteStream(inputStream);
		inputSource.setEncoding(characterEncoding);
		inputSource.setPublicId(HtmlDocument.XHTML_1_0_TRANSITIONAL_PUBLIC_ID);
		inputSource.setSystemId(HtmlDocument.XHTML_1_0_TRANSITIONAL_SYSTSEM_ID);
		
		DocumentBuilder docBuilder = DomUtil.getDocumentBuilder();
		Document document = docBuilder.parse(inputSource);
		Element documentElement = document.getDocumentElement();

		long compileMS = System.currentTimeMillis() - startMS;
		if (compileMS == 0);
		return documentElement;
	}

}
