public class

SpreadsheetEntry

extends DocumentListEntry

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.media.MediaEntry<E extends com.google.gdata.data.BaseEntry<E>>
				↳	com.google.gdata.data.docs.DocumentListEntry
					↳	com.google.gdata.data.docs.SpreadsheetEntry

Class Overview

An entry representing a single spreadsheet within a DocumentListFeed.

Summary

Constants
String	KIND	Kind category term used to label the entries which are of document type.
String	LABEL	Label for category.

[Expand]

Inherited Constants

From class com.google.gdata.data.docs.DocumentListEntry

Fields
public static final Category	CATEGORY	Category used to label entries that contain spreadsheet data.

[Expand]

Inherited Fields

From class com.google.gdata.data.docs.DocumentListEntry

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
WorksheetEntry	getDefaultWorksheet() Gets the first worksheet in the spreadsheet.
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.docs.DocumentListEntry

void	addFolder(Person owner, String folderName) This method is deprecated. use `addLink(Link)` with link relation PARENT_NAMESPACE instead.
void	declareExtensions(ExtensionProfile extProfile) Declares the set of expected Extension types for an ExtensionPoint within the target extension profile.
AclFeed	getAclFeed()
DocumentListAclFeedLink	getAclFeedLink()
String	getDescription() Returns the description of this document.
String	getDocId() Gets the docId or spreadsheet key from the resource id.
Link	getDocumentLink() Gets the link with which you can open up the document in a Web browser.
String	getFilename() Returns the original filename for this document.
Set<String>	getFolders() This method is deprecated. use `getParentLinks()` instead.
String	getKey() This method is deprecated. use getResourceId() instead.
DateTime	getLastCommented() Returns the time when the document was last commented by the user.
LastModifiedBy	getLastModifiedBy() Returns the user who last modified the document.
DateTime	getLastViewed() Returns the time when the document was last viewed by the user.
String	getMd5Checksum() Returns the MD5 checksum calculated for the document.
static String	getMimeTypeFromFileName(String fileName) Returns the mime type given a file name.
List<Link>	getParentLinks()
Long	getQuotaBytesUsed() Returns the amount of quota consumed by the document.
String	getResourceId() Returns the document's resource id.
String	getSuggestedFilename() Returns the suggested filename for this document.
String	getType() Returns the type document entry from the resource id.
boolean	isHidden()
boolean	isRestrictedDownload()
boolean	isStarred()
boolean	isTrashed()
boolean	isViewed()
Boolean	isWritersCanInvite() Returns a flag for whether writers can invite other collaborators
void	setDescription(String description) Sets the description of this document.
void	setFile(File file, String mimeType) Associate a File with this entry with the specified mime type
void	setFile(File file) This method is deprecated. use setFile(File, String) instead.
void	setFilename(String filename) Sets the filename of this document.
void	setHidden(boolean hidden) Sets the hidden status of this document for the user this feed request has been authenticated under.
void	setLastCommented(DateTime lastCommented) Sets the time when the document was last commented by the user.
void	setLastModifiedBy(LastModifiedBy lastModifiedBy) Sets the amount of quota consumed by the document.
void	setLastViewed(DateTime lastViewed) Sets the time when the document was last viewed by the user.
void	setMd5Checksum(String md5Checksum) Set the MD5 checksum calculated for the document.
void	setQuotaBytesUsed(Long quotaBytesUsed) Sets the amount of quota consumed by the document.
void	setResourceId(String resourceId) Sets the document's resource id.
void	setRestrictedDownload(boolean restrictedDownload) Sets the restricted download status for this document.
void	setStarred(boolean starred) Sets the starred status of this document for the user this feed request has been authenticated under.
void	setSuggestedFilename(String filename) Sets the suggested filename for this document.
void	setTrashed(boolean trashed) Sets the trashed status of this document for the user this feed request has been authenticated under.
void	setViewed(boolean viewed) Sets the viewed status of this document for the user this feed request has been authenticated under.
void	setWritersCanInvite(Boolean writersCanInvite) Sets whether users classed as writers can invite other collaborators

From class com.google.gdata.data.media.MediaEntry

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

From interface com.google.gdata.data.media.IMediaEntry

Constants

public static final String KIND

Kind category term used to label the entries which are of document type.

Constant Value: "http://schemas.google.com/docs/2007#spreadsheet"

public static final String LABEL

Label for category.

Constant Value: "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 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 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

Classes

Enums

SpreadsheetEntry

Class Overview

Summary

Constants

public static final String KIND

public static final String LABEL

Fields

public static final Category CATEGORY

Public Constructors

public SpreadsheetEntry ()

public SpreadsheetEntry (BaseEntry sourceEntry)

Parameters

Public Methods

public WorksheetEntry getDefaultWorksheet ()

Returns

Throws

public URL getWorksheetFeedUrl ()

Returns

public List<WorksheetEntry> getWorksheets ()

Returns

Throws