-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
-<!--NewPage-->\r
-<HTML>\r
-<HEAD>\r
-<!-- Generated by javadoc (build 1.5.0_22) on Tue May 10 10:28:01 IST 2011 -->\r
-<TITLE>\r
-WorkSheet\r
-</TITLE>\r
-\r
-<META NAME="keywords" CONTENT="com.pras.WorkSheet class">\r
-\r
-<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">\r
-\r
-<SCRIPT type="text/javascript">\r
-function windowTitle()\r
-{\r
- parent.document.title="WorkSheet";\r
-}\r
-</SCRIPT>\r
-<NOSCRIPT>\r
-</NOSCRIPT>\r
-\r
-</HEAD>\r
-\r
-<BODY BGCOLOR="white" onload="windowTitle();">\r
-\r
-\r
-<!-- ========= START OF TOP NAVBAR ======= -->\r
-<A NAME="navbar_top"><!-- --></A>\r
-<A HREF="#skip-navbar_top" title="Skip navigation links"></A>\r
-<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
-<TR>\r
-<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
-<A NAME="navbar_top_firstrow"><!-- --></A>\r
-<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
- <TR ALIGN="center" VALIGN="top">\r
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>\r
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>\r
- <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>\r
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/WorkSheet.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>\r
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>\r
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>\r
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>\r
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>\r
- </TR>\r
-</TABLE>\r
-</TD>\r
-<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
-</EM>\r
-</TD>\r
-</TR>\r
-\r
-<TR>\r
-<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
- <A HREF="../../com/pras/SpreadSheetFactory.html" title="class in com.pras"><B>PREV CLASS</B></A> \r
- <A HREF="../../com/pras/WorkSheetCell.html" title="class in com.pras"><B>NEXT CLASS</B></A></FONT></TD>\r
-<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
- <A HREF="../../index.html?com/pras/WorkSheet.html" target="_top"><B>FRAMES</B></A> \r
- <A HREF="WorkSheet.html" target="_top"><B>NO FRAMES</B></A> \r
- <SCRIPT type="text/javascript">\r
- <!--\r
- if(window==top) {\r
- document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
- }\r
- //-->\r
-</SCRIPT>\r
-<NOSCRIPT>\r
- <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
-</NOSCRIPT>\r
-\r
-\r
-</FONT></TD>\r
-</TR>\r
-<TR>\r
-<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
- SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>\r
-<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
-DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>\r
-</TR>\r
-</TABLE>\r
-<A NAME="skip-navbar_top"></A>\r
-<!-- ========= END OF TOP NAVBAR ========= -->\r
-\r
-<HR>\r
-<!-- ======== START OF CLASS DATA ======== -->\r
-<H2>\r
-<FONT SIZE="-1">\r
-com.pras</FONT>\r
-<BR>\r
-Class WorkSheet</H2>\r
-<PRE>\r
-java.lang.Object\r
- <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>com.pras.WorkSheet</B>\r
-</PRE>\r
-<HR>\r
-<DL>\r
-<DT><PRE>public class <B>WorkSheet</B><DT>extends java.lang.Object</DL>\r
-</PRE>\r
-\r
-<P>\r
-This class represents an WorkSheet and utility methods to manage WorkSheet data.
- WorkSheets will manage (Add/Edit/Delete) data in Tables. It also supports <u>List
- based Feed</u>, but only to <b>retrieve data</b>. At present it doesn't provide any method to Add/Edit/Delete
- data in List based Feed.
- </br>
- </br>
- <b><a href="http://code.google.com/apis/spreadsheets/data/3.0/developers_guide.html#TableFeeds">Table Feed</a></b>
- </br>
- To Add/Edit/Delete Data, you need to use addRecord(), updateRecord() and deleteRecord(). It
- internally stores data in a single Table.
- </br>
- <b>Note:</b> <u>Table Feed will ignore data entered through Web UI.</u>
- So, if you want all data records irrespective of from where those are inserted/updated, you should use List Feed.
-
- </br>
- </br>
- <b><a href="http://code.google.com/apis/spreadsheets/data/3.0/developers_guide.html#ListFeeds">List Feed</a></b>
- </br>
- To Retrieve data using List based Feed, use getData() method.\r
-<P>\r
-\r
-<P>\r
-<DL>\r
-<DT><B>Author:</B></DT>\r
- <DD>Prasanta Paul</DD>\r
-</DL>\r
-<HR>\r
-\r
-<P>\r
-\r
-<!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
-\r
-<A NAME="constructor_summary"><!-- --></A>\r
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
-<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
-<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
-<B>Constructor Summary</B></FONT></TH>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#WorkSheet()">WorkSheet</A></B>()</CODE>\r
-\r
-<BR>\r
- </TD>\r
-</TR>\r
-</TABLE>\r
- \r
-<!-- ========== METHOD SUMMARY =========== -->\r
-\r
-<A NAME="method_summary"><!-- --></A>\r
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
-<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
-<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
-<B>Method Summary</B></FONT></TH>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> <A HREF="../../com/pras/WorkSheetRow.html" title="class in com.pras">WorkSheetRow</A></CODE></FONT></TD>\r
-<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
-\r
-<BR>\r
- Add List Feed row.</TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> void</CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#addRecord(java.lang.String, java.util.HashMap)">addRecord</A></B>(java.lang.String key,\r
- java.util.HashMap<java.lang.String,java.lang.String> records)</CODE>\r
-\r
-<BR>\r
- Add record into WorkSheet.</TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> void</CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#delete()">delete</A></B>()</CODE>\r
-\r
-<BR>\r
- Delete this WorkSheet.</TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> void</CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#deleteListRow(java.lang.String, com.pras.WorkSheetRow)">deleteListRow</A></B>(java.lang.String key,\r
- <A HREF="../../com/pras/WorkSheetRow.html" title="class in com.pras">WorkSheetRow</A> r)</CODE>\r
-\r
-<BR>\r
- Delete List Row</TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> void</CODE></FONT></TD>\r
-<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
-\r
-<BR>\r
- Delete a Record</TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> int</CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#getColCount()">getColCount</A></B>()</CODE>\r
-\r
-<BR>\r
- Get column count of this WorkSheet</TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> java.lang.String[]</CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#getColumns()">getColumns</A></B>()</CODE>\r
-\r
-<BR>\r
- Get columns of the WorkSheet.</TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> java.util.ArrayList<<A HREF="../../com/pras/WorkSheetRow.html" title="class in com.pras">WorkSheetRow</A>></CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#getData(boolean)">getData</A></B>(boolean isCachedData)</CODE>\r
-\r
-<BR>\r
- Get all data of this WorkSheet (List based Feed)</TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> java.util.ArrayList<<A HREF="../../com/pras/WorkSheetRow.html" title="class in com.pras">WorkSheetRow</A>></CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#getData(boolean, boolean, java.lang.String, java.lang.String)">getData</A></B>(boolean isCachedData,\r
- boolean doReverse,\r
- java.lang.String sq,\r
- java.lang.String orderBy)</CODE>\r
-\r
-<BR>\r
- List based Feed for a particular Work Sheet.</TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> <A HREF="../../com/pras/sp/Entry.html" title="class in com.pras.sp">Entry</A></CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#getEntry()">getEntry</A></B>()</CODE>\r
-\r
-<BR>\r
- Get Entry instance for this WorkSheet.</TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> java.util.ArrayList<<A HREF="../../com/pras/table/Record.html" title="class in com.pras.table">Record</A>></CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#getRecords()">getRecords</A></B>()</CODE>\r
-\r
-<BR>\r
- Get Cached Data (previously retrieved from server)</TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> java.util.ArrayList<<A HREF="../../com/pras/table/Record.html" title="class in com.pras.table">Record</A>></CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#getRecords(java.lang.String)">getRecords</A></B>(java.lang.String key)</CODE>\r
-\r
-<BR>\r
- Get data stored in this WorkSheet</TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> java.util.ArrayList<<A HREF="../../com/pras/table/Record.html" title="class in com.pras.table">Record</A>></CODE></FONT></TD>\r
-<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
- boolean doReverse,\r
- java.lang.String sq,\r
- java.lang.String orderBy)</CODE>\r
-\r
-<BR>\r
- Get data stored in this WorkSheet.</TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> java.util.ArrayList<<A HREF="../../com/pras/table/Record.html" title="class in com.pras.table">Record</A>></CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#getRecords(java.lang.String, java.lang.String)">getRecords</A></B>(java.lang.String key,\r
- java.lang.String sq)</CODE>\r
-\r
-<BR>\r
- </TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> int</CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#getRowCount()">getRowCount</A></B>()</CODE>\r
-\r
-<BR>\r
- Get row count of this WorkSheet</TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> java.lang.String</CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#getTitle()">getTitle</A></B>()</CODE>\r
-\r
-<BR>\r
- Get WorkSheet Title</TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> java.lang.String</CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#getWorkSheetID()">getWorkSheetID</A></B>()</CODE>\r
-\r
-<BR>\r
- Get WorkSheet ID</TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> java.lang.String</CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#getWorkSheetURL()">getWorkSheetURL</A></B>()</CODE>\r
-\r
-<BR>\r
- Get WorkSheetURL</TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> void</CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#setColCount(int)">setColCount</A></B>(int colCount)</CODE>\r
-\r
-<BR>\r
- Set column count of this WorkSheet</TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> void</CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#setColumns(java.lang.String[])">setColumns</A></B>(java.lang.String[] columns)</CODE>\r
-\r
-<BR>\r
- Set columns of ListFeed</TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> void</CODE></FONT></TD>\r
-<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
-\r
-<BR>\r
- Set Feed Entry instance</TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> void</CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#setRowCount(int)">setRowCount</A></B>(int rowCount)</CODE>\r
-\r
-<BR>\r
- Set row count of this WorkSheet</TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> void</CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#setTitle(java.lang.String)">setTitle</A></B>(java.lang.String title)</CODE>\r
-\r
-<BR>\r
- Set WorkSheet Title</TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> void</CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#setWorkSheetID(java.lang.String)">setWorkSheetID</A></B>(java.lang.String workSheetID)</CODE>\r
-\r
-<BR>\r
- Set WorkSheet ID</TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> void</CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../com/pras/WorkSheet.html#setWorkSheetURL(java.lang.String)">setWorkSheetURL</A></B>(java.lang.String workSheetURL)</CODE>\r
-\r
-<BR>\r
- Set WorkSheet</TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> <A HREF="../../com/pras/WorkSheetRow.html" title="class in com.pras">WorkSheetRow</A></CODE></FONT></TD>\r
-<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
- <A HREF="../../com/pras/WorkSheetRow.html" title="class in com.pras">WorkSheetRow</A> r,\r
- java.util.HashMap<java.lang.String,java.lang.String> records)</CODE>\r
-\r
-<BR>\r
- Update List row</TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> void</CODE></FONT></TD>\r
-<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
-\r
-<BR>\r
- Record instance you want to Update
- Keep only those data which you want to update for this record</TD>\r
-</TR>\r
-</TABLE>\r
- <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
-<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
-<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
-</TR>\r
-</TABLE>\r
- \r
-<P>\r
-\r
-<!-- ========= CONSTRUCTOR DETAIL ======== -->\r
-\r
-<A NAME="constructor_detail"><!-- --></A>\r
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
-<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
-<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
-<B>Constructor Detail</B></FONT></TH>\r
-</TR>\r
-</TABLE>\r
-\r
-<A NAME="WorkSheet()"><!-- --></A><H3>\r
-WorkSheet</H3>\r
-<PRE>\r
-public <B>WorkSheet</B>()</PRE>\r
-<DL>\r
-</DL>\r
-\r
-<!-- ============ METHOD DETAIL ========== -->\r
-\r
-<A NAME="method_detail"><!-- --></A>\r
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
-<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
-<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
-<B>Method Detail</B></FONT></TH>\r
-</TR>\r
-</TABLE>\r
-\r
-<A NAME="getWorkSheetID()"><!-- --></A><H3>\r
-getWorkSheetID</H3>\r
-<PRE>\r
-public java.lang.String <B>getWorkSheetID</B>()</PRE>\r
-<DL>\r
-<DD>Get WorkSheet ID\r
-<P>\r
-<DD><DL>\r
-\r
-<DT><B>Returns:</B><DD></DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="setWorkSheetID(java.lang.String)"><!-- --></A><H3>\r
-setWorkSheetID</H3>\r
-<PRE>\r
-public void <B>setWorkSheetID</B>(java.lang.String workSheetID)</PRE>\r
-<DL>\r
-<DD>Set WorkSheet ID\r
-<P>\r
-<DD><DL>\r
-<DT><B>Parameters:</B><DD><CODE>workSheetID</CODE> - </DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="getWorkSheetURL()"><!-- --></A><H3>\r
-getWorkSheetURL</H3>\r
-<PRE>\r
-public java.lang.String <B>getWorkSheetURL</B>()</PRE>\r
-<DL>\r
-<DD>Get WorkSheetURL\r
-<P>\r
-<DD><DL>\r
-\r
-<DT><B>Returns:</B><DD></DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="setWorkSheetURL(java.lang.String)"><!-- --></A><H3>\r
-setWorkSheetURL</H3>\r
-<PRE>\r
-public void <B>setWorkSheetURL</B>(java.lang.String workSheetURL)</PRE>\r
-<DL>\r
-<DD>Set WorkSheet\r
-<P>\r
-<DD><DL>\r
-<DT><B>Parameters:</B><DD><CODE>workSheetURL</CODE> - </DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="getTitle()"><!-- --></A><H3>\r
-getTitle</H3>\r
-<PRE>\r
-public java.lang.String <B>getTitle</B>()</PRE>\r
-<DL>\r
-<DD>Get WorkSheet Title\r
-<P>\r
-<DD><DL>\r
-\r
-<DT><B>Returns:</B><DD></DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="setTitle(java.lang.String)"><!-- --></A><H3>\r
-setTitle</H3>\r
-<PRE>\r
-public void <B>setTitle</B>(java.lang.String title)</PRE>\r
-<DL>\r
-<DD>Set WorkSheet Title\r
-<P>\r
-<DD><DL>\r
-<DT><B>Parameters:</B><DD><CODE>title</CODE> - </DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="getColCount()"><!-- --></A><H3>\r
-getColCount</H3>\r
-<PRE>\r
-public int <B>getColCount</B>()</PRE>\r
-<DL>\r
-<DD>Get column count of this WorkSheet\r
-<P>\r
-<DD><DL>\r
-\r
-<DT><B>Returns:</B><DD></DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="setColCount(int)"><!-- --></A><H3>\r
-setColCount</H3>\r
-<PRE>\r
-public void <B>setColCount</B>(int colCount)</PRE>\r
-<DL>\r
-<DD>Set column count of this WorkSheet\r
-<P>\r
-<DD><DL>\r
-<DT><B>Parameters:</B><DD><CODE>colCount</CODE> - </DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="getRowCount()"><!-- --></A><H3>\r
-getRowCount</H3>\r
-<PRE>\r
-public int <B>getRowCount</B>()</PRE>\r
-<DL>\r
-<DD>Get row count of this WorkSheet\r
-<P>\r
-<DD><DL>\r
-\r
-<DT><B>Returns:</B><DD></DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="setRowCount(int)"><!-- --></A><H3>\r
-setRowCount</H3>\r
-<PRE>\r
-public void <B>setRowCount</B>(int rowCount)</PRE>\r
-<DL>\r
-<DD>Set row count of this WorkSheet\r
-<P>\r
-<DD><DL>\r
-<DT><B>Parameters:</B><DD><CODE>rowCount</CODE> - </DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="getColumns()"><!-- --></A><H3>\r
-getColumns</H3>\r
-<PRE>\r
-public java.lang.String[] <B>getColumns</B>()</PRE>\r
-<DL>\r
-<DD>Get columns of the WorkSheet. It will return columns of associated table, otherwise
- columns of List Feed i.e. content of Header row of ListFeed\r
-<P>\r
-<DD><DL>\r
-\r
-<DT><B>Returns:</B><DD></DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="setColumns(java.lang.String[])"><!-- --></A><H3>\r
-setColumns</H3>\r
-<PRE>\r
-public void <B>setColumns</B>(java.lang.String[] columns)</PRE>\r
-<DL>\r
-<DD>Set columns of ListFeed\r
-<P>\r
-<DD><DL>\r
-<DT><B>Parameters:</B><DD><CODE>columns</CODE> - </DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="getEntry()"><!-- --></A><H3>\r
-getEntry</H3>\r
-<PRE>\r
-public <A HREF="../../com/pras/sp/Entry.html" title="class in com.pras.sp">Entry</A> <B>getEntry</B>()</PRE>\r
-<DL>\r
-<DD>Get Entry instance for this WorkSheet.
- Entry contains low level Feed Details\r
-<P>\r
-<DD><DL>\r
-\r
-<DT><B>Returns:</B><DD></DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="setEntry(com.pras.sp.Entry)"><!-- --></A><H3>\r
-setEntry</H3>\r
-<PRE>\r
-public void <B>setEntry</B>(<A HREF="../../com/pras/sp/Entry.html" title="class in com.pras.sp">Entry</A> entry)</PRE>\r
-<DL>\r
-<DD>Set Feed Entry instance\r
-<P>\r
-<DD><DL>\r
-<DT><B>Parameters:</B><DD><CODE>entry</CODE> - </DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="getData(boolean)"><!-- --></A><H3>\r
-getData</H3>\r
-<PRE>\r
-public java.util.ArrayList<<A HREF="../../com/pras/WorkSheetRow.html" title="class in com.pras">WorkSheetRow</A>> <B>getData</B>(boolean isCachedData)</PRE>\r
-<DL>\r
-<DD>Get all data of this WorkSheet (List based Feed)\r
-<P>\r
-<DD><DL>\r
-<DT><B>Parameters:</B><DD><CODE>isCachedData</CODE> - Do you want to read cached data or data from Server\r
-<DT><B>Returns:</B><DD></DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="getData(boolean, boolean, java.lang.String, java.lang.String)"><!-- --></A><H3>\r
-getData</H3>\r
-<PRE>\r
-public java.util.ArrayList<<A HREF="../../com/pras/WorkSheetRow.html" title="class in com.pras">WorkSheetRow</A>> <B>getData</B>(boolean isCachedData,\r
- boolean doReverse,\r
- java.lang.String sq,\r
- java.lang.String orderBy)</PRE>\r
-<DL>\r
-<DD>List based Feed for a particular Work Sheet. Use this method if you want to retrieve data entered
- through Web GUI and also through Table records.\r
-<P>\r
-<DD><DL>\r
-<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
-<DT><B>Returns:</B><DD></DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="addListRow(java.util.HashMap)"><!-- --></A><H3>\r
-addListRow</H3>\r
-<PRE>\r
-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
-<DL>\r
-<DD>Add List Feed row. One row at a time.
- TODO: need to test\r
-<P>\r
-<DD><DL>\r
-<DT><B>Parameters:</B><DD><CODE>records</CODE> - </DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="deleteListRow(java.lang.String, com.pras.WorkSheetRow)"><!-- --></A><H3>\r
-deleteListRow</H3>\r
-<PRE>\r
-public void <B>deleteListRow</B>(java.lang.String key,\r
- <A HREF="../../com/pras/WorkSheetRow.html" title="class in com.pras">WorkSheetRow</A> r)</PRE>\r
-<DL>\r
-<DD>Delete List Row\r
-<P>\r
-<DD><DL>\r
-<DT><B>Parameters:</B><DD><CODE>r</CODE> - WorkSheetRow which need to be deleted</DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="updateListRow(java.lang.String, com.pras.WorkSheetRow, java.util.HashMap)"><!-- --></A><H3>\r
-updateListRow</H3>\r
-<PRE>\r
-public <A HREF="../../com/pras/WorkSheetRow.html" title="class in com.pras">WorkSheetRow</A> <B>updateListRow</B>(java.lang.String key,\r
- <A HREF="../../com/pras/WorkSheetRow.html" title="class in com.pras">WorkSheetRow</A> r,\r
- java.util.HashMap<java.lang.String,java.lang.String> records)</PRE>\r
-<DL>\r
-<DD>Update List row\r
-<P>\r
-<DD><DL>\r
-<DT><B>Parameters:</B><DD><CODE>r</CODE> - WorkSheetRow to be updated<DD><CODE>records</CODE> - new records\r
-<DT><B>Returns:</B><DD></DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="addRecord(java.lang.String, java.util.HashMap)"><!-- --></A><H3>\r
-addRecord</H3>\r
-<PRE>\r
-public void <B>addRecord</B>(java.lang.String key,\r
- java.util.HashMap<java.lang.String,java.lang.String> records)</PRE>\r
-<DL>\r
-<DD>Add record into WorkSheet. This WorkSheet need to have associated Table.
-
- Use SpreadSheet.addWorkSheet()
- </br>
- <b>Note:</b>
- </br>
- All data entered through Web Interface will be ignored.\r
-<P>\r
-<DD><DL>\r
-<DT><B>Parameters:</B><DD><CODE>key</CODE> - Key of SpreadSheet<DD><CODE>records</CODE> - Record to be added ([col_name],[value])</DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="getRecords(java.lang.String)"><!-- --></A><H3>\r
-getRecords</H3>\r
-<PRE>\r
-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
-<DL>\r
-<DD>Get data stored in this WorkSheet\r
-<P>\r
-<DD><DL>\r
-<DT><B>Parameters:</B><DD><CODE>key</CODE> - SpreadSheet Key\r
-<DT><B>Returns:</B><DD></DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="getRecords(java.lang.String, java.lang.String)"><!-- --></A><H3>\r
-getRecords</H3>\r
-<PRE>\r
-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
- java.lang.String sq)</PRE>\r
-<DL>\r
-<DD><DL>\r
-<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
-<DT><B>Returns:</B><DD></DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="getRecords(java.lang.String, boolean, java.lang.String, java.lang.String)"><!-- --></A><H3>\r
-getRecords</H3>\r
-<PRE>\r
-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
- boolean doReverse,\r
- java.lang.String sq,\r
- java.lang.String orderBy)</PRE>\r
-<DL>\r
-<DD>Get data stored in this WorkSheet. Retrieved data will be in a HashMap-
- <COL_NAME>,<VALUE>
- <br/>
- It supports following conditional Query- <br/>
- <b>Structured Query:</b> you can define conditional statements like in SQL e.g. <col_name> != <value><br/>
- <b>Order By:</b> Order by a given column name or position <br/>
- <b>Reverse:</b> Record retrived in reverse order (last row 1st)<br/>
- <br/>
- <b>NOTE:</b>
- <br/>
- It will retrieve records present in the Table. Tables can't be accessed by the Web UI.
- <br/>
- So, any data inserted by Web UI will be discarded.
- <br/>\r
-<P>\r
-<DD><DL>\r
-<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
-<DT><B>Returns:</B><DD></DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="getRecords()"><!-- --></A><H3>\r
-getRecords</H3>\r
-<PRE>\r
-public java.util.ArrayList<<A HREF="../../com/pras/table/Record.html" title="class in com.pras.table">Record</A>> <B>getRecords</B>()</PRE>\r
-<DL>\r
-<DD>Get Cached Data (previously retrieved from server)\r
-<P>\r
-<DD><DL>\r
-\r
-<DT><B>Returns:</B><DD></DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="updateRecord(com.pras.table.Record)"><!-- --></A><H3>\r
-updateRecord</H3>\r
-<PRE>\r
-public void <B>updateRecord</B>(<A HREF="../../com/pras/table/Record.html" title="class in com.pras.table">Record</A> record)</PRE>\r
-<DL>\r
-<DD>Record instance you want to Update
- Keep only those data which you want to update for this record\r
-<P>\r
-<DD><DL>\r
-<DT><B>Parameters:</B><DD><CODE>record</CODE> - Record to be updated</DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="deleteRecord(com.pras.table.Record)"><!-- --></A><H3>\r
-deleteRecord</H3>\r
-<PRE>\r
-public void <B>deleteRecord</B>(<A HREF="../../com/pras/table/Record.html" title="class in com.pras.table">Record</A> record)</PRE>\r
-<DL>\r
-<DD>Delete a Record\r
-<P>\r
-<DD><DL>\r
-<DT><B>Parameters:</B><DD><CODE>record</CODE> - Record to be deleted</DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="delete()"><!-- --></A><H3>\r
-delete</H3>\r
-<PRE>\r
-public void <B>delete</B>()</PRE>\r
-<DL>\r
-<DD>Delete this WorkSheet. It will also delete its associated Table.
- There is no separate method for deleting a Table\r
-<P>\r
-<DD><DL>\r
-</DL>\r
-</DD>\r
-</DL>\r
-<!-- ========= END OF CLASS DATA ========= -->\r
-<HR>\r
-\r
-\r
-<!-- ======= START OF BOTTOM NAVBAR ====== -->\r
-<A NAME="navbar_bottom"><!-- --></A>\r
-<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
-<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
-<TR>\r
-<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
-<A NAME="navbar_bottom_firstrow"><!-- --></A>\r
-<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
- <TR ALIGN="center" VALIGN="top">\r
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>\r
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>\r
- <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>\r
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/WorkSheet.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>\r
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>\r
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>\r
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>\r
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>\r
- </TR>\r
-</TABLE>\r
-</TD>\r
-<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
-</EM>\r
-</TD>\r
-</TR>\r
-\r
-<TR>\r
-<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
- <A HREF="../../com/pras/SpreadSheetFactory.html" title="class in com.pras"><B>PREV CLASS</B></A> \r
- <A HREF="../../com/pras/WorkSheetCell.html" title="class in com.pras"><B>NEXT CLASS</B></A></FONT></TD>\r
-<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
- <A HREF="../../index.html?com/pras/WorkSheet.html" target="_top"><B>FRAMES</B></A> \r
- <A HREF="WorkSheet.html" target="_top"><B>NO FRAMES</B></A> \r
- <SCRIPT type="text/javascript">\r
- <!--\r
- if(window==top) {\r
- document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
- }\r
- //-->\r
-</SCRIPT>\r
-<NOSCRIPT>\r
- <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
-</NOSCRIPT>\r
-\r
-\r
-</FONT></TD>\r
-</TR>\r
-<TR>\r
-<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
- SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>\r
-<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
-DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>\r
-</TR>\r
-</TABLE>\r
-<A NAME="skip-navbar_bottom"></A>\r
-<!-- ======== END OF BOTTOM NAVBAR ======= -->\r
-\r
-<HR>\r
-\r
-</BODY>\r
-</HTML>\r