| <?xml version="1.0" standalone="no"?> |
| <!DOCTYPE s1 SYSTEM "../../style/dtd/document.dtd"> |
| |
| <!-- |
| * 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 |
| * modification, 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 "Xalan" 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 (INCLUDING, 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 based on software copyright (c) 1999, Lotus |
| * Development Corporation., http://www.lotus.com. For more |
| * information on the Apache Software Foundation, please see |
| * <http://www.apache.org/>. |
| --> |
| |
| <s1 title="Extensions for &xslt4jc-short;"> |
| <ul> |
| <li><link anchor="intro">Introduction</link></li> |
| <li><link anchor="constraints">Constraints</link></li> |
| <li><link anchor="java_ext">Java extension</link></li> |
| <li><link anchor="exslt_ext">EXSLT extensions</link></li> |
| <li><link anchor="nodeset_ext">nodeset</link></li> |
| <li><link anchor="redirect_ext">output/redirect</link></li> |
| </ul> |
| <anchor name="intro"/> |
| <s2 title="Introduction"> |
| <p>&xslt4jc-short; supports the use of extension functions implemented in external Java classes. It also |
| supports the <link anchor="nodeset_ext">nodeset</link>, <link anchor="redirect_ext">output/redirect</link> |
| and <link anchor="exslt_ext">EXSLT</link> extension functions. Extension support in &xslt4jc-short; is |
| still under development. It is currently not as complete as the extension support in the |
| &xslt4j; Interpretive processor. There are constraints in some areas.</p> |
| </s2> |
| |
| <anchor name="constraints"/> |
| <s2 title="Constraints"> |
| <p>In addition to the constraints listed below for each particular extension, extension support |
| in &xslt4jc-short; also has the following limitations:</p> |
| <ol> |
| <li><link idref="extensions" anchor="ext-elements">Extension element</link> is not supported. |
| The extension element mechanism is closely related to the internal implementation of the XSLT processor. |
| The current extension element mechansim is designed for the &xslt4ji; processor. It does not work with &xslt4jc-short;.</li> |
| <li>The <link idref="extensions" anchor="supported-lang">xalan:component and xalan:script</link> extension elements are not supported at the moment. This has |
| the implication that you cannot use scripting languages (e.g. javascript) with &xslt4jc-short;.</li> |
| <li><link idref="extensionslib" anchor="sql">The SQL extension</link> is not supported in &xslt4jc-short; at the moment.</li> |
| </ol> |
| </s2> |
| |
| <anchor name="java_ext"/> |
| <s2 title="Java extension"> |
| <p>Java extension is supported in &xslt4jc-short;. Constructors, static and instance methods are all supported. |
| You can use any of the <link idref="extensions" anchor="ext-func-calls">three namespace formats</link> |
| (Java, package and class) in your stylesheet. |
| </p> |
| <p>The official namespace for the Java extension is <code>http://xml.apache.org/xalan/java</code>. The old &xslt4jc-short; Java namespace |
| <code>http://xml.apache.org/xalan/xsltc/java</code> and the old &xslt4j; namespace <code>http://xml.apache.org/xslt/java</code> |
| are also supported for backward compatibility.</p> |
| <p>All usage syntax for the &xslt4j; Interpretive processor also applies to &xslt4jc-short; with only one |
| exception: &xslt4jc-short; does not support the notion of default object |
| in <link idref="extensions" anchor="ext-func-calls">class format namespace</link>. |
| When using instance methods, you should always specify the class instance as the first argument |
| to the extension function.</p> |
| <p>The following example shows you how to call constructors, static, and nonstatic functions, |
| using different namespace formats:</p> |
| |
| <source><xsl:stylesheet version="1.0" |
| xmlns:xsl="http://www.w3.org/1999/XSL/Transform" |
| xmlns:date="http://xml.apache.org/xalan/java/java.util.Date" |
| xmlns:java_lang="http://xml.apache.org/xalan/java/java.lang" |
| exclude-result-prefixes="date java_lang"> |
| |
| <!-- |
| * test: construction of Date object using a parameter calculated |
| * by a static call to the java.lang.Math object. Then call |
| * a non-static method (getTime()) on the newly created Date |
| * object. Demonstrates calling constructors, static functions |
| * (Math.max) and non-static functions (getTime()). |
| * |
| * Output: |
| * <?xml version="1.0" encoding="UTF-8"?> |
| * Date of object: Sat Nov 30 17:32:41 EST 2002 |
| * Time of object: 1038695561000 |
| * |
| --> |
| |
| <xsl:template match="/"> |
| <!-- create Date object with calculated parameter --> |
| <xsl:variable name="dateObject" |
| select="date:new( |
| java_lang:Math.max(1027695561000,1038695561000) |
| )"/> |
| Date of object: <xsl:value-of select="$dateObject"/> |
| Time of object: <xsl:value-of select="date:getTime($dateObject)"/> |
| </xsl:template> |
| |
| </xsl:stylesheet> |
| </source> |
| <note>Always use the abbreviated syntax for Java extension, because the xalan:component/xalan:script |
| constructs are not supported in &xslt4jc-short;.</note> |
| </s2> |
| |
| <anchor name="exslt_ext"/> |
| <s2 title="EXSLT extensions"> |
| <p>The following EXSLT extension modules are supported in &xslt4jc-short;:</p> |
| <ul> |
| <li><jump href="apidocs/org/apache/xalan/lib/ExsltCommon.html">EXSLT common functions</jump></li> |
| <li><jump href="apidocs/org/apache/xalan/lib/ExsltMath.html">EXSLT math functions</jump></li> |
| <li><jump href="apidocs/org/apache/xalan/lib/ExsltSets.html">EXSLT set functions</jump></li> |
| <li><jump href="apidocs/org/apache/xalan/lib/ExsltDatetime.html">EXSLT date-and-time functions</jump></li> |
| <li><jump href="apidocs/org/apache/xalan/lib/ExsltStrings.html">EXSLT string functions</jump></li> |
| </ul> |
| <p>The functions in the <jump href="apidocs/org/apache/xalan/lib/ExsltDynamic.html">dynamic</jump> module |
| (e.g. evaluate) are not supported because of the &xslt4jc-short; design limitation. |
| Work is currently underway on <jump href="http://www.exslt.org/func/elements/function/index.html">user |
| defined EXSLT functions (with the function and result elements)</jump>.</p> |
| <p>The <code>nodeset</code> and <code>objectType</code> extension functions in the <jump href="apidocs/org/apache/xalan/lib/ExsltCommon.html">common</jump> |
| module are implemented natively in &xslt4jc-short;. For all other EXSLT extension functions, |
| &xslt4jc-short; uses the same implementation as the &xslt4j; Interpretive processor. The implementation classes |
| are under <code>org.apache.xalan.lib</code>. |
| Depending on the packaging, these classes can be in a separate jar file (e.g. xalan.jar) from |
| the &xslt4jc-short; classes. In this case you need to add the jar file containing the EXSLT classes to your |
| classpath in order to use EXSLT extensions in &xslt4jc-short;.</p> |
| </s2> |
| |
| <anchor name="nodeset_ext"/> |
| <s2 title="nodeset"> |
| <p>&xslt4jc-short; also supports the nodeset() extension function for transforming an RTF (result |
| tree fragment) into a node set.</p> |
| <p>The nodeset extension can be used as an &xslt4jc-short; extension function in the namespace |
| <code>http://xml.apache.org/xalan/xsltc</code>, a &xslt4j; extension function in the namespace |
| <code>http://xml.apache.org/xalan</code>, an EXSLT extension function in the namespace |
| <code>http://exslt.org/common</code> or as a standard XPATH function. When it is used as |
| an EXSLT extension function, you need to refer to the nodeset extension function as |
| <code>node-set</code>.</p> |
| <p>The following exmaple shows you how to use the nodeset extension |
| function in different namespaces:</p> |
| <source><xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" |
| xmlns:xsltc-extension="http://xml.apache.org/xalan/xsltc" |
| xmlns:xalan="http://xml.apache.org/xalan" |
| xmlns:exslt="http://exslt.org/common" |
| version="1.0"> |
| <xsl:template match="/"> |
| <xsl:variable name="rtf"> |
| <docelem> |
| <elem1>elem1</elem1> |
| <elem2>elem2</elem2> |
| </docelem> |
| </xsl:variable> |
| <!-- Use nodeset as an XSLTC extension function --> |
| <xsl:value-of select="xsltc-extension:nodeset($rtf)/docelem/elem1"/> |
| <!-- Use nodeset as a &xslt4j; extension function --> |
| <xsl:value-of select="xalan:nodeset($rtf)/docelem/elem1"/> |
| <!-- Use nodeset as an EXSLT extension function --> |
| <xsl:value-of select="exslt:node-set($rtf)/docelem/elem1"/> |
| <!-- Use nodeset as standard function --> |
| <xsl:value-of select="nodeset($rtf)/docelem/elem1"/> |
| </xsl:template> |
| </xsl:stylesheet> |
| </source><br/> |
| <note>The preferred solution is to use the EXSLT node-set function so that it can work |
| with multiple XSLT processors.</note> |
| </s2> |
| |
| <anchor name="redirect_ext"/> |
| <s2 title="output/redirect"> |
| <p>&xslt4jc-short; supports the output extension element for redirecting the output to one |
| or more files. The output extension element is also aliased to the write extension element |
| in the namespace <code>http://xml.apache.org/xalan/redirect</code>. Therefore you can use |
| it in the same way as the <link idref="extensionslib" anchor="redirect">redirect</link> |
| extension in &xslt4j;.</p> |
| <p>You can use the file and append attributes with the output/redirect extension. The value of the file |
| attribute is an attribute value template. If the value of the append attribute is true or yes, the |
| output is appended to the file rather than overwriting the file.</p> |
| <p>The following example shows you how to use the output/redirect extension:</p> |
| <source> <xsl:stylesheet |
| xmlns:xsl="http://www.w3.org/1999/XSL/Transform" |
| xmlns:xsltc="http://xml.apache.org/xalan/xsltc" |
| xmlns:redirect="http://xml.apache.org/xalan/redirect" |
| extension-element-prefixes="xsltc redirect" |
| version="1.0"> |
| <xsl:template match="/"> |
| <xsl:text>This goes to standard output</xsl:text> |
| <xsltc:output file="blob.xml"> |
| <xsl:text>This ends up in the file 'blob.xml'</xsl:text> |
| </xsltc:output> |
| <redirect:write file="blob2.xml"> |
| <xsl:text>This ends up in the file 'blob2.xml'</xsl:text> |
| </redirect:write> |
| </xsl:template> |
| </xsl:stylesheet></source> |
| </s2> |
| |
| </s1> |
