1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
\r
5 <!-- Generated by javadoc (build 1.5.0_22) on Tue May 10 10:28:01 IST 2011 -->
\r
10 <META NAME="keywords" CONTENT="com.pras.WorkSheet class">
\r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
\r
14 <SCRIPT type="text/javascript">
\r
15 function windowTitle()
\r
17 parent.document.title="WorkSheet";
\r
25 <BODY BGCOLOR="white" onload="windowTitle();">
\r
28 <!-- ========= START OF TOP NAVBAR ======= -->
\r
29 <A NAME="navbar_top"><!-- --></A>
\r
30 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
\r
31 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
33 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
34 <A NAME="navbar_top_firstrow"><!-- --></A>
\r
35 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
36 <TR ALIGN="center" VALIGN="top">
\r
37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
39 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/WorkSheet.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
48 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
54 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
55 <A HREF="../../com/pras/SpreadSheetFactory.html" title="class in com.pras"><B>PREV CLASS</B></A>
\r
56 <A HREF="../../com/pras/WorkSheetCell.html" title="class in com.pras"><B>NEXT CLASS</B></A></FONT></TD>
\r
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
58 <A HREF="../../index.html?com/pras/WorkSheet.html" target="_top"><B>FRAMES</B></A>
\r
59 <A HREF="WorkSheet.html" target="_top"><B>NO FRAMES</B></A>
\r
60 <SCRIPT type="text/javascript">
\r
63 document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
68 <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
\r
75 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
76 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
77 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
78 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
81 <A NAME="skip-navbar_top"></A>
\r
82 <!-- ========= END OF TOP NAVBAR ========= -->
\r
85 <!-- ======== START OF CLASS DATA ======== -->
\r
90 Class WorkSheet</H2>
\r
93 <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>com.pras.WorkSheet</B>
\r
97 <DT><PRE>public class <B>WorkSheet</B><DT>extends java.lang.Object</DL>
\r
101 This class represents an WorkSheet and utility methods to manage WorkSheet data.
102 WorkSheets will manage (Add/Edit/Delete) data in Tables. It also supports <u>List
103 based Feed</u>, but only to <b>retrieve data</b>. At present it doesn't provide any method to Add/Edit/Delete
104 data in List based Feed.
107 <b><a href="http://code.google.com/apis/spreadsheets/data/3.0/developers_guide.html#TableFeeds">Table Feed</a></b>
109 To Add/Edit/Delete Data, you need to use addRecord(), updateRecord() and deleteRecord(). It
110 internally stores data in a single Table.
112 <b>Note:</b> <u>Table Feed will ignore data entered through Web UI.</u>
113 So, if you want all data records irrespective of from where those are inserted/updated, you should use List Feed.
117 <b><a href="http://code.google.com/apis/spreadsheets/data/3.0/developers_guide.html#ListFeeds">List Feed</a></b>
119 To Retrieve data using List based Feed, use getData() method.
\r
124 <DT><B>Author:</B></DT>
\r
125 <DD>Prasanta Paul</DD>
\r
131 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
133 <A NAME="constructor_summary"><!-- --></A>
\r
134 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
135 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
136 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
137 <B>Constructor Summary</B></FONT></TH>
\r
139 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
140 <TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#WorkSheet()">WorkSheet</A></B>()</CODE>
\r
143 </TD>
\r
147 <!-- ========== METHOD SUMMARY =========== -->
\r
149 <A NAME="method_summary"><!-- --></A>
\r
150 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
151 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
152 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
153 <B>Method Summary</B></FONT></TH>
\r
155 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
156 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
157 <CODE> <A HREF="../../com/pras/WorkSheetRow.html" title="class in com.pras">WorkSheetRow</A></CODE></FONT></TD>
\r
158 <TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#addListRow(java.util.HashMap)">addListRow</A></B>(java.util.HashMap<java.lang.String,java.lang.String> records)</CODE>
\r
161 Add List Feed row.</TD>
\r
163 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
164 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
165 <CODE> void</CODE></FONT></TD>
\r
166 <TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#addRecord(java.lang.String, java.util.HashMap)">addRecord</A></B>(java.lang.String key,
\r
167 java.util.HashMap<java.lang.String,java.lang.String> records)</CODE>
\r
170 Add record into WorkSheet.</TD>
\r
172 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
173 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
174 <CODE> void</CODE></FONT></TD>
\r
175 <TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#delete()">delete</A></B>()</CODE>
\r
178 Delete this WorkSheet.</TD>
\r
180 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
181 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
182 <CODE> void</CODE></FONT></TD>
\r
183 <TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#deleteListRow(java.lang.String, com.pras.WorkSheetRow)">deleteListRow</A></B>(java.lang.String key,
\r
184 <A HREF="../../com/pras/WorkSheetRow.html" title="class in com.pras">WorkSheetRow</A> r)</CODE>
\r
187 Delete List Row</TD>
\r
189 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
190 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
191 <CODE> void</CODE></FONT></TD>
\r
192 <TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#deleteRecord(com.pras.table.Record)">deleteRecord</A></B>(<A HREF="../../com/pras/table/Record.html" title="class in com.pras.table">Record</A> record)</CODE>
\r
195 Delete a Record</TD>
\r
197 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
198 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
199 <CODE> int</CODE></FONT></TD>
\r
200 <TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#getColCount()">getColCount</A></B>()</CODE>
\r
203 Get column count of this WorkSheet</TD>
\r
205 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
206 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
207 <CODE> java.lang.String[]</CODE></FONT></TD>
\r
208 <TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#getColumns()">getColumns</A></B>()</CODE>
\r
211 Get columns of the WorkSheet.</TD>
\r
213 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
214 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
215 <CODE> java.util.ArrayList<<A HREF="../../com/pras/WorkSheetRow.html" title="class in com.pras">WorkSheetRow</A>></CODE></FONT></TD>
\r
216 <TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#getData(boolean)">getData</A></B>(boolean isCachedData)</CODE>
\r
219 Get all data of this WorkSheet (List based Feed)</TD>
\r
221 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
222 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
223 <CODE> java.util.ArrayList<<A HREF="../../com/pras/WorkSheetRow.html" title="class in com.pras">WorkSheetRow</A>></CODE></FONT></TD>
\r
224 <TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#getData(boolean, boolean, java.lang.String, java.lang.String)">getData</A></B>(boolean isCachedData,
\r
225 boolean doReverse,
\r
226 java.lang.String sq,
\r
227 java.lang.String orderBy)</CODE>
\r
230 List based Feed for a particular Work Sheet.</TD>
\r
232 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
233 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
234 <CODE> <A HREF="../../com/pras/sp/Entry.html" title="class in com.pras.sp">Entry</A></CODE></FONT></TD>
\r
235 <TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#getEntry()">getEntry</A></B>()</CODE>
\r
238 Get Entry instance for this WorkSheet.</TD>
\r
240 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
241 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
242 <CODE> java.util.ArrayList<<A HREF="../../com/pras/table/Record.html" title="class in com.pras.table">Record</A>></CODE></FONT></TD>
\r
243 <TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#getRecords()">getRecords</A></B>()</CODE>
\r
246 Get Cached Data (previously retrieved from server)</TD>
\r
248 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
249 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
250 <CODE> java.util.ArrayList<<A HREF="../../com/pras/table/Record.html" title="class in com.pras.table">Record</A>></CODE></FONT></TD>
\r
251 <TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#getRecords(java.lang.String)">getRecords</A></B>(java.lang.String key)</CODE>
\r
254 Get data stored in this WorkSheet</TD>
\r
256 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
257 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
258 <CODE> java.util.ArrayList<<A HREF="../../com/pras/table/Record.html" title="class in com.pras.table">Record</A>></CODE></FONT></TD>
\r
259 <TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#getRecords(java.lang.String, boolean, java.lang.String, java.lang.String)">getRecords</A></B>(java.lang.String key,
\r
260 boolean doReverse,
\r
261 java.lang.String sq,
\r
262 java.lang.String orderBy)</CODE>
\r
265 Get data stored in this WorkSheet.</TD>
\r
267 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
268 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
269 <CODE> java.util.ArrayList<<A HREF="../../com/pras/table/Record.html" title="class in com.pras.table">Record</A>></CODE></FONT></TD>
\r
270 <TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#getRecords(java.lang.String, java.lang.String)">getRecords</A></B>(java.lang.String key,
\r
271 java.lang.String sq)</CODE>
\r
274 </TD>
\r
276 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
277 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
278 <CODE> int</CODE></FONT></TD>
\r
279 <TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#getRowCount()">getRowCount</A></B>()</CODE>
\r
282 Get row count of this WorkSheet</TD>
\r
284 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
285 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
286 <CODE> java.lang.String</CODE></FONT></TD>
\r
287 <TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#getTitle()">getTitle</A></B>()</CODE>
\r
290 Get WorkSheet Title</TD>
\r
292 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
293 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
294 <CODE> java.lang.String</CODE></FONT></TD>
\r
295 <TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#getWorkSheetID()">getWorkSheetID</A></B>()</CODE>
\r
298 Get WorkSheet ID</TD>
\r
300 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
301 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
302 <CODE> java.lang.String</CODE></FONT></TD>
\r
303 <TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#getWorkSheetURL()">getWorkSheetURL</A></B>()</CODE>
\r
306 Get WorkSheetURL</TD>
\r
308 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
309 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
310 <CODE> void</CODE></FONT></TD>
\r
311 <TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#setColCount(int)">setColCount</A></B>(int colCount)</CODE>
\r
314 Set column count of this WorkSheet</TD>
\r
316 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
317 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
318 <CODE> void</CODE></FONT></TD>
\r
319 <TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#setColumns(java.lang.String[])">setColumns</A></B>(java.lang.String[] columns)</CODE>
\r
322 Set columns of ListFeed</TD>
\r
324 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
325 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
326 <CODE> void</CODE></FONT></TD>
\r
327 <TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#setEntry(com.pras.sp.Entry)">setEntry</A></B>(<A HREF="../../com/pras/sp/Entry.html" title="class in com.pras.sp">Entry</A> entry)</CODE>
\r
330 Set Feed Entry instance</TD>
\r
332 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
333 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
334 <CODE> void</CODE></FONT></TD>
\r
335 <TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#setRowCount(int)">setRowCount</A></B>(int rowCount)</CODE>
\r
338 Set row count of this WorkSheet</TD>
\r
340 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
341 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
342 <CODE> void</CODE></FONT></TD>
\r
343 <TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#setTitle(java.lang.String)">setTitle</A></B>(java.lang.String title)</CODE>
\r
346 Set WorkSheet Title</TD>
\r
348 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
349 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
350 <CODE> void</CODE></FONT></TD>
\r
351 <TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#setWorkSheetID(java.lang.String)">setWorkSheetID</A></B>(java.lang.String workSheetID)</CODE>
\r
354 Set WorkSheet ID</TD>
\r
356 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
357 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
358 <CODE> void</CODE></FONT></TD>
\r
359 <TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#setWorkSheetURL(java.lang.String)">setWorkSheetURL</A></B>(java.lang.String workSheetURL)</CODE>
\r
362 Set WorkSheet</TD>
\r
364 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
365 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
366 <CODE> <A HREF="../../com/pras/WorkSheetRow.html" title="class in com.pras">WorkSheetRow</A></CODE></FONT></TD>
\r
367 <TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#updateListRow(java.lang.String, com.pras.WorkSheetRow, java.util.HashMap)">updateListRow</A></B>(java.lang.String key,
\r
368 <A HREF="../../com/pras/WorkSheetRow.html" title="class in com.pras">WorkSheetRow</A> r,
\r
369 java.util.HashMap<java.lang.String,java.lang.String> records)</CODE>
\r
372 Update List row</TD>
\r
374 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
375 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
376 <CODE> void</CODE></FONT></TD>
\r
377 <TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#updateRecord(com.pras.table.Record)">updateRecord</A></B>(<A HREF="../../com/pras/table/Record.html" title="class in com.pras.table">Record</A> record)</CODE>
\r
380 Record instance you want to Update
381 Keep only those data which you want to update for this record</TD>
\r
384 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
\r
385 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
386 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
387 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
\r
389 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
390 <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
\r
396 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
398 <A NAME="constructor_detail"><!-- --></A>
\r
399 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
400 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
401 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
402 <B>Constructor Detail</B></FONT></TH>
\r
406 <A NAME="WorkSheet()"><!-- --></A><H3>
\r
409 public <B>WorkSheet</B>()</PRE>
\r
413 <!-- ============ METHOD DETAIL ========== -->
\r
415 <A NAME="method_detail"><!-- --></A>
\r
416 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
417 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
418 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
419 <B>Method Detail</B></FONT></TH>
\r
423 <A NAME="getWorkSheetID()"><!-- --></A><H3>
\r
424 getWorkSheetID</H3>
\r
426 public java.lang.String <B>getWorkSheetID</B>()</PRE>
\r
428 <DD>Get WorkSheet ID
\r
432 <DT><B>Returns:</B><DD></DL>
\r
437 <A NAME="setWorkSheetID(java.lang.String)"><!-- --></A><H3>
\r
438 setWorkSheetID</H3>
\r
440 public void <B>setWorkSheetID</B>(java.lang.String workSheetID)</PRE>
\r
442 <DD>Set WorkSheet ID
\r
445 <DT><B>Parameters:</B><DD><CODE>workSheetID</CODE> - </DL>
\r
450 <A NAME="getWorkSheetURL()"><!-- --></A><H3>
\r
451 getWorkSheetURL</H3>
\r
453 public java.lang.String <B>getWorkSheetURL</B>()</PRE>
\r
455 <DD>Get WorkSheetURL
\r
459 <DT><B>Returns:</B><DD></DL>
\r
464 <A NAME="setWorkSheetURL(java.lang.String)"><!-- --></A><H3>
\r
465 setWorkSheetURL</H3>
\r
467 public void <B>setWorkSheetURL</B>(java.lang.String workSheetURL)</PRE>
\r
472 <DT><B>Parameters:</B><DD><CODE>workSheetURL</CODE> - </DL>
\r
477 <A NAME="getTitle()"><!-- --></A><H3>
\r
480 public java.lang.String <B>getTitle</B>()</PRE>
\r
482 <DD>Get WorkSheet Title
\r
486 <DT><B>Returns:</B><DD></DL>
\r
491 <A NAME="setTitle(java.lang.String)"><!-- --></A><H3>
\r
494 public void <B>setTitle</B>(java.lang.String title)</PRE>
\r
496 <DD>Set WorkSheet Title
\r
499 <DT><B>Parameters:</B><DD><CODE>title</CODE> - </DL>
\r
504 <A NAME="getColCount()"><!-- --></A><H3>
\r
507 public int <B>getColCount</B>()</PRE>
\r
509 <DD>Get column count of this WorkSheet
\r
513 <DT><B>Returns:</B><DD></DL>
\r
518 <A NAME="setColCount(int)"><!-- --></A><H3>
\r
521 public void <B>setColCount</B>(int colCount)</PRE>
\r
523 <DD>Set column count of this WorkSheet
\r
526 <DT><B>Parameters:</B><DD><CODE>colCount</CODE> - </DL>
\r
531 <A NAME="getRowCount()"><!-- --></A><H3>
\r
534 public int <B>getRowCount</B>()</PRE>
\r
536 <DD>Get row count of this WorkSheet
\r
540 <DT><B>Returns:</B><DD></DL>
\r
545 <A NAME="setRowCount(int)"><!-- --></A><H3>
\r
548 public void <B>setRowCount</B>(int rowCount)</PRE>
\r
550 <DD>Set row count of this WorkSheet
\r
553 <DT><B>Parameters:</B><DD><CODE>rowCount</CODE> - </DL>
\r
558 <A NAME="getColumns()"><!-- --></A><H3>
\r
561 public java.lang.String[] <B>getColumns</B>()</PRE>
\r
563 <DD>Get columns of the WorkSheet. It will return columns of associated table, otherwise
564 columns of List Feed i.e. content of Header row of ListFeed
\r
568 <DT><B>Returns:</B><DD></DL>
\r
573 <A NAME="setColumns(java.lang.String[])"><!-- --></A><H3>
\r
576 public void <B>setColumns</B>(java.lang.String[] columns)</PRE>
\r
578 <DD>Set columns of ListFeed
\r
581 <DT><B>Parameters:</B><DD><CODE>columns</CODE> - </DL>
\r
586 <A NAME="getEntry()"><!-- --></A><H3>
\r
589 public <A HREF="../../com/pras/sp/Entry.html" title="class in com.pras.sp">Entry</A> <B>getEntry</B>()</PRE>
\r
591 <DD>Get Entry instance for this WorkSheet.
592 Entry contains low level Feed Details
\r
596 <DT><B>Returns:</B><DD></DL>
\r
601 <A NAME="setEntry(com.pras.sp.Entry)"><!-- --></A><H3>
\r
604 public void <B>setEntry</B>(<A HREF="../../com/pras/sp/Entry.html" title="class in com.pras.sp">Entry</A> entry)</PRE>
\r
606 <DD>Set Feed Entry instance
\r
609 <DT><B>Parameters:</B><DD><CODE>entry</CODE> - </DL>
\r
614 <A NAME="getData(boolean)"><!-- --></A><H3>
\r
617 public java.util.ArrayList<<A HREF="../../com/pras/WorkSheetRow.html" title="class in com.pras">WorkSheetRow</A>> <B>getData</B>(boolean isCachedData)</PRE>
\r
619 <DD>Get all data of this WorkSheet (List based Feed)
\r
622 <DT><B>Parameters:</B><DD><CODE>isCachedData</CODE> - Do you want to read cached data or data from Server
\r
623 <DT><B>Returns:</B><DD></DL>
\r
628 <A NAME="getData(boolean, boolean, java.lang.String, java.lang.String)"><!-- --></A><H3>
\r
631 public java.util.ArrayList<<A HREF="../../com/pras/WorkSheetRow.html" title="class in com.pras">WorkSheetRow</A>> <B>getData</B>(boolean isCachedData,
\r
632 boolean doReverse,
\r
633 java.lang.String sq,
\r
634 java.lang.String orderBy)</PRE>
\r
636 <DD>List based Feed for a particular Work Sheet. Use this method if you want to retrieve data entered
637 through Web GUI and also through Table records.
\r
640 <DT><B>Parameters:</B><DD><CODE>isCachedData</CODE> - Do you want to read cached data or data from Server<DD><CODE>doReverse</CODE> - Do you need data in reverse order ?<DD><CODE>sq</CODE> - <a href="http://code.google.com/apis/spreadsheets/data/3.0/developers_guide.html#SendingStructuredRowQueries">Structured Query</a>. If you don't need this, set to <b>null</b>. (Make sure that column name is in lower case).<DD><CODE>orderBy</CODE> - If you don't need this, set to <b>null</b>. (Make sure that column name is in lower case).
\r
641 <DT><B>Returns:</B><DD></DL>
\r
646 <A NAME="addListRow(java.util.HashMap)"><!-- --></A><H3>
\r
649 public <A HREF="../../com/pras/WorkSheetRow.html" title="class in com.pras">WorkSheetRow</A> <B>addListRow</B>(java.util.HashMap<java.lang.String,java.lang.String> records)</PRE>
\r
651 <DD>Add List Feed row. One row at a time.
655 <DT><B>Parameters:</B><DD><CODE>records</CODE> - </DL>
\r
660 <A NAME="deleteListRow(java.lang.String, com.pras.WorkSheetRow)"><!-- --></A><H3>
\r
663 public void <B>deleteListRow</B>(java.lang.String key,
\r
664 <A HREF="../../com/pras/WorkSheetRow.html" title="class in com.pras">WorkSheetRow</A> r)</PRE>
\r
666 <DD>Delete List Row
\r
669 <DT><B>Parameters:</B><DD><CODE>r</CODE> - WorkSheetRow which need to be deleted</DL>
\r
674 <A NAME="updateListRow(java.lang.String, com.pras.WorkSheetRow, java.util.HashMap)"><!-- --></A><H3>
\r
677 public <A HREF="../../com/pras/WorkSheetRow.html" title="class in com.pras">WorkSheetRow</A> <B>updateListRow</B>(java.lang.String key,
\r
678 <A HREF="../../com/pras/WorkSheetRow.html" title="class in com.pras">WorkSheetRow</A> r,
\r
679 java.util.HashMap<java.lang.String,java.lang.String> records)</PRE>
\r
681 <DD>Update List row
\r
684 <DT><B>Parameters:</B><DD><CODE>r</CODE> - WorkSheetRow to be updated<DD><CODE>records</CODE> - new records
\r
685 <DT><B>Returns:</B><DD></DL>
\r
690 <A NAME="addRecord(java.lang.String, java.util.HashMap)"><!-- --></A><H3>
\r
693 public void <B>addRecord</B>(java.lang.String key,
\r
694 java.util.HashMap<java.lang.String,java.lang.String> records)</PRE>
\r
696 <DD>Add record into WorkSheet. This WorkSheet need to have associated Table.
698 Use SpreadSheet.addWorkSheet()
702 All data entered through Web Interface will be ignored.
\r
705 <DT><B>Parameters:</B><DD><CODE>key</CODE> - Key of SpreadSheet<DD><CODE>records</CODE> - Record to be added ([col_name],[value])</DL>
\r
710 <A NAME="getRecords(java.lang.String)"><!-- --></A><H3>
\r
713 public java.util.ArrayList<<A HREF="../../com/pras/table/Record.html" title="class in com.pras.table">Record</A>> <B>getRecords</B>(java.lang.String key)</PRE>
\r
715 <DD>Get data stored in this WorkSheet
\r
718 <DT><B>Parameters:</B><DD><CODE>key</CODE> - SpreadSheet Key
\r
719 <DT><B>Returns:</B><DD></DL>
\r
724 <A NAME="getRecords(java.lang.String, java.lang.String)"><!-- --></A><H3>
\r
727 public java.util.ArrayList<<A HREF="../../com/pras/table/Record.html" title="class in com.pras.table">Record</A>> <B>getRecords</B>(java.lang.String key,
\r
728 java.lang.String sq)</PRE>
\r
731 <DT><B>Parameters:</B><DD><CODE>key</CODE> - SpreadSheet Key<DD><CODE>sq</CODE> - <a href="http://code.google.com/apis/spreadsheets/data/3.0/developers_guide.html#SendingStructuredRowQueries">Structured Query</a>
\r
732 <DT><B>Returns:</B><DD></DL>
\r
737 <A NAME="getRecords(java.lang.String, boolean, java.lang.String, java.lang.String)"><!-- --></A><H3>
\r
740 public java.util.ArrayList<<A HREF="../../com/pras/table/Record.html" title="class in com.pras.table">Record</A>> <B>getRecords</B>(java.lang.String key,
\r
741 boolean doReverse,
\r
742 java.lang.String sq,
\r
743 java.lang.String orderBy)</PRE>
\r
745 <DD>Get data stored in this WorkSheet. Retrieved data will be in a HashMap-
748 It supports following conditional Query- <br/>
749 <b>Structured Query:</b> you can define conditional statements like in SQL e.g. <col_name> != <value><br/>
750 <b>Order By:</b> Order by a given column name or position <br/>
751 <b>Reverse:</b> Record retrived in reverse order (last row 1st)<br/>
755 It will retrieve records present in the Table. Tables can't be accessed by the Web UI.
757 So, any data inserted by Web UI will be discarded.
761 <DT><B>Parameters:</B><DD><CODE>key</CODE> - SpreadSheet Key<DD><CODE>doReverse</CODE> - Display data in reverse order (last row first)<DD><CODE>sq</CODE> - <a href="http://code.google.com/apis/spreadsheets/data/3.0/developers_guide.html#SendingStructuredRowQueries">Structured Query</a><DD><CODE>orderBy</CODE> - <a href="http://code.google.com/apis/spreadsheets/data/3.0/developers_guide.html#SendingStructuredRowQueries">Order By</a>
\r
762 <DT><B>Returns:</B><DD></DL>
\r
767 <A NAME="getRecords()"><!-- --></A><H3>
\r
770 public java.util.ArrayList<<A HREF="../../com/pras/table/Record.html" title="class in com.pras.table">Record</A>> <B>getRecords</B>()</PRE>
\r
772 <DD>Get Cached Data (previously retrieved from server)
\r
776 <DT><B>Returns:</B><DD></DL>
\r
781 <A NAME="updateRecord(com.pras.table.Record)"><!-- --></A><H3>
\r
784 public void <B>updateRecord</B>(<A HREF="../../com/pras/table/Record.html" title="class in com.pras.table">Record</A> record)</PRE>
\r
786 <DD>Record instance you want to Update
787 Keep only those data which you want to update for this record
\r
790 <DT><B>Parameters:</B><DD><CODE>record</CODE> - Record to be updated</DL>
\r
795 <A NAME="deleteRecord(com.pras.table.Record)"><!-- --></A><H3>
\r
798 public void <B>deleteRecord</B>(<A HREF="../../com/pras/table/Record.html" title="class in com.pras.table">Record</A> record)</PRE>
\r
800 <DD>Delete a Record
\r
803 <DT><B>Parameters:</B><DD><CODE>record</CODE> - Record to be deleted</DL>
\r
808 <A NAME="delete()"><!-- --></A><H3>
\r
811 public void <B>delete</B>()</PRE>
\r
813 <DD>Delete this WorkSheet. It will also delete its associated Table.
814 There is no separate method for deleting a Table
\r
820 <!-- ========= END OF CLASS DATA ========= -->
\r
824 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
825 <A NAME="navbar_bottom"><!-- --></A>
\r
826 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
\r
827 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
829 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
830 <A NAME="navbar_bottom_firstrow"><!-- --></A>
\r
831 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
832 <TR ALIGN="center" VALIGN="top">
\r
833 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
834 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
835 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
836 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/WorkSheet.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
837 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
838 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
839 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
840 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
844 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
850 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
851 <A HREF="../../com/pras/SpreadSheetFactory.html" title="class in com.pras"><B>PREV CLASS</B></A>
\r
852 <A HREF="../../com/pras/WorkSheetCell.html" title="class in com.pras"><B>NEXT CLASS</B></A></FONT></TD>
\r
853 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
854 <A HREF="../../index.html?com/pras/WorkSheet.html" target="_top"><B>FRAMES</B></A>
\r
855 <A HREF="WorkSheet.html" target="_top"><B>NO FRAMES</B></A>
\r
856 <SCRIPT type="text/javascript">
\r
859 document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
864 <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
\r
871 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
872 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
873 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
874 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
877 <A NAME="skip-navbar_bottom"></A>
\r
878 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r