public class

WorksheetEntry

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.WorksheetEntry

Class Overview

One worksheet, when listing all worksheets within a spreadsheet. For instance, this might list Sheet1, Sheet2, Sheet3, etc.

Summary

Constants
String	KIND	Kind category term used to label the entries that contains worksheet data.

Fields
public static final Category	CATEGORY	Category used to label entries that contain worksheet 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
	WorksheetEntry() Constructs a new uninitialized entry to be populated by the GData parsers.
	WorksheetEntry(int rowCount, int colCount) Constructs a new entry with the given row count and column count
	WorksheetEntry(BaseEntry sourceEntry) Constructs a new entry by doing a shallow copy from another BaseEntry instance.

Public Methods
void	declareExtensions(ExtensionProfile extProfile) Declares any extensions.
URL	getCellFeedUrl() Gets the URL for this worksheet's cells feed.
int	getColCount() Gets the total number of columns.
URL	getListFeedUrl() Gets the URL for this worksheet's list feed.
int	getRowCount() Gets the total number of rows.
void	setColCount(int count) Sets the total number of columns.
void	setRowCount(int count) Sets the total number of rows.

[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

abstract ILink	addLink(String rel, String type, String href) Adds a link with the given rel, type, and href.
abstract List<? extends IPerson>	getAuthors() Returns the list of all authors on this resource.
abstract Set<? extends ICategory>	getCategories() Returns a set of categories on this resource.
abstract String	getEtag() Gets the value of the gd:etag attribute for this resource.
abstract String	getId() Get the unique id for this resource.
abstract String	getKind() Returns the value of the gd:kind attribute for this resource.
abstract ILink	getLink(String rel, String type) Returns a particular atom:link element with the given rel and type, or null if one was not found.
abstract List<? extends ILink>	getLinks() Returns a list of atom:link elements on this resource.
abstract ILink	getSelfLink() Returns the self link for the resource.
abstract ITextConstruct	getTitle() Returns the atom:title element of this resource.
abstract DateTime	getUpdated() Get a `DateTime` instance representing the last time this resource was updated.
abstract String	getVersionId() Version ID.
abstract void	removeLinks(String relToMatch, String typeToMatch) Remove all links that match the given `rel` and `type` values.
abstract void	removeLinks() Removes all links from the this resource.
abstract void	setEtag(String etag) Sets the value of the gd:etag attribute for this resource.
abstract void	setId(String id) Sets the unique id for this resource.
abstract void	setKind(String kind) Sets the value of the gd:kind attribute for this resource.
abstract void	setService(Service s) Sets the service that this resource is being used with.
abstract void	setUpdated(DateTime updated) Sets the last time this resource was updated.
abstract void	setVersionId(String versionId) Sets the versionId.

From interface com.google.gdata.data.IEntry

abstract boolean	getCanEdit() Returns `true` if the entry can be modified by a client.
abstract IContent	getContent() Gets the content of this entry.
abstract ILink	getEditLink() Gets the edit link, which is the link to PUT an updated version of the entry to.
abstract DateTime	getEdited() Get a `DateTime` instance representing the last time this entry was edited.
abstract ILink	getMediaEditLink() Gets the media-edit link, which is the link to PUT an updated version of the media content to.
abstract DateTime	getPublished() Get a `DateTime` instance representing the time that this entry was created.
abstract ILink	getResumableEditMediaLink() Gets the resumable-edit-media link, which is the link to PUT an updated version of the media content to using Resumable Upload IO.
abstract String	getSelectedFields() Returns the set of selected fields for the entry if the entry contains a partial representation or `null` if it is a full representation.
abstract ITextConstruct	getSummary() Returns the atom:summary element of this entry.
abstract void	setCanEdit(boolean canEdit) Sets whether the server allows this entry to be modified by the client.
abstract void	setEdited(DateTime edited) Set the last time this entry was edited using the app:edited element.
abstract void	setPublished(DateTime published) Sets the date of publishing for this entry.
abstract void	setSelectedFields(String fields) Sets the current fields selection for this partial entry.

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 worksheet data.

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

Fields

public static final Category CATEGORY

Category used to label entries that contain worksheet data.

Public Constructors

public WorksheetEntry ()

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

public WorksheetEntry (int rowCount, int colCount)

Constructs a new entry with the given row count and column count

Parameters

rowCount	The number of rows in the worksheet
colCount	The number of columns in a worksheet

public WorksheetEntry (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 any extensions.

Parameters

extProfile	The ExtensionProfile to initialize.

public URL getCellFeedUrl ()

Gets the URL for this worksheet's cells feed.

With this feed, you can query for arbitrary ranges of cells.

Returns

a URL to the cells feed

public int getColCount ()

Gets the total number of columns. This refers to the hard bound on columns. It is possible that your spreadsheet has many empty columns, all of which are counted in this count. Column positions 1 to getColCount() are valid.

public URL getListFeedUrl ()

Gets the URL for this worksheet's list feed.

You can then create a query using this URL to query this worksheet's rows, using the very powerful query model.

Returns

a URL to get a feed of worksheets

public int getRowCount ()

Gets the total number of rows. This refers to the hard bound on rows. It is possible that your spreadsheet has many, many empty rows, all of which are counted in this count. Column positions 1 to getRowCount() are valid.

public void setColCount (int count)

Sets the total number of columns. If the new number of columns is greater than the old, (new-old) blank columns will be appended to the end. If the new number of columns is less than the old, then (old-new) columns will be removed from the end which will DELETE ALL DATE IN DELETED COLUMNS.

Parameters

count	The new column count.

public void setRowCount (int count)

Sets the total number of rows. If the new number of rows is greater than the old, (new-old) blank rows will be appended to the end. If the new number of rows is less than the old, then (old-new) rows will be removed from the end which will DELETE ALL DATE IN DELETED ROWS.

Parameters

count	The new row count.

Classes

Enums

WorksheetEntry

Class Overview

Summary

Constants

public static final String KIND

Fields

public static final Category CATEGORY

Public Constructors

public WorksheetEntry ()

public WorksheetEntry (int rowCount, int colCount)

Parameters

public WorksheetEntry (BaseEntry sourceEntry)

Parameters

Public Methods

public void declareExtensions (ExtensionProfile extProfile)

Parameters

public URL getCellFeedUrl ()

Returns

public int getColCount ()

public URL getListFeedUrl ()

Returns

public int getRowCount ()

public void setColCount (int count)

Parameters

public void setRowCount (int count)

Parameters