source: other-projects/trunk/gs3-webservices-democlient/docs/GS3Fedora/org/greenstone/fedora/services/FedoraCommons.html@ 15222

Last change on this file since 15222 was 15222, checked in by ak19, 16 years ago

Greenstone3 web services demo-clientadded to GS3's other-projects
File size: 13.2 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.5.0_10) on Sun Apr 27 20:42:37 NZST 2008 -->
6<TITLE>
7FedoraCommons
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.greenstone.fedora.services.FedoraCommons 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="FedoraCommons";
18}
19</SCRIPT>
20<NOSCRIPT>
21</NOSCRIPT>
22
23</HEAD>
24
25<BODY BGCOLOR="white" onload="windowTitle();">
26
27
28<!-- ========= START OF TOP NAVBAR ======= -->
29<A NAME="navbar_top"><!-- --></A>
30<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
31<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
32<TR>
33<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
34<A NAME="navbar_top_firstrow"><!-- --></A>
35<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
36 <TR ALIGN="center" VALIGN="top">
37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../org/greenstone/fedora/services/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
38 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
43 </TR>
44</TABLE>
45</TD>
46<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
47</EM>
48</TD>
49</TR>
50
51<TR>
52<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
53&nbsp;PREV CLASS&nbsp;
54&nbsp;<A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html" title="class in org.greenstone.fedora.services"><B>NEXT CLASS</B></A></FONT></TD>
55<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
56 <A HREF="../../../../index.html?org/greenstone/fedora/services/FedoraCommons.html" target="_top"><B>FRAMES</B></A> &nbsp;
57&nbsp;<A HREF="FedoraCommons.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
58&nbsp;<SCRIPT type="text/javascript">
59 <!--
60 if(window==top) {
61 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
62 }
63 //-->
64</SCRIPT>
65<NOSCRIPT>
66 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
67</NOSCRIPT>
68
69
70</FONT></TD>
71</TR>
72<TR>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
75<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
76DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
77</TR>
78</TABLE>
79<A NAME="skip-navbar_top"></A>
80<!-- ========= END OF TOP NAVBAR ========= -->
81
82<HR>
83<!-- ======== START OF CLASS DATA ======== -->
84<H2>
85<FONT SIZE="-1">
86org.greenstone.fedora.services</FONT>
87<BR>
88Class FedoraCommons</H2>
89<PRE>
90java.lang.Object
91 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.greenstone.fedora.services.FedoraCommons</B>
92</PRE>
93<HR>
94<DL>
95<DT><PRE>public class <B>FedoraCommons</B><DT>extends java.lang.Object</DL>
96</PRE>
97
98<P>
99Methods common to both Fedora(GS3)Connection and GSearchConnection.
100 Made static here so they can be reused by these classes.
101<P>
102
103<P>
104<DL>
105<DT><B>Author:</B></DT>
106 <DD>ak19</DD>
107</DL>
108<HR>
109
110<P>
111
112<!-- ======== CONSTRUCTOR SUMMARY ======== -->
113
114<A NAME="constructor_summary"><!-- --></A>
115<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
116<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
117<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
118<B>Constructor Summary</B></FONT></TH>
119</TR>
120<TR BGCOLOR="white" CLASS="TableRowColor">
121<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraCommons.html#FedoraCommons()">FedoraCommons</A></B>()</CODE>
122
123<BR>
124&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
125</TR>
126</TABLE>
127&nbsp;
128<!-- ========== METHOD SUMMARY =========== -->
129
130<A NAME="method_summary"><!-- --></A>
131<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
132<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
133<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
134<B>Method Summary</B></FONT></TH>
135</TR>
136<TR BGCOLOR="white" CLASS="TableRowColor">
137<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
138<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
139<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraCommons.html#elementToFormattedString(org.w3c.dom.Element)">elementToFormattedString</A></B>(org.w3c.dom.Element&nbsp;e)</CODE>
140
141<BR>
142&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Given an Element, this will return its String representation properly
143 indented for display.</TD>
144</TR>
145<TR BGCOLOR="white" CLASS="TableRowColor">
146<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
147<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
148<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraCommons.html#elementToString(org.w3c.dom.Element)">elementToString</A></B>(org.w3c.dom.Element&nbsp;e)</CODE>
149
150<BR>
151&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Given an Element, this will return its String representation without
152 indenting it for display.</TD>
153</TR>
154<TR BGCOLOR="white" CLASS="TableRowColor">
155<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
156<CODE>static&nbsp;org.w3c.dom.Element</CODE></FONT></TD>
157<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraCommons.html#getResponseAsDOM(javax.xml.parsers.DocumentBuilder, java.lang.String)">getResponseAsDOM</A></B>(javax.xml.parsers.DocumentBuilder&nbsp;builder,
158 java.lang.String&nbsp;XML)</CODE>
159
160<BR>
161&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Turns the XML String into a DOM tree and returns it.</TD>
162</TR>
163<TR BGCOLOR="white" CLASS="TableRowColor">
164<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
165<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
166<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraCommons.html#getValue(org.w3c.dom.Element)">getValue</A></B>(org.w3c.dom.Element&nbsp;e)</CODE>
167
168<BR>
169&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Extract the text from an element, if any.</TD>
170</TR>
171</TABLE>
172&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
173<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
174<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
175<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
176</TR>
177<TR BGCOLOR="white" CLASS="TableRowColor">
178<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
179</TR>
180</TABLE>
181&nbsp;
182<P>
183
184<!-- ========= CONSTRUCTOR DETAIL ======== -->
185
186<A NAME="constructor_detail"><!-- --></A>
187<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
188<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
189<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
190<B>Constructor Detail</B></FONT></TH>
191</TR>
192</TABLE>
193
194<A NAME="FedoraCommons()"><!-- --></A><H3>
195FedoraCommons</H3>
196<PRE>
197public <B>FedoraCommons</B>()</PRE>
198<DL>
199</DL>
200
201<!-- ============ METHOD DETAIL ========== -->
202
203<A NAME="method_detail"><!-- --></A>
204<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
205<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
206<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
207<B>Method Detail</B></FONT></TH>
208</TR>
209</TABLE>
210
211<A NAME="getValue(org.w3c.dom.Element)"><!-- --></A><H3>
212getValue</H3>
213<PRE>
214public static java.lang.String <B>getValue</B>(org.w3c.dom.Element&nbsp;e)</PRE>
215<DL>
216<DD>Extract the text from an element, if any.
217<P>
218<DD><DL>
219<DT><B>Parameters:</B><DD><CODE>e</CODE> - is the element whose value is to be extracted.
220<DT><B>Returns:</B><DD>the text that's nested in an element's body or ""
221 if there's none.</DL>
222</DD>
223</DL>
224<HR>
225
226<A NAME="getResponseAsDOM(javax.xml.parsers.DocumentBuilder, java.lang.String)"><!-- --></A><H3>
227getResponseAsDOM</H3>
228<PRE>
229public static org.w3c.dom.Element <B>getResponseAsDOM</B>(javax.xml.parsers.DocumentBuilder&nbsp;builder,
230 java.lang.String&nbsp;XML)
231 throws org.xml.sax.SAXException,
232 java.io.IOException</PRE>
233<DL>
234<DD>Turns the XML String into a DOM tree and returns it.
235<P>
236<DD><DL>
237<DT><B>Parameters:</B><DD><CODE>XML</CODE> - the string to be converted into a DOM tree<DD><CODE>builder</CODE> - is the DocumentBuilder to use to parse the string XML
238<DT><B>Returns:</B><DD>the root element of the document by parsing the string XML
239<DT><B>Throws:</B>
240<DD><CODE>org.xml.sax.SAXException</CODE>
241<DD><CODE>java.io.IOException</CODE></DL>
242</DD>
243</DL>
244<HR>
245
246<A NAME="elementToString(org.w3c.dom.Element)"><!-- --></A><H3>
247elementToString</H3>
248<PRE>
249public static java.lang.String <B>elementToString</B>(org.w3c.dom.Element&nbsp;e)
250 throws javax.xml.transform.TransformerException</PRE>
251<DL>
252<DD>Given an Element, this will return its String representation without
253 indenting it for display.
254<P>
255<DD><DL>
256<DT><B>Parameters:</B><DD><CODE>e</CODE> - is the element to be converted to its string representation.
257<DT><B>Returns:</B><DD>a string representation of e without formatting it for display.
258<DT><B>Throws:</B>
259<DD><CODE>javax.xml.transform.TransformerException</CODE></DL>
260</DD>
261</DL>
262<HR>
263
264<A NAME="elementToFormattedString(org.w3c.dom.Element)"><!-- --></A><H3>
265elementToFormattedString</H3>
266<PRE>
267public static java.lang.String <B>elementToFormattedString</B>(org.w3c.dom.Element&nbsp;e)
268 throws javax.xml.transform.TransformerException</PRE>
269<DL>
270<DD>Given an Element, this will return its String representation properly
271 indented for display.
272<P>
273<DD><DL>
274<DT><B>Parameters:</B><DD><CODE>e</CODE> - is the element to be converted to its string representation.
275<DT><B>Returns:</B><DD>a string representation of e, formatted for display.
276<DT><B>Throws:</B>
277<DD><CODE>javax.xml.transform.TransformerException</CODE></DL>
278</DD>
279</DL>
280<!-- ========= END OF CLASS DATA ========= -->
281<HR>
282
283
284<!-- ======= START OF BOTTOM NAVBAR ====== -->
285<A NAME="navbar_bottom"><!-- --></A>
286<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
287<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
288<TR>
289<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
290<A NAME="navbar_bottom_firstrow"><!-- --></A>
291<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
292 <TR ALIGN="center" VALIGN="top">
293 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../org/greenstone/fedora/services/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
294 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
295 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
296 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
297 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
298 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
299 </TR>
300</TABLE>
301</TD>
302<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
303</EM>
304</TD>
305</TR>
306
307<TR>
308<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
309&nbsp;PREV CLASS&nbsp;
310&nbsp;<A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html" title="class in org.greenstone.fedora.services"><B>NEXT CLASS</B></A></FONT></TD>
311<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
312 <A HREF="../../../../index.html?org/greenstone/fedora/services/FedoraCommons.html" target="_top"><B>FRAMES</B></A> &nbsp;
313&nbsp;<A HREF="FedoraCommons.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
314&nbsp;<SCRIPT type="text/javascript">
315 <!--
316 if(window==top) {
317 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
318 }
319 //-->
320</SCRIPT>
321<NOSCRIPT>
322 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
323</NOSCRIPT>
324
325
326</FONT></TD>
327</TR>
328<TR>
329<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
330 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
331<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
332DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
333</TR>
334</TABLE>
335<A NAME="skip-navbar_bottom"></A>
336<!-- ======== END OF BOTTOM NAVBAR ======= -->
337
338<HR>
339
340</BODY>
341</HTML>
Note: See TracBrowser for help on using the repository browser.