source: release-kits/lirk3/resources/gs3-release-maker/ant/docs/manual/api/org/apache/tools/ant/types/XMLCatalog.html@ 14982

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago

initial import of LiRK3
File size: 34.7 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.4.2_13) on Mon Oct 01 14:33:32 NZST 2007 -->
6<TITLE>
7XMLCatalog (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.types.XMLCatalog class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="XMLCatalog (Apache Ant API)";
18}
19</SCRIPT>
20
21</HEAD>
22
23<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26<!-- ========= START OF TOP NAVBAR ======= -->
27<A NAME="navbar_top"><!-- --></A>
28<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30<TR>
31<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32<A NAME="navbar_top_firstrow"><!-- --></A>
33<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
42 </TR>
43</TABLE>
44</TD>
45<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46</EM>
47</TD>
48</TR>
49
50<TR>
51<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Substitution.html" title="class in org.apache.tools.ant.types"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/ZipFileSet.html" title="class in org.apache.tools.ant.types"><B>NEXT CLASS</B></A></FONT></TD>
54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
56&nbsp;<A HREF="XMLCatalog.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
57&nbsp;<SCRIPT type="text/javascript">
58 <!--
59 if(window==top) {
60 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61 }
62 //-->
63</SCRIPT>
64<NOSCRIPT>
65 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
66</NOSCRIPT>
67
68</FONT></TD>
69</TR>
70<TR>
71<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
75</TR>
76</TABLE>
77<A NAME="skip-navbar_top"></A>
78<!-- ========= END OF TOP NAVBAR ========= -->
79
80<HR>
81<!-- ======== START OF CLASS DATA ======== -->
82<H2>
83<FONT SIZE="-1">
84org.apache.tools.ant.types</FONT>
85<BR>
86Class XMLCatalog</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">org.apache.tools.ant.ProjectComponent</A>
90 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../org/apache/tools/ant/types/DataType.html" title="class in org.apache.tools.ant.types">org.apache.tools.ant.types.DataType</A>
91 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.types.XMLCatalog</B>
92</PRE>
93<DL>
94<DT><B>All Implemented Interfaces:</B> <DD>java.lang.Cloneable, org.xml.sax.EntityResolver, javax.xml.transform.URIResolver</DD>
95</DL>
96<HR>
97<DL>
98<DT>public class <B>XMLCatalog</B><DT>extends <A HREF="../../../../../org/apache/tools/ant/types/DataType.html" title="class in org.apache.tools.ant.types">DataType</A><DT>implements java.lang.Cloneable, org.xml.sax.EntityResolver, javax.xml.transform.URIResolver</DL>
99
100<P>
101<p>This data type provides a catalog of resource locations (such as
102 DTDs and XML entities), based on the <a
103 href="http://oasis-open.org/committees/entity/spec-2001-08-06.html">
104 OASIS "Open Catalog" standard</a>. The catalog entries are used
105 both for Entity resolution and URI resolution, in accordance with
106 the <CODE>EntityResolver</CODE> and <CODE>URIResolver</CODE> interfaces as defined
107 in the <a href="http://java.sun.com/xml/jaxp">Java API for XML
108 Processing Specification</a>.</p>
109
110 <p>Resource locations can be specified either in-line or in
111 external catalog file(s), or both. In order to use an external
112 catalog file, the xml-commons resolver library ("resolver.jar")
113 must be in your classpath. External catalog files may be either <a
114 href="http://oasis-open.org/committees/entity/background/9401.html">
115 plain text format</a> or <a
116 href="http://www.oasis-open.org/committees/entity/spec-2001-08-06.html">
117 XML format</a>. If the xml-commons resolver library is not found
118 in the classpath, external catalog files, specified in
119 <code>&lt;catalogpath&gt;</code> paths, will be ignored and a warning will
120 be logged. In this case, however, processing of inline entries will proceed
121 normally.</p>
122
123 <p>Currently, only <code>&lt;dtd&gt;</code> and
124 <code>&lt;entity&gt;</code> elements may be specified inline; these
125 correspond to OASIS catalog entry types <code>PUBLIC</code> and
126 <code>URI</code> respectively.</p>
127
128 <p>The following is a usage example:</p>
129
130 <code>
131 &lt;xmlcatalog&gt;<br>
132 &nbsp;&nbsp;&lt;dtd publicId="" location="/path/to/file.jar" /&gt;<br>
133 &nbsp;&nbsp;&lt;dtd publicId="" location="/path/to/file2.jar" /&gt;<br>
134 &nbsp;&nbsp;&lt;entity publicId="" location="/path/to/file3.jar" /&gt;<br>
135 &nbsp;&nbsp;&lt;entity publicId="" location="/path/to/file4.jar" /&gt;<br>
136 &nbsp;&nbsp;&lt;catalogpath&gt;<br>
137 &nbsp;&nbsp;&nbsp;&nbsp;&lt;pathelement location="/etc/sgml/catalog"/&gt;<br>
138 &nbsp;&nbsp;&lt;/catalogpath&gt;<br>
139 &nbsp;&nbsp;&lt;catalogfiles dir="/opt/catalogs/" includes="**\catalog.xml" /&gt;<br>
140 &lt;/xmlcatalog&gt;<br>
141 </code>
142 <p>
143 Tasks wishing to use <code>&lt;xmlcatalog&gt;</code> must provide a method called
144 <code>createXMLCatalog</code> which returns an instance of
145 <code>XMLCatalog</code>. Nested DTD and entity definitions are handled by
146 the XMLCatalog object and must be labeled <code>dtd</code> and
147 <code>entity</code> respectively.</p>
148
149 <p>The following is a description of the resolution algorithm:
150 entities/URIs/dtds are looked up in each of the following contexts,
151 stopping when a valid and readable resource is found:
152 <ol>
153 <li>In the local filesystem</li>
154 <li>In the classpath</li>
155 <li>Using the Apache xml-commons resolver (if it is available)</li>
156 <li>In URL-space</li>
157 </ol>
158 </p>
159
160 <p>See <A HREF="../../../../../org/apache/tools/ant/taskdefs/optional/XMLValidateTask.html" title="class in org.apache.tools.ant.taskdefs.optional"><CODE>XMLValidateTask</CODE></A> for an example of a task that has integrated
161 support for XMLCatalogs.</p>
162
163 <p>Possible future extension could provide for additional OASIS
164 entry types to be specified inline.</p>
165<P>
166
167<P>
168<HR>
169
170<P>
171<!-- ======== NESTED CLASS SUMMARY ======== -->
172
173
174<!-- =========== FIELD SUMMARY =========== -->
175
176<A NAME="field_summary"><!-- --></A>
177<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
178<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
179<TD COLSPAN=2><FONT SIZE="+2">
180<B>Field Summary</B></FONT></TD>
181</TR>
182<TR BGCOLOR="white" CLASS="TableRowColor">
183<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
184<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
185<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/XMLCatalog.html#APACHE_RESOLVER">APACHE_RESOLVER</A></B></CODE>
186
187<BR>
188&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The name of the bridge to the Apache xml-commons resolver
189 class, used to determine whether resolver.jar is present in the
190 classpath.</TD>
191</TR>
192<TR BGCOLOR="white" CLASS="TableRowColor">
193<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
194<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
195<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/XMLCatalog.html#CATALOG_RESOLVER">CATALOG_RESOLVER</A></B></CODE>
196
197<BR>
198&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Resolver base class</TD>
199</TR>
200</TABLE>
201&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.types.DataType"><!-- --></A>
202<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
203<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
204<TD><B>Fields inherited from class org.apache.tools.ant.types.<A HREF="../../../../../org/apache/tools/ant/types/DataType.html" title="class in org.apache.tools.ant.types">DataType</A></B></TD>
205</TR>
206<TR BGCOLOR="white" CLASS="TableRowColor">
207<TD><CODE><A HREF="../../../../../org/apache/tools/ant/types/DataType.html#checked">checked</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#description">description</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#ref">ref</A></CODE></TD>
208</TR>
209</TABLE>
210&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
211<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
212<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
213<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
214</TR>
215<TR BGCOLOR="white" CLASS="TableRowColor">
216<TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
217</TR>
218</TABLE>
219&nbsp;
220<!-- ======== CONSTRUCTOR SUMMARY ======== -->
221
222<A NAME="constructor_summary"><!-- --></A>
223<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
224<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
225<TD COLSPAN=2><FONT SIZE="+2">
226<B>Constructor Summary</B></FONT></TD>
227</TR>
228<TR BGCOLOR="white" CLASS="TableRowColor">
229<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/XMLCatalog.html#XMLCatalog()">XMLCatalog</A></B>()</CODE>
230
231<BR>
232&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default constructor</TD>
233</TR>
234</TABLE>
235&nbsp;
236<!-- ========== METHOD SUMMARY =========== -->
237
238<A NAME="method_summary"><!-- --></A>
239<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
240<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
241<TD COLSPAN=2><FONT SIZE="+2">
242<B>Method Summary</B></FONT></TD>
243</TR>
244<TR BGCOLOR="white" CLASS="TableRowColor">
245<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
246<CODE>&nbsp;void</CODE></FONT></TD>
247<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/XMLCatalog.html#addConfiguredXMLCatalog(org.apache.tools.ant.types.XMLCatalog)">addConfiguredXMLCatalog</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/XMLCatalog.html" title="class in org.apache.tools.ant.types">XMLCatalog</A>&nbsp;catalog)</CODE>
248
249<BR>
250&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Loads a nested <code>&lt;xmlcatalog&gt;</code> into our
251 definition.</TD>
252</TR>
253<TR BGCOLOR="white" CLASS="TableRowColor">
254<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
255<CODE>&nbsp;void</CODE></FONT></TD>
256<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/XMLCatalog.html#addDTD(org.apache.tools.ant.types.ResourceLocation)">addDTD</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/ResourceLocation.html" title="class in org.apache.tools.ant.types">ResourceLocation</A>&nbsp;dtd)</CODE>
257
258<BR>
259&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates the nested <code>&lt;dtd&gt;</code> element.</TD>
260</TR>
261<TR BGCOLOR="white" CLASS="TableRowColor">
262<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
263<CODE>&nbsp;void</CODE></FONT></TD>
264<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/XMLCatalog.html#addEntity(org.apache.tools.ant.types.ResourceLocation)">addEntity</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/ResourceLocation.html" title="class in org.apache.tools.ant.types">ResourceLocation</A>&nbsp;entity)</CODE>
265
266<BR>
267&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates the nested <code>&lt;entity&gt;</code> element.</TD>
268</TR>
269<TR BGCOLOR="white" CLASS="TableRowColor">
270<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
271<CODE>&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A></CODE></FONT></TD>
272<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/XMLCatalog.html#createCatalogPath()">createCatalogPath</A></B>()</CODE>
273
274<BR>
275&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a nested <code>&lt;catalogpath&gt;</code> element.</TD>
276</TR>
277<TR BGCOLOR="white" CLASS="TableRowColor">
278<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
279<CODE>&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A></CODE></FONT></TD>
280<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/XMLCatalog.html#createClasspath()">createClasspath</A></B>()</CODE>
281
282<BR>
283&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Allows nested classpath elements.</TD>
284</TR>
285<TR BGCOLOR="white" CLASS="TableRowColor">
286<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
287<CODE>&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A></CODE></FONT></TD>
288<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/XMLCatalog.html#getCatalogPath()">getCatalogPath</A></B>()</CODE>
289
290<BR>
291&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the catalog path in which to attempt to resolve DTDs.</TD>
292</TR>
293<TR BGCOLOR="white" CLASS="TableRowColor">
294<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
295<CODE>&nbsp;javax.xml.transform.Source</CODE></FONT></TD>
296<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/XMLCatalog.html#resolve(java.lang.String, java.lang.String)">resolve</A></B>(java.lang.String&nbsp;href,
297 java.lang.String&nbsp;base)</CODE>
298
299<BR>
300&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Implements the URIResolver.resolve() interface method.</TD>
301</TR>
302<TR BGCOLOR="white" CLASS="TableRowColor">
303<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
304<CODE>&nbsp;org.xml.sax.InputSource</CODE></FONT></TD>
305<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/XMLCatalog.html#resolveEntity(java.lang.String, java.lang.String)">resolveEntity</A></B>(java.lang.String&nbsp;publicId,
306 java.lang.String&nbsp;systemId)</CODE>
307
308<BR>
309&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Implements the EntityResolver.resolveEntity() interface method.</TD>
310</TR>
311<TR BGCOLOR="white" CLASS="TableRowColor">
312<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
313<CODE>&nbsp;void</CODE></FONT></TD>
314<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/XMLCatalog.html#setCatalogPathRef(org.apache.tools.ant.types.Reference)">setCatalogPathRef</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A>&nbsp;r)</CODE>
315
316<BR>
317&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Allows catalogpath reference.</TD>
318</TR>
319<TR BGCOLOR="white" CLASS="TableRowColor">
320<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
321<CODE>&nbsp;void</CODE></FONT></TD>
322<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/XMLCatalog.html#setClasspath(org.apache.tools.ant.types.Path)">setClasspath</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A>&nbsp;classpath)</CODE>
323
324<BR>
325&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Allows simple classpath string.</TD>
326</TR>
327<TR BGCOLOR="white" CLASS="TableRowColor">
328<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
329<CODE>&nbsp;void</CODE></FONT></TD>
330<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/XMLCatalog.html#setClasspathRef(org.apache.tools.ant.types.Reference)">setClasspathRef</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A>&nbsp;r)</CODE>
331
332<BR>
333&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Allows classpath reference.</TD>
334</TR>
335<TR BGCOLOR="white" CLASS="TableRowColor">
336<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
337<CODE>&nbsp;void</CODE></FONT></TD>
338<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/XMLCatalog.html#setRefid(org.apache.tools.ant.types.Reference)">setRefid</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A>&nbsp;r)</CODE>
339
340<BR>
341&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Makes this instance in effect a reference to another XMLCatalog
342 instance.</TD>
343</TR>
344</TABLE>
345&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.types.DataType"><!-- --></A>
346<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
347<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
348<TD><B>Methods inherited from class org.apache.tools.ant.types.<A HREF="../../../../../org/apache/tools/ant/types/DataType.html" title="class in org.apache.tools.ant.types">DataType</A></B></TD>
349</TR>
350<TR BGCOLOR="white" CLASS="TableRowColor">
351<TD><CODE><A HREF="../../../../../org/apache/tools/ant/types/DataType.html#checkAttributesAllowed()">checkAttributesAllowed</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#checkChildrenAllowed()">checkChildrenAllowed</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#circularReference()">circularReference</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#dieOnCircularReference(java.util.Stack, org.apache.tools.ant.Project)">dieOnCircularReference</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#getCheckedRef(java.lang.Class, java.lang.String)">getCheckedRef</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#getDescription()">getDescription</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#getRefid()">getRefid</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#isChecked()">isChecked</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#isReference()">isReference</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#noChildrenAllowed()">noChildrenAllowed</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#setChecked(boolean)">setChecked</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#setDescription(java.lang.String)">setDescription</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#tooManyAttributes()">tooManyAttributes</A></CODE></TD>
352</TR>
353</TABLE>
354&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
355<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
356<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
357<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
358</TR>
359<TR BGCOLOR="white" CLASS="TableRowColor">
360<TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</A>, <A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#log(java.lang.String)">log</A>, <A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#log(java.lang.String, int)">log</A>, <A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#setProject(org.apache.tools.ant.Project)">setProject</A></CODE></TD>
361</TR>
362</TABLE>
363&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
364<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
365<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
366<TD><B>Methods inherited from class java.lang.Object</B></TD>
367</TR>
368<TR BGCOLOR="white" CLASS="TableRowColor">
369<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
370</TR>
371</TABLE>
372&nbsp;
373<P>
374
375<!-- ============ FIELD DETAIL =========== -->
376
377<A NAME="field_detail"><!-- --></A>
378<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
379<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
380<TD COLSPAN=1><FONT SIZE="+2">
381<B>Field Detail</B></FONT></TD>
382</TR>
383</TABLE>
384
385<A NAME="APACHE_RESOLVER"><!-- --></A><H3>
386APACHE_RESOLVER</H3>
387<PRE>
388public static final java.lang.String <B>APACHE_RESOLVER</B></PRE>
389<DL>
390<DD>The name of the bridge to the Apache xml-commons resolver
391 class, used to determine whether resolver.jar is present in the
392 classpath.
393<P>
394<DL>
395<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.tools.ant.types.XMLCatalog.APACHE_RESOLVER">Constant Field Values</A></DL>
396</DL>
397<HR>
398
399<A NAME="CATALOG_RESOLVER"><!-- --></A><H3>
400CATALOG_RESOLVER</H3>
401<PRE>
402public static final java.lang.String <B>CATALOG_RESOLVER</B></PRE>
403<DL>
404<DD>Resolver base class
405<P>
406<DL>
407<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.tools.ant.types.XMLCatalog.CATALOG_RESOLVER">Constant Field Values</A></DL>
408</DL>
409
410<!-- ========= CONSTRUCTOR DETAIL ======== -->
411
412<A NAME="constructor_detail"><!-- --></A>
413<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
414<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
415<TD COLSPAN=1><FONT SIZE="+2">
416<B>Constructor Detail</B></FONT></TD>
417</TR>
418</TABLE>
419
420<A NAME="XMLCatalog()"><!-- --></A><H3>
421XMLCatalog</H3>
422<PRE>
423public <B>XMLCatalog</B>()</PRE>
424<DL>
425<DD>Default constructor
426<P>
427</DL>
428
429<!-- ============ METHOD DETAIL ========== -->
430
431<A NAME="method_detail"><!-- --></A>
432<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
433<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
434<TD COLSPAN=1><FONT SIZE="+2">
435<B>Method Detail</B></FONT></TD>
436</TR>
437</TABLE>
438
439<A NAME="createClasspath()"><!-- --></A><H3>
440createClasspath</H3>
441<PRE>
442public <A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> <B>createClasspath</B>()</PRE>
443<DL>
444<DD>Allows nested classpath elements. Not allowed if this catalog
445 is itself a reference to another catalog -- that is, a catalog
446 cannot both refer to another <em>and</em> contain elements or
447 other attributes.
448<P>
449<DD><DL>
450</DL>
451</DD>
452<DD><DL>
453
454<DT><B>Returns:</B><DD>a Path instance to be configured.</DL>
455</DD>
456</DL>
457<HR>
458
459<A NAME="setClasspath(org.apache.tools.ant.types.Path)"><!-- --></A><H3>
460setClasspath</H3>
461<PRE>
462public void <B>setClasspath</B>(<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A>&nbsp;classpath)</PRE>
463<DL>
464<DD>Allows simple classpath string. Not allowed if this catalog is
465 itself a reference to another catalog -- that is, a catalog
466 cannot both refer to another <em>and</em> contain elements or
467 other attributes.
468<P>
469<DD><DL>
470</DL>
471</DD>
472<DD><DL>
473<DT><B>Parameters:</B><DD><CODE>classpath</CODE> - the classpath to use to look up entities.</DL>
474</DD>
475</DL>
476<HR>
477
478<A NAME="setClasspathRef(org.apache.tools.ant.types.Reference)"><!-- --></A><H3>
479setClasspathRef</H3>
480<PRE>
481public void <B>setClasspathRef</B>(<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A>&nbsp;r)</PRE>
482<DL>
483<DD>Allows classpath reference. Not allowed if this catalog is
484 itself a reference to another catalog -- that is, a catalog
485 cannot both refer to another <em>and</em> contain elements or
486 other attributes.
487<P>
488<DD><DL>
489</DL>
490</DD>
491<DD><DL>
492<DT><B>Parameters:</B><DD><CODE>r</CODE> - an Ant reference containing a classpath.</DL>
493</DD>
494</DL>
495<HR>
496
497<A NAME="createCatalogPath()"><!-- --></A><H3>
498createCatalogPath</H3>
499<PRE>
500public <A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> <B>createCatalogPath</B>()</PRE>
501<DL>
502<DD>Creates a nested <code>&lt;catalogpath&gt;</code> element.
503 Not allowed if this catalog is itself a reference to another
504 catalog -- that is, a catalog cannot both refer to another
505 <em>and</em> contain elements or other attributes.
506<P>
507<DD><DL>
508</DL>
509</DD>
510<DD><DL>
511
512<DT><B>Returns:</B><DD>a path to be configured as the catalog path.
513<DT><B>Throws:</B>
514<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if this is a reference and no nested elements are allowed.</DL>
515</DD>
516</DL>
517<HR>
518
519<A NAME="setCatalogPathRef(org.apache.tools.ant.types.Reference)"><!-- --></A><H3>
520setCatalogPathRef</H3>
521<PRE>
522public void <B>setCatalogPathRef</B>(<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A>&nbsp;r)</PRE>
523<DL>
524<DD>Allows catalogpath reference. Not allowed if this catalog is
525 itself a reference to another catalog -- that is, a catalog
526 cannot both refer to another <em>and</em> contain elements or
527 other attributes.
528<P>
529<DD><DL>
530</DL>
531</DD>
532<DD><DL>
533<DT><B>Parameters:</B><DD><CODE>r</CODE> - an Ant reference containing a classpath to be used as
534 the catalog path.</DL>
535</DD>
536</DL>
537<HR>
538
539<A NAME="getCatalogPath()"><!-- --></A><H3>
540getCatalogPath</H3>
541<PRE>
542public <A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> <B>getCatalogPath</B>()</PRE>
543<DL>
544<DD>Returns the catalog path in which to attempt to resolve DTDs.
545<P>
546<DD><DL>
547</DL>
548</DD>
549<DD><DL>
550
551<DT><B>Returns:</B><DD>the catalog path</DL>
552</DD>
553</DL>
554<HR>
555
556<A NAME="addDTD(org.apache.tools.ant.types.ResourceLocation)"><!-- --></A><H3>
557addDTD</H3>
558<PRE>
559public void <B>addDTD</B>(<A HREF="../../../../../org/apache/tools/ant/types/ResourceLocation.html" title="class in org.apache.tools.ant.types">ResourceLocation</A>&nbsp;dtd)
560 throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
561<DL>
562<DD>Creates the nested <code>&lt;dtd&gt;</code> element. Not
563 allowed if this catalog is itself a reference to another
564 catalog -- that is, a catalog cannot both refer to another
565 <em>and</em> contain elements or other attributes.
566<P>
567<DD><DL>
568</DL>
569</DD>
570<DD><DL>
571<DT><B>Parameters:</B><DD><CODE>dtd</CODE> - the information about the PUBLIC resource mapping to
572 be added to the catalog
573<DT><B>Throws:</B>
574<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if this is a reference and no nested
575 elements are allowed.</DL>
576</DD>
577</DL>
578<HR>
579
580<A NAME="addEntity(org.apache.tools.ant.types.ResourceLocation)"><!-- --></A><H3>
581addEntity</H3>
582<PRE>
583public void <B>addEntity</B>(<A HREF="../../../../../org/apache/tools/ant/types/ResourceLocation.html" title="class in org.apache.tools.ant.types">ResourceLocation</A>&nbsp;entity)
584 throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
585<DL>
586<DD>Creates the nested <code>&lt;entity&gt;</code> element. Not
587 allowed if this catalog is itself a reference to another
588 catalog -- that is, a catalog cannot both refer to another
589 <em>and</em> contain elements or other attributes.
590<P>
591<DD><DL>
592</DL>
593</DD>
594<DD><DL>
595<DT><B>Parameters:</B><DD><CODE>entity</CODE> - the information about the URI resource mapping to be
596 added to the catalog.
597<DT><B>Throws:</B>
598<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if this is a reference and no nested
599 elements are allowed.</DL>
600</DD>
601</DL>
602<HR>
603
604<A NAME="addConfiguredXMLCatalog(org.apache.tools.ant.types.XMLCatalog)"><!-- --></A><H3>
605addConfiguredXMLCatalog</H3>
606<PRE>
607public void <B>addConfiguredXMLCatalog</B>(<A HREF="../../../../../org/apache/tools/ant/types/XMLCatalog.html" title="class in org.apache.tools.ant.types">XMLCatalog</A>&nbsp;catalog)</PRE>
608<DL>
609<DD>Loads a nested <code>&lt;xmlcatalog&gt;</code> into our
610 definition. Not allowed if this catalog is itself a reference
611 to another catalog -- that is, a catalog cannot both refer to
612 another <em>and</em> contain elements or other attributes.
613<P>
614<DD><DL>
615</DL>
616</DD>
617<DD><DL>
618<DT><B>Parameters:</B><DD><CODE>catalog</CODE> - Nested XMLCatalog</DL>
619</DD>
620</DL>
621<HR>
622
623<A NAME="setRefid(org.apache.tools.ant.types.Reference)"><!-- --></A><H3>
624setRefid</H3>
625<PRE>
626public void <B>setRefid</B>(<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A>&nbsp;r)
627 throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
628<DL>
629<DD>Makes this instance in effect a reference to another XMLCatalog
630 instance.
631
632 <p>You must not set another attribute or nest elements inside
633 this element if you make it a reference. That is, a catalog
634 cannot both refer to another <em>and</em> contain elements or
635 attributes.</p>
636<P>
637<DD><DL>
638<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/tools/ant/types/DataType.html#setRefid(org.apache.tools.ant.types.Reference)">setRefid</A></CODE> in class <CODE><A HREF="../../../../../org/apache/tools/ant/types/DataType.html" title="class in org.apache.tools.ant.types">DataType</A></CODE></DL>
639</DD>
640<DD><DL>
641<DT><B>Parameters:</B><DD><CODE>r</CODE> - the reference to which this catalog instance is associated
642<DT><B>Throws:</B>
643<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if this instance already has been configured.</DL>
644</DD>
645</DL>
646<HR>
647
648<A NAME="resolveEntity(java.lang.String, java.lang.String)"><!-- --></A><H3>
649resolveEntity</H3>
650<PRE>
651public org.xml.sax.InputSource <B>resolveEntity</B>(java.lang.String&nbsp;publicId,
652 java.lang.String&nbsp;systemId)
653 throws org.xml.sax.SAXException,
654 java.io.IOException</PRE>
655<DL>
656<DD>Implements the EntityResolver.resolveEntity() interface method.
657<P>
658<DD><DL>
659<DT><B>Specified by:</B><DD><CODE>resolveEntity</CODE> in interface <CODE>org.xml.sax.EntityResolver</CODE></DL>
660</DD>
661<DD><DL>
662
663<DT><B>Throws:</B>
664<DD><CODE>org.xml.sax.SAXException</CODE>
665<DD><CODE>java.io.IOException</CODE><DT><B>See Also:</B><DD><CODE>EntityResolver.resolveEntity(java.lang.String, java.lang.String)</CODE></DL>
666</DD>
667</DL>
668<HR>
669
670<A NAME="resolve(java.lang.String, java.lang.String)"><!-- --></A><H3>
671resolve</H3>
672<PRE>
673public javax.xml.transform.Source <B>resolve</B>(java.lang.String&nbsp;href,
674 java.lang.String&nbsp;base)
675 throws javax.xml.transform.TransformerException</PRE>
676<DL>
677<DD>Implements the URIResolver.resolve() interface method.
678<P>
679<DD><DL>
680<DT><B>Specified by:</B><DD><CODE>resolve</CODE> in interface <CODE>javax.xml.transform.URIResolver</CODE></DL>
681</DD>
682<DD><DL>
683
684<DT><B>Throws:</B>
685<DD><CODE>javax.xml.transform.TransformerException</CODE><DT><B>See Also:</B><DD><CODE>URIResolver.resolve(java.lang.String, java.lang.String)</CODE></DL>
686</DD>
687</DL>
688<!-- ========= END OF CLASS DATA ========= -->
689<HR>
690
691
692<!-- ======= START OF BOTTOM NAVBAR ====== -->
693<A NAME="navbar_bottom"><!-- --></A>
694<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
695<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
696<TR>
697<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
698<A NAME="navbar_bottom_firstrow"><!-- --></A>
699<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
700 <TR ALIGN="center" VALIGN="top">
701 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
702 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
703 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
704 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
705 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
706 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
707 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
708 </TR>
709</TABLE>
710</TD>
711<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
712</EM>
713</TD>
714</TR>
715
716<TR>
717<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
718&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Substitution.html" title="class in org.apache.tools.ant.types"><B>PREV CLASS</B></A>&nbsp;
719&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/ZipFileSet.html" title="class in org.apache.tools.ant.types"><B>NEXT CLASS</B></A></FONT></TD>
720<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
721 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
722&nbsp;<A HREF="XMLCatalog.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
723&nbsp;<SCRIPT type="text/javascript">
724 <!--
725 if(window==top) {
726 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
727 }
728 //-->
729</SCRIPT>
730<NOSCRIPT>
731 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
732</NOSCRIPT>
733
734</FONT></TD>
735</TR>
736<TR>
737<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
738 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
739<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
740DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
741</TR>
742</TABLE>
743<A NAME="skip-navbar_bottom"></A>
744<!-- ======== END OF BOTTOM NAVBAR ======= -->
745
746<HR>
747Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
748</BODY>
749</HTML>
Note: See TracBrowser for help on using the repository browser.