Google Data APIs Client Library (1.41.1)



com.google.gdata.data.docs
Class SpreadsheetEntry

java.lang.Object
  extended by com.google.gdata.data.AbstractExtension
      extended by com.google.gdata.data.ExtensionPoint
          extended by com.google.gdata.data.BaseEntry<E>
              extended by com.google.gdata.data.media.MediaEntry<DocumentListEntry>
                  extended by com.google.gdata.data.docs.DocumentListEntry
                      extended by com.google.gdata.data.docs.SpreadsheetEntry
All Implemented Interfaces:
Extension, IAtom, IEntry, Kind.Adaptable, Kind.Adaptor, IMediaEntry

public class SpreadsheetEntry
extends DocumentListEntry

An entry representing a single spreadsheet within a DocumentListFeed.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.google.gdata.data.docs.DocumentListEntry
DocumentListEntry.MediaType
 
Nested classes/interfaces inherited from class com.google.gdata.data.BaseEntry
BaseEntry.AtomHandler, BaseEntry.EntryState
 
Nested classes/interfaces inherited from class com.google.gdata.data.ExtensionPoint
ExtensionPoint.CumulativeBlobHandler, ExtensionPoint.ExtensionHandler
 
Nested classes/interfaces inherited from class com.google.gdata.data.AbstractExtension
AbstractExtension.AttributesHandler
 
Field Summary
static Category CATEGORY
          Category used to label entries that contain spreadsheet data.
static java.lang.String KIND
          Kind category term used to label the entries which are of document type.
static java.lang.String LABEL
          Label for category.
 
Fields inherited from class com.google.gdata.data.docs.DocumentListEntry
FOLDERS_NAMESPACE, PARENT_NAMESPACE, REVISIONS_NAMESPACE, UNKNOWN_CATEGORY, UNKNOWN_KIND, UNKNOWN_LABEL
 
Fields inherited from class com.google.gdata.data.BaseEntry
state
 
Fields inherited from class com.google.gdata.data.ExtensionPoint
xmlBlob
 
Fields inherited from class com.google.gdata.data.AbstractExtension
localName, namespace
 
Constructor Summary
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.
 
Method Summary
 WorksheetEntry getDefaultWorksheet()
          Gets the first worksheet in the spreadsheet.
 java.net.URL getWorksheetFeedUrl()
          Gets the URL for this spreadsheet's worksheets feed.
 java.util.List<WorksheetEntry> getWorksheets()
          Gets all worksheet entries that are part of this spreadsheet.
 
Methods inherited from class com.google.gdata.data.docs.DocumentListEntry
addFolder, declareExtensions, getAclFeed, getAclFeedLink, getDocId, getDocumentLink, getFolders, getKey, getLastModifiedBy, getLastViewed, getMimeTypeFromFileName, getParentLinks, getQuotaBytesUsed, getResourceId, getType, isHidden, isStarred, isTrashed, isViewed, isWritersCanInvite, setFile, setFile, setHidden, setLastModifiedBy, setLastViewed, setQuotaBytesUsed, setResourceId, setStarred, setTrashed, setViewed, setWritersCanInvite
 
Methods inherited from class com.google.gdata.data.media.MediaEntry
getContentHandlerInfo, getMediaEditLink, getMediaSource, setMediaSource, setService, updateMedia
 
Methods inherited from class com.google.gdata.data.BaseEntry
addAdaptor, addHtmlLink, addLink, addLink, delete, generate, generateAtom, generateRss, getAdaptedEntry, getAdaptor, getAdaptors, getAuthors, getCanEdit, getCategories, getContent, getContributors, getEdited, getEditLink, getEtag, getHandler, getHtmlLink, getId, getKind, getLink, getLinks, getLinks, getPlainTextContent, getPubControl, getPublished, getResumableEditMediaLink, getRights, getSelectedFields, getSelf, getSelfLink, getService, getSource, getSummary, getTextContent, getTitle, getUpdated, getVersionId, isDraft, parseAtom, parseAtom, parseAtom, readEntry, readEntry, removeLinks, removeLinks, setCanEdit, setContent, setContent, setDraft, setEdited, setEtag, setId, setKind, setPubControl, setPublished, setRights, setSelectedFields, setSource, setSummary, setTitle, setUpdated, setVersionId, update, visitChildren
 
Methods inherited from class com.google.gdata.data.ExtensionPoint
addExtension, addExtension, addRepeatingExtension, addRepeatingExtension, checkRequiredExtensions, createExtensionInstance, generate, generateCumulativeXmlBlob, generateExtensions, generateStartElement, getExtension, getExtensionDescription, getExtensionHandler, getExtensions, getManifest, getRepeatingExtension, getRepeatingExtensions, getXmlBlob, hasExtension, hasRepeatingExtension, initializeArbitraryXml, parseCumulativeXmlBlob, removeExtension, removeExtension, removeRepeatingExtension, setExtension, setXmlBlob, visit, visitChild
 
Methods inherited from class com.google.gdata.data.AbstractExtension
consumeAttributes, disableStrictValidation, enableStrictValidation, eq, generateAttributes, getExtensionLocalName, getExtensionNamespace, isImmutable, isStrictValidation, putAttributes, sameClassAs, setImmutable, throwExceptionForMissingAttribute, throwExceptionIfImmutable, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.google.gdata.data.IEntry
getCanEdit, getContent, getEdited, getEditLink, getPublished, getResumableEditMediaLink, getSelectedFields, getSummary, setCanEdit, setEdited, setPublished, setSelectedFields
 
Methods inherited from interface com.google.gdata.data.IAtom
addLink, getAuthors, getCategories, getEtag, getId, getKind, getLink, getLinks, getSelfLink, getTitle, getUpdated, getVersionId, removeLinks, removeLinks, setEtag, setId, setKind, setUpdated, setVersionId
 

Field Detail

LABEL

public static final java.lang.String LABEL
Label for category.

See Also:
Constant Field Values

KIND

public static final java.lang.String KIND
Kind category term used to label the entries which are of document type.

See Also:
Constant Field Values

CATEGORY

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

Constructor Detail

SpreadsheetEntry

public SpreadsheetEntry()
Constructs a new uninitialized entry, to be populated by the GData parsers.


SpreadsheetEntry

public SpreadsheetEntry(BaseEntry sourceEntry)
Constructs a new entry by doing a shallow copy from another BaseEntry instance.

Method Detail

getWorksheetFeedUrl

public java.net.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

getWorksheets

public java.util.List<WorksheetEntry> getWorksheets()
                                             throws java.io.IOException,
                                                    ServiceException
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:
java.io.IOException
ServiceException

getDefaultWorksheet

public WorksheetEntry getDefaultWorksheet()
                                   throws java.io.IOException,
                                          ServiceException
Gets the first worksheet in the spreadsheet. This is very useful if your spreadsheet only has one worksheet.

Returns:
the first worksheet
Throws:
java.io.IOException
ServiceException