|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.google.gdata.data.AbstractExtension
com.google.gdata.data.ExtensionPoint
com.google.gdata.data.Source
com.google.gdata.data.BaseFeed<F,E>
com.google.gdata.data.media.MediaFeed<F,GphotoEntry>
com.google.gdata.data.photos.GphotoFeed<PhotoFeed>
com.google.gdata.data.photos.PhotoFeed
public class PhotoFeed
Feed for a Photo in our google data api. This feed represents a photo
as the container for other objects. A Photo feed contains entries
of CommentEntry or TagEntry kind. The photo feed itself
also contains all of the metadata available as part of a PhotoData
object.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class com.google.gdata.data.BaseFeed |
|---|
BaseFeed.FeedHandler, BaseFeed.FeedState |
| Nested classes/interfaces inherited from class com.google.gdata.data.Source |
|---|
Source.SourceHandler, Source.SourceState |
| 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 |
|---|
| Fields inherited from class com.google.gdata.data.BaseFeed |
|---|
entries, entryClass, feedState |
| Fields inherited from class com.google.gdata.data.Source |
|---|
srcState |
| Fields inherited from class com.google.gdata.data.ExtensionPoint |
|---|
xmlBlob |
| Fields inherited from class com.google.gdata.data.AbstractExtension |
|---|
localName, namespace |
| Fields inherited from interface com.google.gdata.data.photos.PhotoData |
|---|
KIND, PHOTO_CATEGORY, PHOTO_KIND |
| Constructor Summary | |
|---|---|
PhotoFeed()
Constructs a new empty photo feed. |
|
PhotoFeed(BaseFeed<?,?> sourceFeed)
Constructs a new photo feed from a shallow copy of the data in the source feed. |
|
| Method Summary | |
|---|---|
void |
addStreamId(java.lang.String streamId)
Add an individual streamId to the photo. |
void |
clearGeoBoundingBox()
Clears the bounding box and removes the extension point. |
void |
clearPoint()
Clears the point data and removes the extension point. |
void |
declareExtensions(ExtensionProfile extProfile)
Declares the set of expected Extension types for an ExtensionPoint within the target extension profile. |
java.lang.String |
getAlbumAccess()
|
java.lang.String |
getAlbumId()
The id of the album the photo is on. |
java.lang.String |
getChecksum()
The checksum on the photo. |
java.lang.String |
getClient()
The client string stored on the photo. |
java.lang.Integer |
getCommentCount()
The number of comments on this photo. |
java.util.List<CommentEntry> |
getCommentEntries()
Get a list of entries of the CommentEntry kind. |
java.lang.Boolean |
getCommentsEnabled()
Gets the status of the commenting preference on the photo. |
ExifTags |
getExifTags()
The exif information on the photo. |
java.util.Date |
getFeaturedDate()
|
Box |
getGeoBoundingBox()
Gets the bounding box of this entity. |
Point |
getGeoLocation()
Gets the geo-location of the entity. |
java.lang.Long |
getHeight()
The height of the photo in pixels. |
java.util.List<MediaCategory> |
getMediaCategories()
Retrieve the list of media:category elements inside the media:group on this element. |
java.util.List<MediaContent> |
getMediaContents()
Retrieve the list of media:content elements inside the media:group on this element. |
java.util.List<MediaCredit> |
getMediaCredits()
Retrieve the list of media:credit elements inside the media:group on this element. |
MediaGroup |
getMediaGroup()
Retrieve the media:group element on this element. |
MediaKeywords |
getMediaKeywords()
Retrieve the list of media:keywords elements inside the media:group on this element. |
java.util.List<MediaThumbnail> |
getMediaThumbnails()
Retrieve the list of media:thumbnail elements inside the media:group on this element. |
java.lang.Float |
getPosition()
The position of the photo in the album. |
java.lang.Integer |
getRotation()
The rotation of the photo. |
java.lang.Long |
getSize()
The size of the photo in bytes. |
java.util.List<java.lang.String> |
getStreamIds()
Stream ids can be used to specify additional information about where a photo came from, or where it is being used. |
java.util.List<TagEntry> |
getTagEntries()
Get a list of entries of the TagEntry kind. |
java.util.Date |
getTimestamp()
The time the photo was taken. |
java.lang.Integer |
getTotalStars()
The number of users who starred this photo. |
java.lang.Long |
getVersion()
The version of the image. |
java.lang.String |
getVideoStatus()
The video status in case the photo entry is a video. |
java.lang.Long |
getViewCount()
|
java.lang.Long |
getWidth()
The width of the photo in pixels. |
java.lang.Boolean |
isStarred()
If this photo is starred by current user. |
void |
setAlbumAccess(java.lang.String access)
Set the access for the album that contains this photo. |
void |
setAlbumId(java.lang.Long albumId)
Sets the id of the album the photo is in. |
void |
setAlbumId(java.lang.String albumId)
Set the albumId of the photo as a string, the album the photo is in. |
void |
setChecksum(java.lang.String checksum)
Set the checksum of the photo. |
void |
setClient(java.lang.String client)
Set the client string on the photo. |
void |
setCommentCount(java.lang.Integer commentCount)
Set the number of comments on the photo. |
void |
setCommentsEnabled(java.lang.Boolean commentsEnabled)
Sets whether comments can be made on the photo. |
void |
setExifTags(ExifTags tags)
Sets the exif tags for the photo. |
void |
setFeaturedDate(java.util.Date featuredDate)
Sets the date that the photo was featured. |
void |
setGeoBoundingBox(Box boundingBox)
Sets the bounding box for this entity based on a Box extension. |
void |
setGeoBoundingBox(Point lowerLeft,
Point upperRight)
Sets the bounding box based on two Point objects. |
void |
setGeoLocation(java.lang.Double lat,
java.lang.Double lon)
Sets the geo-location of the entity based on the lat and long coordinates passed in. |
void |
setGeoLocation(Point point)
Sets the geo-location of the entity based on the Point extension. |
void |
setHeight(java.lang.Long height)
Set the height of the photo. |
void |
setKeywords(MediaKeywords keywords)
Set the media keywords on this element to the given keywords. |
void |
setPosition(java.lang.Float position)
Set the position of the photo. |
void |
setRotation(java.lang.Integer rotation)
Set the rotation in degrees of the photo. |
void |
setSize(java.lang.Long size)
Set the size of the photo. |
void |
setStarred(java.lang.Boolean starred)
Sets if this photo is starred by current user. |
void |
setTimestamp(java.util.Date timestamp)
Set the timestamp on the photo. |
void |
setTotalStars(java.lang.Integer totalStars)
Sets the number of users who starred this photo. |
void |
setVersion(java.lang.Long version)
Set the version of the photo. |
void |
setVideoStatus(java.lang.String videoId)
Set the video status of the photo entry. |
void |
setViewCount(java.lang.Long viewCount)
Sets the view count for this photo. |
void |
setWidth(java.lang.Long width)
Set the width of the photo. |
| Methods inherited from class com.google.gdata.data.photos.GphotoFeed |
|---|
generateRss, getDescription, getGphotoId, setDescription, setGphotoId, setGphotoId |
| Methods inherited from class com.google.gdata.data.media.MediaFeed |
|---|
insert, insert, setService |
| Methods inherited from class com.google.gdata.data.BaseFeed |
|---|
addAdaptor, createEntry, generate, generateAtom, generateFeedEnd, generateFeedStart, getAdaptedFeed, getAdaptor, getAdaptors, getCanPost, getEntries, getEntries, getEntryPostLink, getEtag, getFeedBatchLink, getHandler, getItemsPerPage, getKind, getNextLink, getPreviousLink, getSelf, getSelfLink, getService, getStartIndex, getTotalResults, getVersionId, insert, parseAtom, parseAtom, parseAtom, readFeed, readFeed, setCanPost, setEntries, setEtag, setItemsPerPage, setKind, setStartIndex, setTotalResults, setVersionId, visitChildren |
| Methods inherited from class com.google.gdata.data.Source |
|---|
addHtmlLink, addLink, addLink, generateInnerAtom, getAuthors, getCategories, getContributors, getGenerator, getHtmlLink, getIcon, getId, getLink, getLinks, getLinks, getLogo, getRights, getSubtitle, getTitle, getUpdated, removeLinks, removeLinks, setGenerator, setGenerator, setIcon, setId, setLogo, setRights, setSubtitle, setTitle, setUpdated |
| Methods inherited from class com.google.gdata.data.AbstractExtension |
|---|
consumeAttributes, eq, generateAttributes, getExtensionLocalName, getExtensionNamespace, isImmutable, 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.photos.GphotoData |
|---|
getGphotoId, setGphotoId, setGphotoId |
| Methods inherited from interface com.google.gdata.data.photos.Extensible |
|---|
addExtension, addRepeatingExtension, removeExtension, removeExtension, removeRepeatingExtension, setExtension |
| Methods inherited from interface com.google.gdata.data.photos.AtomData |
|---|
getAuthors, getCategories, getContributors, getDescription, getId, getLinks, getRights, getTitle, getUpdated, setDescription, setId, setRights, setTitle, setUpdated |
| Methods inherited from interface com.google.gdata.data.IFeed |
|---|
getGenerator, getLogo, getSubtitle, setGenerator, setLogo |
| Methods inherited from interface com.google.gdata.data.IAtom |
|---|
addLink, getAuthors, getCategories, getId, getLink, getLinks, getTitle, getUpdated, removeLinks, removeLinks, setId, setUpdated |
| Constructor Detail |
|---|
public PhotoFeed()
public PhotoFeed(BaseFeed<?,?> sourceFeed)
| Method Detail |
|---|
public void declareExtensions(ExtensionProfile extProfile)
BaseFeedThe implementation of this method for BaseFeed will declare any extensions associated with the contained entry type.
declareExtensions in interface Kind.AdaptordeclareExtensions in interface ExtensibledeclareExtensions in class GphotoFeed<PhotoFeed>extProfile - the ExtensionProfile to initialize.ExtensionProfile.addDeclarations(Kind.Adaptor)public java.util.List<CommentEntry> getCommentEntries()
CommentEntry kind.
public java.util.List<TagEntry> getTagEntries()
TagEntry kind.
public java.lang.String getAlbumId()
PhotoData
getAlbumId in interface PhotoDatapublic java.lang.String getAlbumAccess()
getAlbumAccess in interface PhotoDatapublic void setAlbumAccess(java.lang.String access)
PhotoData
setAlbumAccess in interface PhotoDataaccess - the access of the album.public java.lang.String getVideoStatus()
PhotoData
getVideoStatus in interface PhotoDatapublic java.lang.String getChecksum()
PhotoData
getChecksum in interface PhotoDatapublic java.lang.String getClient()
PhotoData
getClient in interface PhotoData
public java.lang.Integer getCommentCount()
throws ServiceException
PhotoData
getCommentCount in interface PhotoDataServiceException
public java.lang.Boolean getCommentsEnabled()
throws ServiceException
PhotoData
getCommentsEnabled in interface PhotoDataServiceExceptionpublic ExifTags getExifTags()
PhotoDataExifTags for more information on available exif fields.
getExifTags in interface PhotoDatapublic java.util.Date getFeaturedDate()
getFeaturedDate in interface PhotoData
public java.lang.Long getHeight()
throws ServiceException
PhotoData
getHeight in interface PhotoDataServiceException
public java.lang.Float getPosition()
throws ServiceException
PhotoData
getPosition in interface PhotoDataServiceException
public java.lang.Integer getRotation()
throws ServiceException
PhotoData
getRotation in interface PhotoDataServiceException
public java.lang.Long getSize()
throws ServiceException
PhotoData
getSize in interface PhotoDataServiceException
public java.util.Date getTimestamp()
throws ServiceException
PhotoData
getTimestamp in interface PhotoDataServiceException
public java.lang.Long getVersion()
throws ServiceException
PhotoData
getVersion in interface PhotoDataServiceExceptionpublic java.lang.Long getViewCount()
getViewCount in interface PhotoData
public java.lang.Long getWidth()
throws ServiceException
PhotoData
getWidth in interface PhotoDataServiceExceptionpublic void setAlbumId(java.lang.Long albumId)
PhotoData
setAlbumId in interface PhotoDatapublic void setAlbumId(java.lang.String albumId)
PhotoData
setAlbumId in interface PhotoDatapublic void setVideoStatus(java.lang.String videoId)
PhotoData
setVideoStatus in interface PhotoDatapublic void setChecksum(java.lang.String checksum)
PhotoData
setChecksum in interface PhotoDatachecksum - the checksum on the photo, computed by a client.public void setClient(java.lang.String client)
PhotoData
setClient in interface PhotoDataclient - the client that created the photo.public void setCommentCount(java.lang.Integer commentCount)
PhotoData
setCommentCount in interface PhotoDatacommentCount - the number of comments on the photo.public void setCommentsEnabled(java.lang.Boolean commentsEnabled)
PhotoData
setCommentsEnabled in interface PhotoDatacommentsEnabled - true if comments are enabled in the photo.public void setExifTags(ExifTags tags)
PhotoData
setExifTags in interface PhotoDatatags - the exif tags for the photo, a collection of exif tags.public void setFeaturedDate(java.util.Date featuredDate)
PhotoData
setFeaturedDate in interface PhotoDatafeaturedDate - the date that the photo was featured.public void setHeight(java.lang.Long height)
PhotoData
setHeight in interface PhotoDataheight - the height of the photo.public void setPosition(java.lang.Float position)
PhotoData
setPosition in interface PhotoDataposition - the position of the photo in the album.public void setRotation(java.lang.Integer rotation)
PhotoData
setRotation in interface PhotoDatarotation - the rotation of the photo.public void setSize(java.lang.Long size)
PhotoData
setSize in interface PhotoDatasize - the size of the photo in bytes.public void setTimestamp(java.util.Date timestamp)
PhotoData
setTimestamp in interface PhotoDatatimestamp - the timestamp on the photo.public void setVersion(java.lang.Long version)
PhotoData
setVersion in interface PhotoDataversion - the version of the photo.public void setViewCount(java.lang.Long viewCount)
PhotoData
setViewCount in interface PhotoDataviewCount - the number of views for this photo.public void setWidth(java.lang.Long width)
PhotoData
setWidth in interface PhotoDatawidth - the width of the photo.
public void setGeoLocation(java.lang.Double lat,
java.lang.Double lon)
throws java.lang.IllegalArgumentException
PointData
setGeoLocation in interface PointDatalat - The latitude coordinate, between -90 and 90 degrees.lon - The longitude coordinate, between -180 and 180 degrees.
java.lang.IllegalArgumentException - if the latitude and longitude coordinates
are invalid.public void setGeoLocation(Point point)
PointData
setGeoLocation in interface PointDatapoint - A point containing the latitude and longitude coordinates.public Point getGeoLocation()
PointData
getGeoLocation in interface PointDatapublic void clearPoint()
PointData
clearPoint in interface PointDatapublic Box getGeoBoundingBox()
BoxData
getGeoBoundingBox in interface BoxData
public void setGeoBoundingBox(Point lowerLeft,
Point upperRight)
BoxDataPoint objects. If there is an
existing Box on this object, the new points will be copied into the
existing box rather than creating a new box.
setGeoBoundingBox in interface BoxDatalowerLeft - the lower left coordinate of the box.upperRight - the upper right coordinate of the box.public void setGeoBoundingBox(Box boundingBox)
BoxDataBox extension. If
there is an existing Box on this object, the new box will have its points
copied into the existing box rather than using the passed-in box.
setGeoBoundingBox in interface BoxDataboundingBox - the box that bounds this entity.public void clearGeoBoundingBox()
BoxData
clearGeoBoundingBox in interface BoxDatapublic void addStreamId(java.lang.String streamId)
PhotoData
addStreamId in interface PhotoDatapublic java.util.List<java.lang.String> getStreamIds()
PhotoData
getStreamIds in interface PhotoDatapublic MediaGroup getMediaGroup()
MediaData
getMediaGroup in interface MediaDatapublic java.util.List<MediaContent> getMediaContents()
MediaData
getMediaContents in interface MediaDatapublic java.util.List<MediaCategory> getMediaCategories()
MediaData
getMediaCategories in interface MediaDatapublic java.util.List<MediaCredit> getMediaCredits()
MediaData
getMediaCredits in interface MediaDatapublic java.util.List<MediaThumbnail> getMediaThumbnails()
MediaData
getMediaThumbnails in interface MediaDatapublic MediaKeywords getMediaKeywords()
MediaDatanull will be returned.
getMediaKeywords in interface MediaDatanull.public void setKeywords(MediaKeywords keywords)
MediaData
setKeywords in interface MediaDatapublic java.lang.Boolean isStarred()
PhotoData
isStarred in interface PhotoDatapublic void setStarred(java.lang.Boolean starred)
PhotoData
setStarred in interface PhotoDatastarred - If this photo is starred by current user.public java.lang.Integer getTotalStars()
PhotoData
getTotalStars in interface PhotoDatapublic void setTotalStars(java.lang.Integer totalStars)
PhotoData
setTotalStars in interface PhotoDatatotalStars - the number of users who starred this photo.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||