public class

SpreadsheetEntry

extends BaseEntry<E extends BaseEntry>
java.lang.Object
   ↳ com.google.gdata.data.AbstractExtension
     ↳ com.google.gdata.data.ExtensionPoint
       ↳ com.google.gdata.data.BaseEntry<E extends com.google.gdata.data.BaseEntry>
         ↳ com.google.gdata.data.spreadsheet.SpreadsheetEntry

Class Overview

One spreadsheet, when listing all spreadsheets you have access to.

Summary

Constants
String KIND Kind category term used to label the entries that contains spreadsheet data.
Fields
public static final Category CATEGORY Category used to label entries that contain spreadsheet data.
[Expand]
Inherited Fields
From class com.google.gdata.data.BaseEntry
From class com.google.gdata.data.ExtensionPoint
From class com.google.gdata.data.AbstractExtension
Public Constructors
SpreadsheetEntry()
Constructs a new uninitialized entry, to be populated by the GData parsers.
SpreadsheetEntry(BaseEntry sourceEntry)
Constructs a new entry by doing a shallow copy from another BaseEntry instance.
Public Methods
void declareExtensions(ExtensionProfile extProfile)
Declares extensions (although Spreadsheet Kind currently has none).
WorksheetEntry getDefaultWorksheet()
Gets the first worksheet in the spreadsheet.
String getKey()
Gets the non-user-friendly key that is used to access the spreadsheet.
Link getSpreadsheetLink()
Gets the link with which you can open up the spreadsheet in a Web browser, the full Google Spreadsheets user interface.
URL getWorksheetFeedUrl()
Gets the URL for this spreadsheet's worksheets feed.
List<WorksheetEntry> getWorksheets()
Gets all worksheet entries that are part of this spreadsheet.
[Expand]
Inherited Methods
From class com.google.gdata.data.BaseEntry
From class com.google.gdata.data.ExtensionPoint
From class com.google.gdata.data.AbstractExtension
From class java.lang.Object
From interface com.google.gdata.data.Extension
From interface com.google.gdata.data.IAtom
From interface com.google.gdata.data.IEntry
From interface com.google.gdata.data.Kind.Adaptable
From interface com.google.gdata.data.Kind.Adaptor

Constants

public static final String KIND

Kind category term used to label the entries that contains spreadsheet data.

Constant Value: "http://schemas.google.com/spreadsheets/2006#spreadsheet"

Fields

public static final Category CATEGORY

Category used to label entries that contain spreadsheet data.

Public Constructors

public SpreadsheetEntry ()

Constructs a new uninitialized entry, to be populated by the GData parsers.

public SpreadsheetEntry (BaseEntry sourceEntry)

Constructs a new entry by doing a shallow copy from another BaseEntry instance.

Parameters
sourceEntry

Public Methods

public void declareExtensions (ExtensionProfile extProfile)

Declares extensions (although Spreadsheet Kind currently has none).

Parameters
extProfile The ExtensionProfile to initialize.

public WorksheetEntry getDefaultWorksheet ()

Gets the first worksheet in the spreadsheet. This is very useful if your spreadsheet only has one worksheet.

Returns
  • the first worksheet
Throws
IOException
ServiceException

public String getKey ()

Gets the non-user-friendly key that is used to access the spreadsheet. This is the key that can be used to open the spreadsheet in a Web browser, such as, http://spreadsheets.google.com/ccc?key={key}.

Returns
  • the Google Spreadsheets key, in "o10110101.1010101" format

public Link getSpreadsheetLink ()

Gets the link with which you can open up the spreadsheet in a Web browser, the full Google Spreadsheets user interface.

Returns
  • a link to open up the web browser with

public URL getWorksheetFeedUrl ()

Gets the URL for this spreadsheet's worksheets feed. You can then create a query using this URL to query this worksheet's sheets.

Returns
  • a URL to get a feed of worksheets

public List<WorksheetEntry> getWorksheets ()

Gets all worksheet entries that are part of this spreadsheet. You must be online for this to work.

Returns
  • the list of worksheet entries
Throws
IOException
ServiceException