/*
* $Id: TraxInputHandler.java,v 1.5.2.4 2003/02/25 10:18:32 jeremias Exp $
* ============================================================================
* The Apache Software License, Version 1.1
* ============================================================================
*
* Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modifica-
* tion, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 3. The end-user documentation included with the redistribution, if any, must
* include the following acknowledgment: "This product includes software
* developed by the Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself, if
* and wherever such third-party acknowledgments normally appear.
*
* 4. The names "FOP" and "Apache Software Foundation" must not be used to
* endorse or promote products derived from this software without prior
* written permission. For written permission, please contact
* apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache", nor may
* "Apache" appear in their name, without prior written permission of the
* Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
* DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* ============================================================================
*
* This software consists of voluntary contributions made by many individuals
* on behalf of the Apache Software Foundation and was originally created by
* James Tauber <jtauber@jtauber.com>. For more information on the Apache
* Software Foundation, please see <http://www.apache.org/>.
*/
package org.apache.fop.apps;
// Imported TraX classes
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.Transformer;
import javax.xml.transform.Source;
import javax.xml.transform.stream.StreamSource;
import javax.xml.transform.sax.SAXResult;
import javax.xml.transform.sax.SAXSource;
import javax.xml.transform.sax.SAXTransformerFactory;
// Imported SAX classes
import org.xml.sax.InputSource;
import org.xml.sax.XMLReader;
import org.xml.sax.XMLFilter;
// Imported java.io classes
import java.io.File;
/**
* XSLTInputHandler basically takes an xml source and transforms it with
* an xslt source and the resulting xsl:fo document is input for Fop.
*/
public class TraxInputHandler extends InputHandler {
private Transformer transformer;
private StreamSource xmlSource;
private Source xsltSource;
public TraxInputHandler(File xmlfile, File xsltfile)
throws FOPException {
xmlSource = new StreamSource(xmlfile);
xsltSource = new StreamSource(xsltfile);
initTransformer();
}
public TraxInputHandler(String xmlURL, String xsltURL)
throws FOPException {
this.xmlSource = new StreamSource(xmlURL);
this.xsltSource = new StreamSource(xsltURL);
initTransformer();
}
public TraxInputHandler(InputSource xmlSource, InputSource xsltSource)
throws FOPException {
this.xmlSource = new StreamSource(xmlSource.getByteStream(),
xmlSource.getSystemId());
this.xsltSource = new StreamSource(xsltSource.getByteStream(),
xsltSource.getSystemId());
initTransformer();
}
private void initTransformer() throws FOPException {
try {
transformer = TransformerFactory.newInstance().newTransformer (xsltSource);
}
catch( Exception ex) {
throw new FOPException(ex);
}
}
/**
* Overwrites the method of the super class to return the xmlfile.
* Use run(Driver driver) instead.
* @deprecated
*/
public InputSource getInputSource() {
InputSource is = new InputSource();
is.setByteStream(xmlSource.getInputStream());
is.setSystemId(xmlSource.getSystemId());
return is;
}
/**
* Overwrites this method of the super class and returns an
* XMLFilter instead of a simple XMLReader which allows chaining
* of transformations.
* Use run(Driver driver) instead.
* @deprecated
*
*/
public XMLReader getParser() throws FOPException {
return this.getXMLFilter(xsltSource);
}
/**
* Creates from the transformer an instance of an XMLFilter which
* then can be used in a chain with the XMLReader passed to Driver. This way
* during the conversion of the xml file + xslt stylesheet the resulting
* data is fed into Fop. This should help to avoid memory problems
* @param xmlfile The xmlfile containing the text data
* @param xsltfile An xslt stylesheet
* @return XMLFilter an XMLFilter which can be chained together with other XMLReaders or XMLFilters
*/
private static XMLFilter getXMLFilter(Source xsltSource)
throws FOPException {
try {
// Instantiate a TransformerFactory.
TransformerFactory tFactory = TransformerFactory.newInstance();
// Determine whether the TransformerFactory supports the
// use of SAXSource and SAXResult
if (tFactory.getFeature(SAXSource.FEATURE)
&& tFactory.getFeature(SAXResult.FEATURE)) {
// Cast the TransformerFactory to SAXTransformerFactory.
SAXTransformerFactory saxTFactory =
((SAXTransformerFactory)tFactory);
// Create an XMLFilter for each stylesheet.
XMLFilter xmlfilter =
saxTFactory.newXMLFilter(xsltSource);
// Create an XMLReader.
XMLReader parser = createParser();
if (parser == null) {
throw new FOPException("Unable to create SAX parser");
}
// xmlFilter uses the XMLReader as its reader.
xmlfilter.setParent(parser);
return xmlfilter;
} else {
throw new FOPException("Your parser doesn't support the features SAXSource and SAXResult."
+ "\nMake sure you are using a xsl parser which supports TrAX");
}
} catch (FOPException fex) {
throw fex;
} catch (Exception ex) {
throw new FOPException(ex);
}
}
/**
* Creates from the transformer an instance of an XMLFilter which
* then can be used in a chain with the XMLReader passed to Driver. This way
* during the conversion of the xml file + xslt stylesheet the resulting
* data is fed into Fop. This should help to avoid memory problems
* @param xmlfile The xmlfile containing the text data
* @param xsltfile An xslt stylesheet
* @return XMLFilter an XMLFilter which can be chained together with other XMLReaders or XMLFilters
*/
public static XMLFilter getXMLFilter(File xmlfile,
File xsltfile) throws FOPException {
return getXMLFilter(new StreamSource(xsltfile));
}
public void run(Driver driver) throws FOPException {
try {
transformer.transform(xmlSource,
new SAXResult(driver.getContentHandler()));
} catch (Exception ex) {
throw new FOPException(ex);
}
}
public void setParameter(String name, Object value) {
transformer.setParameter(name, value);
}
}