source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/types/resolver/ApacheCatalogResolver.html@ 14627

Last change on this file since 14627 was 14627, checked in by oranfry, 17 years ago

initial import of the gs3-release-maker
File size: 15.1 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:33 NZST 2007 -->
6<TITLE>
7ApacheCatalogResolver (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.types.resolver.ApacheCatalogResolver 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="ApacheCatalogResolver (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/resolver/ApacheCatalog.html" title="class in org.apache.tools.ant.types.resolver"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;NEXT CLASS</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="ApacheCatalogResolver.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;FIELD&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;FIELD&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.resolver</FONT>
85<BR>
86Class ApacheCatalogResolver</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by">CatalogResolver
90 <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.types.resolver.ApacheCatalogResolver</B>
91</PRE>
92<HR>
93<DL>
94<DT>public class <B>ApacheCatalogResolver</B><DT>extends CatalogResolver</DL>
95
96<P>
97<p>This class extends the CatalogResolver class provided by Norman
98 Walsh's resolver library in xml-commons. It provides the bridge
99 between the Ant XMLCatalog datatype and the xml-commons Catalog
100 class. XMLCatalog calls methods in this class using Reflection in
101 order to avoid requiring the xml-commons resolver library in the
102 path.</p>
103
104 <p>The <A HREF="../../../../../../org/apache/tools/ant/types/resolver/ApacheCatalog.html" title="class in org.apache.tools.ant.types.resolver"><CODE>ApacheCatalog</CODE></A> class is used to parse external catalog files, which
105 can be in either <a
106 href="http://oasis-open.org/committees/entity/background/9401.html">
107 plain text format</a> or <a
108 href="http://www.oasis-open.org/committees/entity/spec-2001-08-06.html">
109 XML format</a>.</p>
110
111 <p>For each entry found in an external catalog file, if any, an
112 instance of <A HREF="../../../../../../org/apache/tools/ant/types/ResourceLocation.html" title="class in org.apache.tools.ant.types"><CODE>ResourceLocation</CODE></A> is created and added to the controlling
113 XMLCatalog datatype. In this way, these entries will be included
114 in XMLCatalog's lookup algorithm. See XMLCatalog.java for more
115 details.</p>
116<P>
117
118<P>
119<DL>
120<DT><B>Since:</B></DT>
121 <DD>Ant 1.6</DD>
122<DT><B>See Also:</B><DD><CODE>XMLCatalog.CatalogResolver</CODE>,
123<CODE>org.apache.xml.resolver.CatalogManager</CODE>,
124<A HREF="../../../../../../serialized-form.html#org.apache.tools.ant.types.resolver.ApacheCatalogResolver">Serialized Form</A></DL>
125<HR>
126
127<P>
128<!-- ======== NESTED CLASS SUMMARY ======== -->
129
130
131<!-- =========== FIELD SUMMARY =========== -->
132
133
134<!-- ======== CONSTRUCTOR SUMMARY ======== -->
135
136<A NAME="constructor_summary"><!-- --></A>
137<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
138<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
139<TD COLSPAN=2><FONT SIZE="+2">
140<B>Constructor Summary</B></FONT></TD>
141</TR>
142<TR BGCOLOR="white" CLASS="TableRowColor">
143<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/resolver/ApacheCatalogResolver.html#ApacheCatalogResolver()">ApacheCatalogResolver</A></B>()</CODE>
144
145<BR>
146&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
147</TR>
148</TABLE>
149&nbsp;
150<!-- ========== METHOD SUMMARY =========== -->
151
152<A NAME="method_summary"><!-- --></A>
153<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
154<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
155<TD COLSPAN=2><FONT SIZE="+2">
156<B>Method Summary</B></FONT></TD>
157</TR>
158<TR BGCOLOR="white" CLASS="TableRowColor">
159<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
160<CODE>&nbsp;void</CODE></FONT></TD>
161<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/resolver/ApacheCatalogResolver.html#addPublicEntry(java.lang.String, java.lang.String, java.net.URL)">addPublicEntry</A></B>(java.lang.String&nbsp;publicid,
162 java.lang.String&nbsp;systemid,
163 java.net.URL&nbsp;base)</CODE>
164
165<BR>
166&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a PUBLIC catalog entry to the controlling XMLCatalog instance.</TD>
167</TR>
168<TR BGCOLOR="white" CLASS="TableRowColor">
169<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
170<CODE>&nbsp;void</CODE></FONT></TD>
171<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/resolver/ApacheCatalogResolver.html#addURIEntry(java.lang.String, java.lang.String, java.net.URL)">addURIEntry</A></B>(java.lang.String&nbsp;uri,
172 java.lang.String&nbsp;altURI,
173 java.net.URL&nbsp;base)</CODE>
174
175<BR>
176&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a URI catalog entry to the controlling XMLCatalog instance.</TD>
177</TR>
178<TR BGCOLOR="white" CLASS="TableRowColor">
179<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
180<CODE>&nbsp;void</CODE></FONT></TD>
181<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/resolver/ApacheCatalogResolver.html#parseCatalog(java.lang.String)">parseCatalog</A></B>(java.lang.String&nbsp;file)</CODE>
182
183<BR>
184&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;XMLCatalog calls this to add an external catalog file for each
185 file within a <code>&lt;catalogfiles&gt;</code> fileset.</TD>
186</TR>
187<TR BGCOLOR="white" CLASS="TableRowColor">
188<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
189<CODE>&nbsp;void</CODE></FONT></TD>
190<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/resolver/ApacheCatalogResolver.html#setXMLCatalog(org.apache.tools.ant.types.XMLCatalog)">setXMLCatalog</A></B>(<A HREF="../../../../../../org/apache/tools/ant/types/XMLCatalog.html" title="class in org.apache.tools.ant.types">XMLCatalog</A>&nbsp;xmlCatalog)</CODE>
191
192<BR>
193&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the XMLCatalog object to callback.</TD>
194</TR>
195</TABLE>
196&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
197<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
198<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
199<TD><B>Methods inherited from class java.lang.Object</B></TD>
200</TR>
201<TR BGCOLOR="white" CLASS="TableRowColor">
202<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
203</TR>
204</TABLE>
205&nbsp;
206<P>
207
208<!-- ============ FIELD DETAIL =========== -->
209
210
211<!-- ========= CONSTRUCTOR DETAIL ======== -->
212
213<A NAME="constructor_detail"><!-- --></A>
214<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
215<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
216<TD COLSPAN=1><FONT SIZE="+2">
217<B>Constructor Detail</B></FONT></TD>
218</TR>
219</TABLE>
220
221<A NAME="ApacheCatalogResolver()"><!-- --></A><H3>
222ApacheCatalogResolver</H3>
223<PRE>
224public <B>ApacheCatalogResolver</B>()</PRE>
225<DL>
226</DL>
227
228<!-- ============ METHOD DETAIL ========== -->
229
230<A NAME="method_detail"><!-- --></A>
231<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
232<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
233<TD COLSPAN=1><FONT SIZE="+2">
234<B>Method Detail</B></FONT></TD>
235</TR>
236</TABLE>
237
238<A NAME="setXMLCatalog(org.apache.tools.ant.types.XMLCatalog)"><!-- --></A><H3>
239setXMLCatalog</H3>
240<PRE>
241public void <B>setXMLCatalog</B>(<A HREF="../../../../../../org/apache/tools/ant/types/XMLCatalog.html" title="class in org.apache.tools.ant.types">XMLCatalog</A>&nbsp;xmlCatalog)</PRE>
242<DL>
243<DD>Set the XMLCatalog object to callback.
244<P>
245<DD><DL>
246</DL>
247</DD>
248</DL>
249<HR>
250
251<A NAME="parseCatalog(java.lang.String)"><!-- --></A><H3>
252parseCatalog</H3>
253<PRE>
254public void <B>parseCatalog</B>(java.lang.String&nbsp;file)</PRE>
255<DL>
256<DD>XMLCatalog calls this to add an external catalog file for each
257 file within a <code>&lt;catalogfiles&gt;</code> fileset.
258<P>
259<DD><DL>
260</DL>
261</DD>
262</DL>
263<HR>
264
265<A NAME="addPublicEntry(java.lang.String, java.lang.String, java.net.URL)"><!-- --></A><H3>
266addPublicEntry</H3>
267<PRE>
268public void <B>addPublicEntry</B>(java.lang.String&nbsp;publicid,
269 java.lang.String&nbsp;systemid,
270 java.net.URL&nbsp;base)</PRE>
271<DL>
272<DD><p>Add a PUBLIC catalog entry to the controlling XMLCatalog instance.
273 ApacheCatalog calls this for each PUBLIC entry found in an external
274 catalog file.</p>
275<P>
276<DD><DL>
277<DT><B>Parameters:</B><DD><CODE>publicid</CODE> - The public ID of the resource<DD><CODE>systemid</CODE> - The system ID (aka location) of the resource<DD><CODE>base</CODE> - The base URL of the resource. If the systemid
278 specifies a relative URL/pathname, it is resolved using the
279 base. The default base for an external catalog file is the
280 directory in which the catalog is located.</DL>
281</DD>
282</DL>
283<HR>
284
285<A NAME="addURIEntry(java.lang.String, java.lang.String, java.net.URL)"><!-- --></A><H3>
286addURIEntry</H3>
287<PRE>
288public void <B>addURIEntry</B>(java.lang.String&nbsp;uri,
289 java.lang.String&nbsp;altURI,
290 java.net.URL&nbsp;base)</PRE>
291<DL>
292<DD><p>Add a URI catalog entry to the controlling XMLCatalog instance.
293 ApacheCatalog calls this for each URI entry found in an external
294 catalog file.</p>
295<P>
296<DD><DL>
297<DT><B>Parameters:</B><DD><CODE>uri</CODE> - The URI of the resource<DD><CODE>altURI</CODE> - The URI to which the resource should be mapped
298 (aka the location)<DD><CODE>base</CODE> - The base URL of the resource. If the altURI
299 specifies a relative URL/pathname, it is resolved using the
300 base. The default base for an external catalog file is the
301 directory in which the catalog is located.</DL>
302</DD>
303</DL>
304<!-- ========= END OF CLASS DATA ========= -->
305<HR>
306
307
308<!-- ======= START OF BOTTOM NAVBAR ====== -->
309<A NAME="navbar_bottom"><!-- --></A>
310<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
311<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
312<TR>
313<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
314<A NAME="navbar_bottom_firstrow"><!-- --></A>
315<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
316 <TR ALIGN="center" VALIGN="top">
317 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
318 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
319 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
320 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
321 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
322 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
323 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
324 </TR>
325</TABLE>
326</TD>
327<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
328</EM>
329</TD>
330</TR>
331
332<TR>
333<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
334&nbsp;<A HREF="../../../../../../org/apache/tools/ant/types/resolver/ApacheCatalog.html" title="class in org.apache.tools.ant.types.resolver"><B>PREV CLASS</B></A>&nbsp;
335&nbsp;NEXT CLASS</FONT></TD>
336<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
337 <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
338&nbsp;<A HREF="ApacheCatalogResolver.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
339&nbsp;<SCRIPT type="text/javascript">
340 <!--
341 if(window==top) {
342 document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
343 }
344 //-->
345</SCRIPT>
346<NOSCRIPT>
347 <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
348</NOSCRIPT>
349
350</FONT></TD>
351</TR>
352<TR>
353<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
354 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
355<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
356DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
357</TR>
358</TABLE>
359<A NAME="skip-navbar_bottom"></A>
360<!-- ======== END OF BOTTOM NAVBAR ======= -->
361
362<HR>
363Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
364</BODY>
365</HTML>
Note: See TracBrowser for help on using the repository browser.