

































|
 |  |  |  | Samples to help you get started |  |  |  |  |
| |
Each of the subdirectories in the Xalan-Java java/samples directory contains the source files for one or more
sample applications. The class files for the samples are in xalansamples.jar (everything except the servlet) and xalanservlet.jar, so to run the samples, you should place these JAR files on the system classpath.
With most of the samples, you can use the following procedure:
- Be sure xalan.jar, xml-apis.jar, xalansamples.jar, and xercesImpl.jar are on the system class
path. For the extension examples, bsf.jar and (for the JavaScript extensions) js.jar must also be on the class
path.
- Be sure the java executable is on your path.
- Go to the samples subdirectory containing the sample (use the DOS shell if you are running Windows).
- Run the sample from the command line (as indicated below).
- Examine the application source files. You may also want to modify the source files. Remember that if you
modify a java file, you must recompile the class and place it on the classpath before you can run the
modified application.
The basic command line for running most of the samples is
java classname args
where classname is the sample class and args are the arguments, if any. As described in
the following sections, some samples take no arguments. The UseStylesheetParam sample takes an
additional argument. Several samples in extensions use the Xalan-Java
command-line utility, so they take arguments for the XML source
file and the XSL stylesheet.
|
| |
What it does: The SimpleTransform class uses the birds.xsl stylesheet to transform birds.xml, and prints the
output to birds.out.
You can run it from the SimpleTransform subdirectory with
java SimpleTransform
|
| |
What it does: The UseStylesheetPI class uses the stylesheet processing instruction in the XML source document to determine
which stylesheet to use to perform the transformation.
You can run it from the UseStylesheetPI subdirectory with
java UseStylesheetPI
For more information, see Working with embedded stylesheets.
|
| |
What it does: The UseStyleSheetParam class uses foo.xsl and a stylesheet parameter to transform foo.xml,
and prints the output to System.out. The stylesheet parameter appears as a text node in the output.
Run this sample from the UseStylesheetParam subdirectory with
java UseStylesheetParam param
where param is the stylesheet parameter value (a string of your choice).
|
| |
What it does: Explicitly set the SAX XMLReader and SAX ContentHandler for processing the stylesheet (birds.xsl), processing the XML input (birds.xml), and producing the output (birds.out).
Run this sample from the SAX2SAX subdirectory with
java SAX2SAX
|
| |
What it does: the DOM2DOM class uses the birds.xsl stylesheet to transform a DOM Document generated from birds.xml,
produces an output DOM, and traverses the DOM, printing the traversal to System.out. In contrast to SimpleTransform,
DOM2DOM illustrates the procedure for processing an input DOM and creating an output DOM that is available for
further processing.
You can run it from the DOM2DOM subdirectory with
java DOM2DOM
|
| |
What it does: Pipes the output from one transformation to a second transformation, then from the second
transformation to the third transformation. Transformer1 is the ContentHandler for the XMLReader (which parses the
input document). Transformer2 provides the ContentHandler for Transformer1, and Transformer3 for Transformer2.
 | Pipe and UseXMLFilters illustrate two strategies for using the output of one transformation as the input for
another transformation. The Pipe sample incorporates a "push" model -- Transformer1 "pushes" its output to
Transformer2, and so on -- whereas in the UseXMLFilters sample, Transformer3 "pulls" its input from Transformer2,
and so on. |
Run this sample from the Pipe subdirectory with
java Pipe
|
| |
What it does: Chains together the same transformations as the preceding Pipe sample. Using each Transformer
object as an extension of the SAX XMLFilter interface, sets the XMLReader as the parent of filter1,
filter1 as the parent of filter2, and filter2 as the parent of of filter3.

Run this sample from the UseXMLFilters subdirectory with
java UseXMLFilters
|
| |
What it does: ApplyXPath uses the XPathAPI convenience methods to
execute an XPath expression against an XML document and return the nodes (if any) it finds.
 | You can use this sample as an aid when you want to find out what a given XPath expression returns from a
given XML file. Keep in mind that the context node (base point of evaluation) for the XPath expression is the document
root. |
Run this sample from the ApplyXPath subdirectory with
java ApplyXPath XMLFile XPathExpression
where XMLFile is an XML source file and XPathExpression is an XPath expression to
apply to that file. The ApplyXPath subdirectory contains an XML file named foo.xml --
<doc><name first="David" last="Marston"/>...</doc> -- so you can try command
lines like
java ApplyXPath foo.xml /
and
java ApplyXPath foo.xml /doc/name/@first
For more information, see Working with XPath expressions.
|
| |
The applet uses a stylesheet to transform an XML document into HTML. It displays the XML document, the
stylesheet, and the HTML output.
How to run it: Open appletXMLtoHTML.hmtl in the Internet Explorer 5 browser.
 | For information about running Xalan-Java applets in Netscape Communicator, see Problems
with Netscape.
This applet looks for xalan.jar, xml-apis.jar, and xercesImpl.jar (Xerces-J2) or xerces.jar (Xerces-J 1) in the bin
subdirectory. If you have placed these JAR files
elsewhere, adjust the applet archive setting in client.html accordingly. |
|
| |
What it does: ApplyXPathDOM is very similar to the ApplyXPath sample, but it uses the API
in the DOM Level 3 XPath
Specification to execute an XPath expression against an XML document and return
the nodes (if any) it finds. At the time of writing the DOM Level 3 XPath Specification is in
Last Call.
 | You can use this sample as an aid when you want to find out what a given XPath expression returns from a
given XML file. Keep in mind that the context node (base point of evaluation) for the XPath expression is the document
root. |
Run this sample from the ApplyXPathDOM subdirectory with
java ApplyXPathDOM XMLFile XPathExpression
where XMLFile is an XML source file and XPathExpression is an XPath expression to
apply to that file. The ApplyXPathDOM subdirectory contains an XML file named foo.xml --
<doc><name first="David" last="Marston"/>...</doc> -- so you can try command
lines like
java ApplyXPathDOM foo.xml /
and
java ApplyXPathDOM foo.xml /doc/name/@first
For more information, see Working with XPath expressions.
|
| |
The applet uses a stylesheet to transform an XML document into HTML. It displays the XML document, the
stylesheet, and the HTML output.
How to run it: Open appletXMLtoHTML.hmtl in the Internet Explorer 5 browser.
 | For information about running Xalan-Java applets in Netscape Communicator, see Problems
with Netscape.
This applet looks for xalan.jar, xml-apis.jar, and xercesImpl.jar (Xerces-J2) or xerces.jar (Xerces-J 1) in the bin
subdirectory. If you have placed these JAR files
elsewhere, adjust the applet archive setting in client.html accordingly. |
|
| |
For a general introduction, see Using Xalan-Java in a servlet.
The servlet subdirectory contains four sample servlets that use Xalan-Java to perform transformations. These servlets
are in a package named servlet and are compiled in xalanservlet.jar. To run these samples, you must place
xalanservlet.jar, and any XML and XSL files you want to use on a web server with a servlet engine, place
xalanservlet.jar, xalan.jar, and xercesImpl.jar on the servlet engine class path, and configure the servlet engine to
locate the XML and XSL files, and the properties file used by ApplyXSL.
servlet.SimpleXSLTServlet applies a particular stylesheet to a particular
XML document.
servlet.UseStylesheetParamServlet sets a stylesheet parameter
(the parameter name is hardwired into the servlet), and requires the user to supply parameters for the
XML document and XSL stylesheet.
jspSample.jsp is a Java ServerPage that sets a stylesheet parameter and applies the
stylesheet to the XML document.
servlet.XSLTServletWithParams accepts parameters for the XML document,
the XSL stylesheet, and any number of stylesheet parameters.
servlet.ApplyXSLT (and associated classes) is closer to a production level servlet. It accepts parameters, provides a
listener for capturing and reporting debugger messages, and supports use of a property file to determine which
stylesheet to apply based on the identity of the client browser/device.
 |  |  |  | servlet.UseStylesheetParamServlet |  |  |  |  |
| |
 | Paul Campbell <seapwc@halcyon.com> wrote this servlet and the following explanatory text.
Thank you, Paul! |
What it does: The client (perhaps an HTML form ) specifies an XML document, a stylesheet, and a value to be passed
to the stylesheet for a stylesheet parameter named "param1". The servlet performs the transformation and returns
the output to the client. The client must specify which stylesheet (containing a "param1" stylesheet parameter")
and XML file are to be used.
How to run it: Configure your application server (Tomcat, Websphere or JServ, for example)
so it can find servlet.UseStylesheetParamServlet (in xalanservlet.jar) as well as the XML document
and XSL stylesheet. For example, you can copy fooparam.xml and fooparam.xsl from samples/servlet to the application
server root directory for documents.
Then you can set up an HTML client to call the servlet with arguments along the lines of
- http://localhost/servlethome/servlet.UseStylesheetParamServlet?
XML=fooparam.xml&XSL=fooparam.xsl&PVAL=GoodBye
In the doGet() method, the servlet obtains the PVAL value "GoodBye") from the servlet request and passes it to the
stylesheet as the paramValue argument in a Transformer setParameter() call:
String paramValue = httpServletRequest.getParameter("PVAL");
...
transformer.setParameter("param1", paramValue);
The result is returned to the client:
<html><body><p>GoodBye</p></body></html>
|
| |
 | Paul Campbell <seapwc@halcyon.com> wrote this Java Server Page. |
This Java Server Page performs essentially the same operation as
servlet.UseStylesheetParamServlet. It applies a stylesheet parameter
to a stylesheet (fooparam.xsl), applies the stylesheet to an XML source document (fooparam.xml), and returns the
result.
|
| |
What it does: The client (which you must set up) specifies an XML document and a stylesheet. The servlet
performs the transformation and returns the output to the client. You can use media.properties to specify
which stylesheet is to be used depending on the client browser/device.
 | The source files for this servlet include ApplyXSLT.java, ApplyXSLTProperties.java, DefaultApplyXSLTProperties.java,
ApplyXSLTListener.java, and ApplyXSLTException.java. |
To run the servlet: put xalanservlet.jar on the servlet engine classpath, configure your servlet engine so it can find the
stylesheets and properties file in the servlet subdirectory (and in xalanservlet.jar), and set up an HTML page to call
servlet.ApplyXSLT with arguments as illustrated below.
Examples:
- http://localhost/servlethome/servlet.ApplyXSLT?URL=/data.xml&xslURL=
/style.xsl
- ...applies the style.xsl stylesheet to the data.xml data. Both files are
served from the Web server's HTTP document root.
- http://localhost/servlethome/servlet.ApplyXSLT?URL=/data.xml&xslURL=
/style.xsl&debug=true
- ...ensures that XML and XSL processor messages are returned in the event of problems
applying style.xsl to data.xml
- http://localhost/servlethome/servlet.ApplyXSLT/data.xml?xslURL=/style.xsl
- ...applies the style.xsl stylesheet to the data.xml data, just like the first example.
This is an alternative way of specifying the XML XSLTInputSource by utilizing the HTTP request's path
information.
- http://localhost/servlethome/servlet.ApplyXSLT/data.xml
- ...examines data.xml for an associated XSL stylesheet (a stylesheet Processing Instruction). If multiple XSLs are associated with the data, the stylesheet whose media attribute maps to your browser type will be chosen. If no mapping is successful, the primary associated stylesheet is used.
- http://localhost/servlet/data.xml
- ...provides the same function as the previous example, but this example assumes
that /servlet/data.xml has been mapped to be executed by this servlet. The servlet engine may be configured
to map all or some *.xml files to this servlet through the use of servlet aliases or filters.
- http://localhost/servlet/data.xml?catalog=http://www.xml.org/dtds/oag.xml
- ...supplements any servlet-configured XCatalog
with a catalog of supply chain DTDs residing at the XML.ORG DTD repository.
|
|
| |
For an introduction to the creation and use of extension elements and extension functions, and
for information about the extensions library distributed with Xalan-Java, see
Extensions.
The extensions subdirectory contains six samples with Xalan-Java extensions. Two of the samples use
extensions implemented in JavaScript, and four of the samples use extensions implemented in Java.
To run these examples, you must place bsf.jar (distributed with Xalan-Java), and js.jar
(version 1.5, available from
http://www.mozilla.org/rhino) on the classpath.
You do not need js.jar on the classpath for the samples that use Java extensions.
Use java.org.apache.xalan.xslt.Process, the Xalan-Java command-line utility, to run most of these samples from
the command line. The command line must include an -in flag with the
XML source and an -xsl flag with the XSL stylesheet. If you want the output to be written to a file, rather
than to the screen, add an -out flag with the output file name.
Run these samples from the extensions directory as follows (each of the following is a single command
line):
| |
What it does: Uses the Redirect extension elements shipped with Xalan-Java to direct output to two output
files.
Run this sample from the extensions subdirectory with
java org.apache.xalan.xslt.Process -in 1-redir.xml
-xsl 1-redir.xsl
The standard (non-redirected) output is written to the screen. The redirected output is written to 1-redir-out, or
whatever filename you assign to the doc/foo @file attribute in 1-redir.xml. The stylesheet gets the file name for
redirected output from the XML input file.
|
| |
What it does: Uses an extension element and extension function implemented in JavaScript to compute a
deadline for responding to a customer inquiry.
 | js.jar must be on the classpath. |
Run this sample from the extensions subdirectory with
java org.apache.xalan.xslt.Process -in 2-basicJscript.xml
-xsl 2-basicJscript.xsl
|
| |
What it does: Uses extension functions to format dates. This sample illustrates use of the predefined java
extension namespace to provide ready access to extensions implemented in Java.
Run this sample from the extensions subdirectory with
java org.apache.xalan.xslt.Process -in 3-java-namespace.xml
-xsl 3-java-namespace.xsl
|
| |
What it does: Uses a Java extension to transform a set of name elements into a numbered and alphabetized
list.
Run this sample from the extensions subdirectory with
java org.apache.xalan.xslt.Process -in numlist.xml
-xsl 4-numlistJava.xsl
|
| |
What it does: Uses a JavaScript extension to transform a set of name elements into a numbered and
alphabetized list. This sample performs the same operations as the preceding Java extension.
 | js.jar must be on the classpath. |
Run this sample from the extensions subdirectory with
java org.apache.xalan.xslt.Process -in numlist.xml
-xsl 5-numlistJscript.xsl
|
|
| |
The SQL library extension enables you to execute SQL queries from within a stylesheet,
and to incorporate query result sets in the XML output. To use the SQL library, you need
a JDBC driver, the underlying DBMS, and a database. Our samples use Lutris® InstantDB.
You can also customize the stylesheets for your own database implementations.
| |
 | Except for 6-sqllib-instantdb, all these samples have been created by John Gentilin
(johnglinux@eyecatching.com) to illustrate the rich feature set he has contributed to the SQL Library.
To run each of these samples, be sure you are in the appropriate extensions/sql subdirectory. |
|
| |
What it does: Uses the SQL library XConnection extension to connect to the InstantDB sample database,
performs a query, and returns the query result in an HTML table.
Set up the database, and run this sample from the extensions subdirectory:
java org.apache.xalan.xslt.Process
-xsl 6-sqllib-instantdb.xsl -out import1.html
|
| |
Contributed by John Gentilin (johnglinux@eyecatching.com).
What it does: illustrates two strategies for connecting to a database, executing a static query, and returning
the query result.
The first strategy is to get connection information along with the static query from the stylesheet (dbtest.xsl)\
in the form of stylesheet parameters.
The second strategy is to get connection information from a nodeset in an XML source document (dbInfo.xml).
Set up the database, and run this sample from the extensions/sql/basic-connection
directory.
1. To get connection information from the stylesheet:
java org.apache.xalan.xslt.Process
-xsl dbtest.xsl -out import1.html
2. To get connection information in the form of a nodeset from the XML source document:
java org.apache.xalan.xslt.Process
-in dbinfo.xml -xsl dbtest-cinfo.xsl
-out import1.html
3. To get connection information from the stylesheet and dump the raw result set to an XML file:
java org.apache.xalan.xslt.Process
-xsl DumpSQL.xsl -out import1.xml
|
| |
Contributed by John Gentilin (johnglinux@eyecatching.com).
What it does: The ExternalConnection classes uses the default implementation of the ConnectionPool interface
to create a pool of connections. A stylesheet in turn uses a connection from this pool to instantiate an
XConnection object and connect to a datasouce.
The stylesheet uses this named connection pool to instantiate an XConnection object and connect to the datasource.
The ExternalConnection class is in xalansamples.jar.
Set up the database, be sure xalanxamples.jar is on the class path, and run this
sample from the extensions/sql/ext-connection directory:
java ExternalConnection
ExternalConnection creates the ConnectionPool, and performs a transformation with dbtest.xsl, which draws
from the pool to instantiate an XConnection object, connect to the datasource, execute a static query, and return the
query result.
|
| |
Contributed by John Gentilin (johnglinux@eyecatching.com).
What it does: connect to a datasource, execute a parameterized query, and return the result. The XML source document
provides the parameter value as well as the connection information. The parameter value is in a node in the XML source.
The stylesheet gets the required connection and parameter information from the XML source, sets up and executes the
parameterized query, and retuns the query result set.
Set up the database, and run this sample from the sql/pquery subdirectory:
java org.apache.xalan.xslt.Process -in dbInfo.xml
-xsl dbTest.xsl -out dbTest.html
|
| |
Contributed by John Gentilin (johnglinux@eyecatching.com).
What it does: Illustrates enabling and disabling of caching the streamable result set returned by a query.
The stylesheets use the XConnection enableCacheNodes() and disableCacheNodes() methods.
Set up the database, and run these samples from the sql/streamable subdirectory.
1. To turn caching on:
java org.apache.xalan.xslt.Process
-xsl cachedNodes.xsl
1. To turn caching off:
java org.apache.xalan.xslt.Process
-xsl streamNodes.xsl
3. To be added
|
|
| |
What it does: Trace uses the TraceListener and TraceManager classes to log transformation events.
Run this sample from the Trace subdirectory with
java Trace
and examine the result in events.log. For more information, see Debugger
Interface
|
| |
| |
What it does: Uses SAXParserFactory to turn on validation, and
XMLReader to parse the XML input and report errors and warnings to a SAX event
handler. The XML input (birds.xml) contains an internal DOCTYPE declaration, and a few minor document type violations, which you are
invited to fix, add to, and vary in any way you find useful.
Run this sample from the Validate subdirectory with
java ValidateXMLInput
|
| |
What it does: Uses the JAXP SAXParser with a SAX event handler
(extends DefaultHandler and implements
LexicalHandler) to verify that XML files conform to their declared
document type. You can use this utility to verify that an individual file or all the .xml files in a directory are
well-formed and valid. Each .xml file should contain a DOCTYPE declaration.
Run this sample from any directory with
java Validate file-or-dir-name [logfile ]
where file-or-dir-name is an XML file or directory pathname, and logfile designates a log.
If you omit the second argument, Validate reports its findings to the screen.
 | A limitation: Files containing document parts appear to fail if you check them with Validate. Check readme.xml,
which "includes" by entity reference a number of files, and it passes. The parse operation scans the entire document
with the includes. Check an "included" file (such as history.xml) as if it were an independent document and it fails. |
|
|
| |
What it does: run a number of samples illustrating uses of the TRaX (Transformation API for XML) interfaces.
Run this sample from the trax subdirectory with
java Examples
and examine the source in Examples.java and ExampleContentHandler.java.
|
| |
You can use the TrAX/JAXP 1.1 interfaces to compile and run translets. For this release, you must still
use StreamSource objects for the XSL stylesheet and XML input document, and a StreamResult object for the
transformation output. For an overview of the usage patterns these samples illustrate, see
Calling XSLTC with the TrAX/JAXP API.
Important: To run these samples, you must compile the sample class files and adjust the
system classpath.
- To compile the samples, you can run the Ant build from the root directory as follows:
build xsltc.samples
- Add xsltc.jar, runtime.jar, BCEL.jar, java_cup.jar, and the samples/translets subdirectory to
the classpath
 | The JAR files listed above are in the bin directory.
The samples/translets directory contains the sample class files as well as the translet class file that is
generated at tun time (todo.class from the todo.xsl stylesheet). |
| |
Other XSLTC samples are located in the following samples subdirectories:
- CompiledServlet
- CompiledBrazil
- CompiledJAXP
- CompiledApplet
- CompiledEJB
For information about each of these samples, consult the README file in the subdirectory.
 | The following paragraphs supply some basic background information for CompiledServlet and CompiledBrazil. |
XSLTC provides demos for using XSLTC as a servlet and as a handler for
Brazil (a new and powerful Web techology from Sun labs). To run these demos,
download Brazil from sunlabs:
http://research.sun.com/research/download/index.html
and the java extensions for servlets from Sun:
http://java.sun.com/products/servlet/download.html
The translet must be specified as a pure class name, accessible
through the Brazil handler classpath. For example:
translet=mk054
The document must be specified as a valid URL. For example:
document=http://server/path/to/filename.xml
If the file is local to the Brazil handler, it has to be
specified using the "file:filename.xml" format.
 | You also need to make the Brazil and javax classes available from your classpath |
|
|
|
|