public class PhotoFeed extends GphotoFeed<PhotoFeed> implements PhotoData, AtomData
CommentEntry or TagEntry kind. The photo feed itself
also contains all of the metadata available as part of a PhotoData
object.BaseFeed.FeedHandler, BaseFeed.FeedStateSource.SourceHandler, Source.SourceStateExtensionPoint.CumulativeBlobHandler, ExtensionPoint.ExtensionHandlerAbstractExtension.AttributesHandlerentries, entryClass, feedStatexmlBloblocalName, namespaceKIND, PHOTO_CATEGORY, PHOTO_KIND| Constructor and Description |
|---|
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.
|
| Modifier and Type | Method and Description |
|---|---|
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.
|
generateRss, getDescription, getGphotoId, setDescription, setGphotoId, setGphotoIdinsert, insert, setServiceaddAdaptor, createEntry, generate, generateAtom, generateFeedEnd, generateFeedStart, getAdaptedFeed, getAdaptor, getAdaptors, getCanPost, getEntries, getEntries, getEntryPostLink, getEtag, getFeedBatchLink, getHandler, getItemsPerPage, getKind, getNextLink, getPreviousLink, getSelectedFields, getSelf, getSelfLink, getService, getStartIndex, getTotalResults, getVersionId, insert, parseAtom, parseAtom, parseAtom, readFeed, readFeed, setCanPost, setEntries, setEtag, setItemsPerPage, setKind, setSelectedFields, setStartIndex, setTotalResults, setVersionId, visitChildrenaddHtmlLink, 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, setUpdatedaddExtension, 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, visitChildconsumeAttributes, disableStrictValidation, enableStrictValidation, eq, generateAttributes, getExtensionLocalName, getExtensionNamespace, isImmutable, isStrictValidation, putAttributes, sameClassAs, setImmutable, throwExceptionForMissingAttribute, throwExceptionIfImmutable, validateclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetGphotoId, setGphotoId, setGphotoIdaddExtension, addRepeatingExtension, removeExtension, removeExtension, removeRepeatingExtension, setExtensiongetAuthors, getCategories, getContributors, getDescription, getId, getLinks, getRights, getTitle, getUpdated, setDescription, setId, setRights, setTitle, setUpdatedgetGenerator, getLogo, getSubtitle, setGenerator, setLogoaddLink, getAuthors, getCategories, getId, getLink, getLinks, getTitle, getUpdated, removeLinks, removeLinks, setId, setUpdatedpublic PhotoFeed()
public PhotoFeed(BaseFeed<?,?> sourceFeed)
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()
PhotoDatagetAlbumId in interface PhotoDatapublic java.lang.String getAlbumAccess()
getAlbumAccess in interface PhotoDatapublic void setAlbumAccess(java.lang.String access)
PhotoDatasetAlbumAccess in interface PhotoDataaccess - the access of the album.public java.lang.String getVideoStatus()
PhotoDatagetVideoStatus in interface PhotoDatapublic java.lang.String getChecksum()
PhotoDatagetChecksum in interface PhotoDatapublic java.lang.String getClient()
PhotoDatapublic java.lang.Integer getCommentCount()
throws ServiceException
PhotoDatagetCommentCount in interface PhotoDataServiceExceptionpublic java.lang.Boolean getCommentsEnabled()
throws ServiceException
PhotoDatagetCommentsEnabled in interface PhotoDataServiceExceptionpublic ExifTags getExifTags()
PhotoDataExifTags for more information on available exif fields.getExifTags in interface PhotoDatapublic java.util.Date getFeaturedDate()
getFeaturedDate in interface PhotoDatapublic java.lang.Long getHeight()
throws ServiceException
PhotoDatagetHeight in interface PhotoDataServiceExceptionpublic java.lang.Float getPosition()
throws ServiceException
PhotoDatagetPosition in interface PhotoDataServiceExceptionpublic java.lang.Integer getRotation()
throws ServiceException
PhotoDatagetRotation in interface PhotoDataServiceExceptionpublic java.lang.Long getSize()
throws ServiceException
PhotoDatagetSize in interface PhotoDataServiceExceptionpublic java.util.Date getTimestamp()
throws ServiceException
PhotoDatagetTimestamp in interface PhotoDataServiceExceptionpublic java.lang.Long getVersion()
throws ServiceException
PhotoDatagetVersion in interface PhotoDataServiceExceptionpublic java.lang.Long getViewCount()
getViewCount in interface PhotoDatapublic java.lang.Long getWidth()
throws ServiceException
PhotoDatagetWidth in interface PhotoDataServiceExceptionpublic void setAlbumId(java.lang.Long albumId)
PhotoDatasetAlbumId in interface PhotoDatapublic void setAlbumId(java.lang.String albumId)
PhotoDatasetAlbumId in interface PhotoDatapublic void setVideoStatus(java.lang.String videoId)
PhotoDatasetVideoStatus in interface PhotoDatapublic void setChecksum(java.lang.String checksum)
PhotoDatasetChecksum in interface PhotoDatachecksum - the checksum on the photo, computed by a client.public void setClient(java.lang.String client)
PhotoDatapublic void setCommentCount(java.lang.Integer commentCount)
PhotoDatasetCommentCount in interface PhotoDatacommentCount - the number of comments on the photo.public void setCommentsEnabled(java.lang.Boolean commentsEnabled)
PhotoDatasetCommentsEnabled in interface PhotoDatacommentsEnabled - true if comments are enabled in the photo.public void setExifTags(ExifTags tags)
PhotoDatasetExifTags in interface PhotoDatatags - the exif tags for the photo, a collection of exif tags.public void setFeaturedDate(java.util.Date featuredDate)
PhotoDatasetFeaturedDate in interface PhotoDatafeaturedDate - the date that the photo was featured.public void setHeight(java.lang.Long height)
PhotoDatapublic void setPosition(java.lang.Float position)
PhotoDatasetPosition in interface PhotoDataposition - the position of the photo in the album.public void setRotation(java.lang.Integer rotation)
PhotoDatasetRotation in interface PhotoDatarotation - the rotation of the photo.public void setSize(java.lang.Long size)
PhotoDatapublic void setTimestamp(java.util.Date timestamp)
PhotoDatasetTimestamp in interface PhotoDatatimestamp - the timestamp on the photo.public void setVersion(java.lang.Long version)
PhotoDatasetVersion in interface PhotoDataversion - the version of the photo.public void setViewCount(java.lang.Long viewCount)
PhotoDatasetViewCount in interface PhotoDataviewCount - the number of views for this photo.public void setWidth(java.lang.Long width)
PhotoDatapublic void setGeoLocation(java.lang.Double lat,
java.lang.Double lon)
throws java.lang.IllegalArgumentException
PointDatasetGeoLocation 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)
PointDatasetGeoLocation in interface PointDatapoint - A point containing the latitude and longitude coordinates.public Point getGeoLocation()
PointDatagetGeoLocation in interface PointDatapublic void clearPoint()
PointDataclearPoint in interface PointDatapublic Box getGeoBoundingBox()
BoxDatagetGeoBoundingBox in interface BoxDatapublic 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()
BoxDataclearGeoBoundingBox in interface BoxDatapublic void addStreamId(java.lang.String streamId)
PhotoDataaddStreamId in interface PhotoDatapublic java.util.List<java.lang.String> getStreamIds()
PhotoDatagetStreamIds in interface PhotoDatapublic MediaGroup getMediaGroup()
MediaDatagetMediaGroup in interface MediaDatapublic java.util.List<MediaContent> getMediaContents()
MediaDatagetMediaContents in interface MediaDatapublic java.util.List<MediaCategory> getMediaCategories()
MediaDatagetMediaCategories in interface MediaDatapublic java.util.List<MediaCredit> getMediaCredits()
MediaDatagetMediaCredits in interface MediaDatapublic java.util.List<MediaThumbnail> getMediaThumbnails()
MediaDatagetMediaThumbnails in interface MediaDatapublic MediaKeywords getMediaKeywords()
MediaDatanull will be returned.getMediaKeywords in interface MediaDatanull.public void setKeywords(MediaKeywords keywords)
MediaDatasetKeywords in interface MediaDatapublic java.lang.Boolean isStarred()
PhotoDatapublic void setStarred(java.lang.Boolean starred)
PhotoDatasetStarred in interface PhotoDatastarred - If this photo is starred by current user.public java.lang.Integer getTotalStars()
PhotoDatagetTotalStars in interface PhotoDatapublic void setTotalStars(java.lang.Integer totalStars)
PhotoDatasetTotalStars in interface PhotoDatatotalStars - the number of users who starred this photo.