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:47:19 NZST 2008 -->
|
---|
6 | <TITLE>
|
---|
7 | org.greenstone.gs3client.data
|
---|
8 | </TITLE>
|
---|
9 |
|
---|
10 | <META NAME="keywords" CONTENT="org.greenstone.gs3client.data package">
|
---|
11 |
|
---|
12 | <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
|
---|
13 |
|
---|
14 | <SCRIPT type="text/javascript">
|
---|
15 | function windowTitle()
|
---|
16 | {
|
---|
17 | parent.document.title="org.greenstone.gs3client.data";
|
---|
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="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
---|
38 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
|
---|
39 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
|
---|
40 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
---|
41 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
---|
42 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
---|
43 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
---|
44 | </TR>
|
---|
45 | </TABLE>
|
---|
46 | </TD>
|
---|
47 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
---|
48 | </EM>
|
---|
49 | </TD>
|
---|
50 | </TR>
|
---|
51 |
|
---|
52 | <TR>
|
---|
53 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
54 | <A HREF="../../../../org/greenstone/gs3client/package-summary.html"><B>PREV PACKAGE</B></A>
|
---|
55 | <A HREF="../../../../org/greenstone/gs3client/dlservices/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
|
---|
56 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
57 | <A HREF="../../../../index.html?org/greenstone/gs3client/data/package-summary.html" target="_top"><B>FRAMES</B></A>
|
---|
58 | <A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>
|
---|
59 | <SCRIPT type="text/javascript">
|
---|
60 | <!--
|
---|
61 | if(window==top) {
|
---|
62 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
---|
63 | }
|
---|
64 | //-->
|
---|
65 | </SCRIPT>
|
---|
66 | <NOSCRIPT>
|
---|
67 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
---|
68 | </NOSCRIPT>
|
---|
69 |
|
---|
70 |
|
---|
71 | </FONT></TD>
|
---|
72 | </TR>
|
---|
73 | </TABLE>
|
---|
74 | <A NAME="skip-navbar_top"></A>
|
---|
75 | <!-- ========= END OF TOP NAVBAR ========= -->
|
---|
76 |
|
---|
77 | <HR>
|
---|
78 | <H2>
|
---|
79 | Package org.greenstone.gs3client.data
|
---|
80 | </H2>
|
---|
81 |
|
---|
82 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
83 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
84 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
---|
85 | <B>Class Summary</B></FONT></TH>
|
---|
86 | </TR>
|
---|
87 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
88 | <TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/gs3client/data/BrowseResponseData.html" title="class in org.greenstone.gs3client.data">BrowseResponseData</A></B></TD>
|
---|
89 | <TD>Stores the data contained in an XML response message to a request for
|
---|
90 | the classification Browse structure.</TD>
|
---|
91 | </TR>
|
---|
92 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
93 | <TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/gs3client/data/ClassifierNodeData.html" title="class in org.greenstone.gs3client.data">ClassifierNodeData</A></B></TD>
|
---|
94 | <TD>ClassifierNodeData represents the information that can be stored in a
|
---|
95 | <classifierNode> element.</TD>
|
---|
96 | </TR>
|
---|
97 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
98 | <TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.html" title="class in org.greenstone.gs3client.data">CollectionData</A></B></TD>
|
---|
99 | <TD>CollectionData represents a Greenstone 3 collection and contains the data
|
---|
100 | stored in a <collection></collection> element returned from a
|
---|
101 | MessageRouter's desribe response XML and a Collection describe response XML.</TD>
|
---|
102 | </TR>
|
---|
103 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
104 | <TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.MetaData.html" title="class in org.greenstone.gs3client.data">CollectionData.MetaData</A></B></TD>
|
---|
105 | <TD>Static inner class MetaData: can import it into other files as
|
---|
106 | "import gs3client.CollectionData.MetaData;"
|
---|
107 | In this way, can use it as if it were a regular class (a.o.t.</TD>
|
---|
108 | </TR>
|
---|
109 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
110 | <TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.PluginData.html" title="class in org.greenstone.gs3client.data">CollectionData.PluginData</A></B></TD>
|
---|
111 | <TD>PluginData inner class of CollectionData, represents the data stored in
|
---|
112 | a <plugin></plugin> element.</TD>
|
---|
113 | </TR>
|
---|
114 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
115 | <TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.ServiceData.html" title="class in org.greenstone.gs3client.data">CollectionData.ServiceData</A></B></TD>
|
---|
116 | <TD>Only the name and type of a <service></service> element is
|
---|
117 | stored, since this is all the service data available inside a collection's
|
---|
118 | response message to a describe request.</TD>
|
---|
119 | </TR>
|
---|
120 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
121 | <TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A></B></TD>
|
---|
122 | <TD>Represents the data stored in the <documentNode> Elements
|
---|
123 | of Greenstone 3's XML response messages.</TD>
|
---|
124 | </TR>
|
---|
125 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
126 | <TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/gs3client/data/MetaData.html" title="class in org.greenstone.gs3client.data">MetaData</A></B></TD>
|
---|
127 | <TD>Stores the name, value and value of body textnode of a simple <metadata>
|
---|
128 | element.</TD>
|
---|
129 | </TR>
|
---|
130 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
131 | <TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/gs3client/data/NodeData.html" title="class in org.greenstone.gs3client.data">NodeData</A></B></TD>
|
---|
132 | <TD>Abstract superclass NodeData can represent either a the information in
|
---|
133 | a <classifierNode> (stored in a ClassifierNodeData object) or in a
|
---|
134 | <documentNode> (stored in a DocumentNodeData object).</TD>
|
---|
135 | </TR>
|
---|
136 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
137 | <TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/gs3client/data/Pair.html" title="class in org.greenstone.gs3client.data">Pair</A></B></TD>
|
---|
138 | <TD>Pair is a simple utility class to represent two associated String values.</TD>
|
---|
139 | </TR>
|
---|
140 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
141 | <TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/gs3client/data/ParseUtil.html" title="class in org.greenstone.gs3client.data">ParseUtil</A></B></TD>
|
---|
142 | <TD>Some useful, general response XML message parsing functions
|
---|
143 | for the JavaClient's data classes.</TD>
|
---|
144 | </TR>
|
---|
145 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
146 | <TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/gs3client/data/QueryFormData.html" title="class in org.greenstone.gs3client.data">QueryFormData</A></B></TD>
|
---|
147 | <TD>Class QueryFormData represents the <param> and <option> elements
|
---|
148 | that can appear in a <paramList> tag in the xml response returned by
|
---|
149 | a describe request sent to *Query* Service (e.g.</TD>
|
---|
150 | </TR>
|
---|
151 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
152 | <TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/gs3client/data/QueryFormData.QueryFormParam.html" title="class in org.greenstone.gs3client.data">QueryFormData.QueryFormParam</A></B></TD>
|
---|
153 | <TD>Static inner class QueryFormParam is a subclass of QueryFormData and
|
---|
154 | uniquely represents the data that can be contained in any <param>
|
---|
155 | tag of the xml response that's returned when a describe request is sent to
|
---|
156 | a Query Service.</TD>
|
---|
157 | </TR>
|
---|
158 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
159 | <TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/gs3client/data/QueryResponseData.html" title="class in org.greenstone.gs3client.data">QueryResponseData</A></B></TD>
|
---|
160 | <TD>Represents the data fields that may be present in a response
|
---|
161 | to a Query-process request.</TD>
|
---|
162 | </TR>
|
---|
163 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
164 | <TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/gs3client/data/QueryResponseData.TermData.html" title="class in org.greenstone.gs3client.data">QueryResponseData.TermData</A></B></TD>
|
---|
165 | <TD>Static inner class Term represents a <term> XML element
|
---|
166 | (these are nested in a <termList>) - see manual p.</TD>
|
---|
167 | </TR>
|
---|
168 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
169 | <TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/gs3client/data/ResponseData.html" title="class in org.greenstone.gs3client.data">ResponseData</A></B></TD>
|
---|
170 | <TD>Represents the data in a response XML message that is returned as
|
---|
171 | either a Browse or Query (Search) request.</TD>
|
---|
172 | </TR>
|
---|
173 | </TABLE>
|
---|
174 |
|
---|
175 |
|
---|
176 | <P>
|
---|
177 | <DL>
|
---|
178 | </DL>
|
---|
179 | <HR>
|
---|
180 |
|
---|
181 |
|
---|
182 | <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
---|
183 | <A NAME="navbar_bottom"><!-- --></A>
|
---|
184 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
---|
185 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
---|
186 | <TR>
|
---|
187 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
---|
188 | <A NAME="navbar_bottom_firstrow"><!-- --></A>
|
---|
189 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
---|
190 | <TR ALIGN="center" VALIGN="top">
|
---|
191 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
---|
192 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
|
---|
193 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
|
---|
194 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
---|
195 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
---|
196 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
---|
197 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
---|
198 | </TR>
|
---|
199 | </TABLE>
|
---|
200 | </TD>
|
---|
201 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
---|
202 | </EM>
|
---|
203 | </TD>
|
---|
204 | </TR>
|
---|
205 |
|
---|
206 | <TR>
|
---|
207 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
208 | <A HREF="../../../../org/greenstone/gs3client/package-summary.html"><B>PREV PACKAGE</B></A>
|
---|
209 | <A HREF="../../../../org/greenstone/gs3client/dlservices/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
|
---|
210 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
211 | <A HREF="../../../../index.html?org/greenstone/gs3client/data/package-summary.html" target="_top"><B>FRAMES</B></A>
|
---|
212 | <A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>
|
---|
213 | <SCRIPT type="text/javascript">
|
---|
214 | <!--
|
---|
215 | if(window==top) {
|
---|
216 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
---|
217 | }
|
---|
218 | //-->
|
---|
219 | </SCRIPT>
|
---|
220 | <NOSCRIPT>
|
---|
221 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
---|
222 | </NOSCRIPT>
|
---|
223 |
|
---|
224 |
|
---|
225 | </FONT></TD>
|
---|
226 | </TR>
|
---|
227 | </TABLE>
|
---|
228 | <A NAME="skip-navbar_bottom"></A>
|
---|
229 | <!-- ======== END OF BOTTOM NAVBAR ======= -->
|
---|
230 |
|
---|
231 | <HR>
|
---|
232 |
|
---|
233 | </BODY>
|
---|
234 | </HTML>
|
---|