File: package-summary.html

package info (click to toggle)
libxt-java 0.20051206-1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 10,856 kB
  • ctags: 6,247
  • sloc: java: 22,326; xml: 3,166; sh: 19; makefile: 11
file content (343 lines) | stat: -rw-r--r-- 16,087 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.4.2_06) on Tue Dec 06 14:30:43 PST 2005 -->
<TITLE>
com.jclark.xsl.sax (XT 20051206 API)
</TITLE>

<META NAME="keywords" CONTENT="com.jclark.xsl.sax package">

<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">

<SCRIPT type="text/javascript">
function windowTitle()
{
    parent.document.title="com.jclark.xsl.sax (XT 20051206 API)";
}
</SCRIPT>

</HEAD>

<BODY BGCOLOR="white" onload="windowTitle();">


<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../com/jclark/xsl/om/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
&nbsp;<A HREF="../../../../com/jclark/xsl/sax2/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>

</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->

<HR>
<H2>
Package com.jclark.xsl.sax
</H2>
The SAX (version 1) API for XT

      This package provides APIs for invoking XT with
        SAX 1 parsers providing input stylesheets and source
        document
      This version of XT continues the public interface of earlier
        versions.  
<P>
<B>See:</B>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#package_description"><B>Description</B></A>
<P>

<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Interface Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/jclark/xsl/sax/CommentHandler.html" title="interface in com.jclark.xsl.sax">CommentHandler</A></B></TD>
<TD>receives comment events from a parse</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/jclark/xsl/sax/Destination.html" title="interface in com.jclark.xsl.sax">Destination</A></B></TD>
<TD>represents the output destination for an XML document</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/jclark/xsl/sax/OutputDocumentHandler.html" title="interface in com.jclark.xsl.sax">OutputDocumentHandler</A></B></TD>
<TD>A SAX 1 DocumentHandler that serializes the results of a transform
 to a Destination, in a manner influenced by the "xsl:output" element</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/jclark/xsl/sax/OutputMethodHandler.html" title="interface in com.jclark.xsl.sax">OutputMethodHandler</A></B></TD>
<TD>constructs a DocumentHandler appropriate for a 
 given output method (which typically is determined 
  by the stylesheet) and destination (which is determined externally)</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/jclark/xsl/sax/RawCharactersHandler.html" title="interface in com.jclark.xsl.sax">RawCharactersHandler</A></B></TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/jclark/xsl/sax/ResultTreeFragment.html" title="interface in com.jclark.xsl.sax">ResultTreeFragment</A></B></TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/jclark/xsl/sax/SaxFilterMaker.html" title="interface in com.jclark.xsl.sax">SaxFilterMaker</A></B></TD>
<TD>an object which is able to provide a SAX2 XMLFilter
 We use these for some experimental XSLT extension elements</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/jclark/xsl/sax/XMLProcessorEx.html" title="interface in com.jclark.xsl.sax">XMLProcessorEx</A></B></TD>
<TD>extended public interface for an XMLProcessor, which loads an XML
  source into our own  DOM-like structure</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/jclark/xsl/sax/XSLProcessor.html" title="interface in com.jclark.xsl.sax">XSLProcessor</A></B></TD>
<TD>typical usage:
   
    // find an implementation, and construct it
    XSLProcessor xsl = new XSLProcessorImpl();
    xsl.setParser(sourceParser, styleParser);
    xsl.loadStylesheet(someInputSource);

    // maybe clone for re-use ...

    // maybe set some parameters ...

    // attach an output handler
    xsl.setDocumentHandler(someHandler);
    xsl.parse(someOtherInputSource);
   
  </TD>
</TR>
</TABLE>
&nbsp;

<P>

<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Class Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/jclark/xsl/sax/Driver.html" title="class in com.jclark.xsl.sax">Driver</A></B></TD>
<TD>A Command line driver program for XSLProcessor</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/jclark/xsl/sax/EncodingName.html" title="class in com.jclark.xsl.sax">EncodingName</A></B></TD>
<TD>maps between Java and IANA character encoding names</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/jclark/xsl/sax/ExtensionHandlerImpl.html" title="class in com.jclark.xsl.sax">ExtensionHandlerImpl</A></B></TD>
<TD>for invoking XSLT extension functions (??)</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/jclark/xsl/sax/FileDescriptorDestination.html" title="class in com.jclark.xsl.sax">FileDescriptorDestination</A></B></TD>
<TD>e.g stdout</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/jclark/xsl/sax/FileDestination.html" title="class in com.jclark.xsl.sax">FileDestination</A></B></TD>
<TD>Represents a file to which we can write the results of
 a transformation</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/jclark/xsl/sax/GenericDestination.html" title="class in com.jclark.xsl.sax">GenericDestination</A></B></TD>
<TD>A base class for output Destinations, providing some common
 default behaviors</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/jclark/xsl/sax/HTMLOutputHandler.html" title="class in com.jclark.xsl.sax">HTMLOutputHandler</A></B></TD>
<TD>A OutputDocumentHandler that writes an HTML representation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/jclark/xsl/sax/Indenter.html" title="class in com.jclark.xsl.sax">Indenter</A></B></TD>
<TD>performs "pretty-printing" by wrapping  another 
 OutputDocumentHandler, intercepting SAX events,
 and inserting whitespace events as appropriate.
 ... </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/jclark/xsl/sax/MultiNamespaceResult.html" title="class in com.jclark.xsl.sax">MultiNamespaceResult</A></B></TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/jclark/xsl/sax/NXMLOutputHandler.html" title="class in com.jclark.xsl.sax">NXMLOutputHandler</A></B></TD>
<TD>an output handler that handles our special technique
 for non XML characters</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/jclark/xsl/sax/OutputMethodHandlerImpl.html" title="class in com.jclark.xsl.sax">OutputMethodHandlerImpl</A></B></TD>
<TD>produces a DocumentHandler suitable for a given output method
 i.e text, XML, etc  and destination</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/jclark/xsl/sax/OutputStreamDestination.html" title="class in com.jclark.xsl.sax">OutputStreamDestination</A></B></TD>
<TD>A Destination on an already opened OutputStream</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/jclark/xsl/sax/ResultBase.html" title="class in com.jclark.xsl.sax">ResultBase</A></B></TD>
<TD>abstract base class represents the results of executing a stylesheet Action --
 constructs result components.
  </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/jclark/xsl/sax/ServletDestination.html" title="class in com.jclark.xsl.sax">ServletDestination</A></B></TD>
<TD>provides and initializes an output stream to (through)
 a ServletResponse</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/jclark/xsl/sax/TextOutputHandler.html" title="class in com.jclark.xsl.sax">TextOutputHandler</A></B></TD>
<TD>An object which serailizes SAX 1 events to raw text</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/jclark/xsl/sax/XMLOutputHandler.html" title="class in com.jclark.xsl.sax">XMLOutputHandler</A></B></TD>
<TD>A DocumentHandler that writes an XML representation to
 an OutputStream.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/jclark/xsl/sax/XMLProcessorImpl.html" title="class in com.jclark.xsl.sax">XMLProcessorImpl</A></B></TD>
<TD>parses a source doc or stylesheet into our own DOM like structure</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/jclark/xsl/sax/XSLProcessorImpl.html" title="class in com.jclark.xsl.sax">XSLProcessorImpl</A></B></TD>
<TD>An XSLT Processor</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/jclark/xsl/sax/XSLServlet.html" title="class in com.jclark.xsl.sax">XSLServlet</A></B></TD>
<TD>an example servlet which compiles and caches a stylesheet,
 then with each "GET" transforms the requested file</TD>
</TR>
</TABLE>
&nbsp;

<P>
<A NAME="package_description"><!-- --></A><H2>
Package com.jclark.xsl.sax Description
</H2>

<P>
The SAX (version 1) API for XT

      <p>This package provides APIs for invoking XT with
        SAX 1 parsers providing input stylesheets and source
        document</p>
      <p>This version of XT continues the public interface of earlier
        versions.  This interface is defined in
        <code>com.jclark.xsl.sax.XSLProcessor</code> which is implemented by
        <code>com.jclark.xsl.sax.XSLProcessorImpl</code>.  This interface is
        based on SAX 1.</p>

      <p>There is also a simple API based purely on the
        DOM in the package <code>com.jclark.xsl.dom</code></p>

      <p>A demonstration is provided of XT used in a servlet. This requires a 
        servlet engine that
        implements at least version 2.1 of the Java Servlet API. The servlet
        class is <code>com.jclark.xsl.sax.XSLServlet</code>.  The servlet
        requires an init parameter <code>stylesheet</code>; the value is the
        path of the stylesheet in a form suitable to be passed to
        <code>ServletContext.getResource</code>.  The translated path gives
        the XML document to be transformed.  An extension of <code>.xml</code>
        will be automatically added to the translated path if necessary.
        (Some browsers assume that a URL ending in <code>.xml</code> is an XML
        document.)  Parameters from the query part of the URL are passed in as
        parameters to the stylesheet.  The stylesheet is cached on
        initialization.</p>
<P>

<P>
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../com/jclark/xsl/om/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
&nbsp;<A HREF="../../../../com/jclark/xsl/sax2/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>

</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>

</BODY>
</HTML>