View Javadoc
1 package org.apache.turbine.services.xslt; 2 3 /* ==================================================================== 4 * The Apache Software License, Version 1.1 5 * 6 * Copyright (c) 2001 The Apache Software Foundation. All rights 7 * reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in 18 * the documentation and/or other materials provided with the 19 * distribution. 20 * 21 * 3. The end-user documentation included with the redistribution, 22 * if any, must include the following acknowledgment: 23 * "This product includes software developed by the 24 * Apache Software Foundation (http://www.apache.org/)." 25 * Alternately, this acknowledgment may appear in the software itself, 26 * if and wherever such third-party acknowledgments normally appear. 27 * 28 * 4. The names "Apache" and "Apache Software Foundation" and 29 * "Apache Turbine" must not be used to endorse or promote products 30 * derived from this software without prior written permission. For 31 * written permission, please contact apache@apache.org. 32 * 33 * 5. Products derived from this software may not be called "Apache", 34 * "Apache Turbine", nor may "Apache" appear in their name, without 35 * prior written permission of the Apache Software Foundation. 36 * 37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 48 * SUCH DAMAGE. 49 * ==================================================================== 50 * 51 * This software consists of voluntary contributions made by many 52 * individuals on behalf of the Apache Software Foundation. For more 53 * information on the Apache Software Foundation, please see 54 * <http://www.apache.org/>;. 55 */ 56 57 import java.io.Reader; 58 import java.io.Writer; 59 import org.apache.turbine.services.Service; 60 import org.w3c.dom.Node; 61 62 /*** 63 * The Turbine XSLT Service is used to transform xml with a xsl stylesheet. 64 * The service makes use of the Xalan xslt engine available from apache. 65 * 66 * 67 * @author <a href="mailto:leon@opticode.co.za">Leon Messerschmidt</a> 68 */ 69 public interface XSLTService 70 extends Service 71 { 72 public static final String SERVICE_NAME = "XSLTService"; 73 74 /*** 75 * Uses an xsl file to transform xml input from a reader and writes the 76 * output to a writer. 77 * 78 * @param xslName The name of the file that contains the xsl stylesheet. 79 * @param in The reader that passes the xml to be transformed 80 * @param out The writer for the transformed output 81 */ 82 public void transform (String xslName, Reader in, Writer out) throws Exception; 83 84 /*** 85 * Uses an xsl file to transform xml input from a reader and returns a 86 * string containing the transformed output. 87 * 88 * @param xslName The name of the file that contains the xsl stylesheet. 89 * @param in The reader that passes the xml to be transformed 90 */ 91 public String transform (String xslName, Reader in) throws Exception; 92 93 /*** 94 * Uses an xsl file to transform xml input from a DOM note and writes the 95 * output to a writer. 96 * 97 * @param xslName The name of the file that contains the xsl stylesheet. 98 * @param in The DOM Node to be transformed 99 * @param out The writer for the transformed output 100 */ 101 public void transform (String xslName, Node in, Writer out) throws Exception; 102 103 /*** 104 * Uses an xsl file to transform xml input from a DOM note and returns a 105 * string containing the transformed output. 106 * 107 * @param xslName The name of the file that contains the xsl stylesheet. 108 * @param out The writer for the transformed output 109 */ 110 public String transform (String xslName, Node in) throws Exception; 111 }

This page was automatically generated by Maven