com.google.gdata.data.photos
Class PhotoEntry

java.lang.Object
  com.google.gdata.data.AbstractExtension
      com.google.gdata.data.ExtensionPoint
          com.google.gdata.data.BaseEntry<E>
              com.google.gdata.data.media.MediaEntry<E>
                  com.google.gdata.data.photos.GphotoEntry<PhotoEntry>
                      com.google.gdata.data.photos.PhotoEntry

All Implemented Interfaces:

Extension, BoxData, PointData, IEntry, Kind.Adaptable, Kind.Adaptor, AtomData, Extensible, GphotoData, MediaData, PhotoData

public class PhotoEntry
extends GphotoEntry<PhotoEntry>
implements PhotoData, AtomData

Entry class for photos. Contains getters and setters for all of the fields that we support on a photo data object.

Nested Class Summary

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

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

Fields inherited from interface com.google.gdata.data.photos.PhotoData

KIND, PHOTO_CATEGORY, PHOTO_KIND

Constructor Summary

PhotoEntry()
Constructs a new empty photo entry.

PhotoEntry(BaseEntry<?> sourceEntry)
Construct a new photo entry doing a shallow copy of the data in the passed in source entry.

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	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.lang.Boolean	getCommentsEnabled() Gets the status of the commenting preference on the photo.
ExifTags	getExifTags() The exif information on the photo.
PhotoFeed	getFeed(java.lang.String... kinds) Retrieve the photo feed and associated entries.
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.Date	getTimestamp() The time the photo was taken.
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	getWidth() The width of the photo in pixels.
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	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	setTimestamp(java.util.Date timestamp) Set the timestamp on the photo.
void	setVersion(java.lang.Long version) Set the version of the photo.
void	setVideoStatus(java.lang.String videoStatus) Set the video status of the photo entry.
void	setWidth(java.lang.Long width) Set the width of the photo.

Methods inherited from class com.google.gdata.data.photos.GphotoEntry

generateRss, getAdaptedEntry, getDescription, getFeed, getFeedLink, getGphotoId, setDescription, setGphotoId, setGphotoId

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, getAdaptor, getAdaptors, getAuthors, getCanEdit, getCategories, getContent, getContributors, getEdited, getEditLink, getEtag, getHandler, getHtmlLink, getId, getLink, getLinks, getLinks, getPlainTextContent, getPubControl, getPublished, getRights, getSelf, getSelfLink, getService, getSource, getSummary, getTextContent, getTitle, getUpdated, getVersionId, isDraft, parseAtom, parseAtom, parseAtom, readEntry, readEntry, removeLinks, setCanEdit, setContent, setContent, setDraft, setEdited, setEtag, setId, setPubControl, setPublished, setRights, setSource, setSummary, setTitle, setUpdated, setVersionId, update, visitChildren

Methods inherited from class com.google.gdata.data.ExtensionPoint

addExtension, addExtension, addRepeatingExtension, addRepeatingExtension, checkRequiredExtensions, generate, generateCumulativeXmlBlob, generateExtensions, generateStartElement, getExtension, 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, 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

Constructor Detail

PhotoEntry

public PhotoEntry()

Constructs a new empty photo entry.

PhotoEntry

public PhotoEntry(BaseEntry<?> sourceEntry)

Construct a new photo entry doing a shallow copy of the data in the passed in source entry.

Method Detail

declareExtensions

public void declareExtensions(ExtensionProfile extProfile)

Description copied from class: ExtensionPoint

Declares the set of expected Extension types for an ExtensionPoint within the target extension profile. The base implementation does not declare any extensions, but can be overridden by specific types of ExtensionPoints that always contain a well-defined set of extensions.

Specified by:

declareExtensions in interface Kind.Adaptor

Specified by:

declareExtensions in interface Extensible

Overrides:

declareExtensions in class GphotoEntry<PhotoEntry>

Parameters:

extProfile - the ExtensionProfile to initialize.

See Also:

ExtensionProfile.addDeclarations(Kind.Adaptor)

getFeed

public PhotoFeed getFeed(java.lang.String... kinds)
                  throws java.io.IOException,
                         ServiceException

Retrieve the photo feed and associated entries. The kinds parameter is a list of the associated entries to return. For example PhotoFeed photoTagsAndComments = photoEntry.getFeed(CommentData.KIND, TagData.KIND); If no kind parameters are passed, the default of CommentData.KIND will be used.

Parameters:

kinds - the kinds of entries to retrieve, or empty to use the default.

Returns:

a feed of the photo and the requested kinds.

Throws:

java.io.IOException

ServiceException

See Also:

CommentData.KIND, TagData.KIND

getAlbumId

public java.lang.String getAlbumId()

Description copied from interface: PhotoData

The id of the album the photo is on.

Specified by:

getAlbumId in interface PhotoData

Returns:

the gphoto:albumId of the photo.

getVideoStatus

public java.lang.String getVideoStatus()

Description copied from interface: PhotoData

The video status in case the photo entry is a video.

Specified by:

getVideoStatus in interface PhotoData

Returns:

the gphoto:videostatus of the video/photo.

getChecksum

public java.lang.String getChecksum()

Description copied from interface: PhotoData

The checksum on the photo. This is another piece of client-provided information that will be stored on the server and returned to the client.

Specified by:

getChecksum in interface PhotoData

Returns:

the gphoto:checksum of the photo.

getClient

public java.lang.String getClient()

Description copied from interface: PhotoData

The client string stored on the photo. Clients can use this to provide additional information about the photo that they can use later.

Specified by:

getClient in interface PhotoData

Returns:

the gphoto:client of the photo.

getCommentCount

public java.lang.Integer getCommentCount()
                                  throws ServiceException

Description copied from interface: PhotoData

The number of comments on this photo.

Specified by:

getCommentCount in interface PhotoData

Returns:

the comment count on the photo.

Throws:

ServiceException

getCommentsEnabled

public java.lang.Boolean getCommentsEnabled()
                                     throws ServiceException

Description copied from interface: PhotoData

Gets the status of the commenting preference on the photo. If comments are not enabled on the photo no comments may be sent.

Specified by:

getCommentsEnabled in interface PhotoData

Returns:

true if comments are enabled on the photo.

Throws:

ServiceException

getExifTags

public ExifTags getExifTags()

Description copied from interface: PhotoData

The exif information on the photo. See the documentation for ExifTags for more information on available exif fields.

Specified by:

getExifTags in interface PhotoData

Returns:

the exif tags for the photo.

getHeight

public java.lang.Long getHeight()
                         throws ServiceException

Description copied from interface: PhotoData

The height of the photo in pixels. This is the height of the original image stored in the database, but not necessarily the height of the image returned by querying the image url (depending on image size).

Specified by:

getHeight in interface PhotoData

Returns:

the gphoto:height of the photo.

Throws:

ServiceException

getPosition

public java.lang.Float getPosition()
                            throws ServiceException

Description copied from interface: PhotoData

The position of the photo in the album. This can be used to order the photo based on where the user has placed it within the album.

Specified by:

getPosition in interface PhotoData

Returns:

the gphoto:position of the photo.

Throws:

ServiceException

getRotation

public java.lang.Integer getRotation()
                              throws ServiceException

Description copied from interface: PhotoData

The rotation of the photo. This is only useful when downloading the original photo as the rotation is taken into account on thumbnails and the image is always provided in the right orientation.

Specified by:

getRotation in interface PhotoData

Returns:

the gphoto:rotation of the photo.

Throws:

ServiceException

getSize

public java.lang.Long getSize()
                       throws ServiceException

Description copied from interface: PhotoData

The size of the photo in bytes. Read only, calculated by the server.

Specified by:

getSize in interface PhotoData

Returns:

the gphoto:size of the photo.

Throws:

ServiceException

getTimestamp

public java.util.Date getTimestamp()
                            throws ServiceException

Description copied from interface: PhotoData

The time the photo was taken. Modifiable by the client.

Specified by:

getTimestamp in interface PhotoData

Returns:

the gphoto:timestamp of the photo.

Throws:

ServiceException

getVersion

public java.lang.Long getVersion()
                          throws ServiceException

Description copied from interface: PhotoData

The version of the image. This is the version of the image itself, and is changed whenever the image content is changed (such as by rotation).

Specified by:

getVersion in interface PhotoData

Returns:

the gphoto:version on the photo.

Throws:

ServiceException

getWidth

public java.lang.Long getWidth()
                        throws ServiceException

Description copied from interface: PhotoData

The width of the photo in pixels. This is the width of the original image stored in the database, but not necessarily the width of the image returned by querying the image url (depending on image size).

Specified by:

getWidth in interface PhotoData

Returns:

the gphoto:width of the photo.

Throws:

ServiceException

setAlbumId

public void setAlbumId(java.lang.Long albumId)

Description copied from interface: PhotoData

Sets the id of the album the photo is in. If the albumid is changed the photo will be moved to the new album (as long as the provided albumid is valid). Set the albumId of the photo as a long, the album the photo is in.

Specified by:

setAlbumId in interface PhotoData

setAlbumId

public void setAlbumId(java.lang.String albumId)

Description copied from interface: PhotoData

Set the albumId of the photo as a string, the album the photo is in.

Specified by:

setAlbumId in interface PhotoData

setVideoStatus

public void setVideoStatus(java.lang.String videoStatus)

Description copied from interface: PhotoData

Set the video status of the photo entry.

Specified by:

setVideoStatus in interface PhotoData

setChecksum

public void setChecksum(java.lang.String checksum)

Description copied from interface: PhotoData

Set the checksum of the photo. Returned by the server, this is an opaque string and will not be used by the server.

Specified by:

setChecksum in interface PhotoData

Parameters:

checksum - the checksum on the photo, computed by a client.

setClient

public void setClient(java.lang.String client)

Description copied from interface: PhotoData

Set the client string on the photo.

Specified by:

setClient in interface PhotoData

Parameters:

client - the client that created the photo.

setCommentCount

public void setCommentCount(java.lang.Integer commentCount)

Description copied from interface: PhotoData

Set the number of comments on the photo. Used by the server, this field is calculated and cannot be modified by the client.

Specified by:

setCommentCount in interface PhotoData

Parameters:

commentCount - the number of comments on the photo.

setCommentsEnabled

public void setCommentsEnabled(java.lang.Boolean commentsEnabled)

Description copied from interface: PhotoData

Sets whether comments can be made on the photo. The client can change whether comments are allowed as long as they are authenticated as the owner of the photo.

Specified by:

setCommentsEnabled in interface PhotoData

Parameters:

commentsEnabled - true if comments are enabled in the photo.

setExifTags

public void setExifTags(ExifTags tags)

Description copied from interface: PhotoData

Sets the exif tags for the photo. This will override existing exif data that was calculated when the photo was first uploaded.

Specified by:

setExifTags in interface PhotoData

Parameters:

tags - the exif tags for the photo, a collection of exif tags.

setHeight

public void setHeight(java.lang.Long height)

Description copied from interface: PhotoData

Set the height of the photo. Used by the server, this has no effect on the client.

Specified by:

setHeight in interface PhotoData

Parameters:

height - the height of the photo.

setPosition

public void setPosition(java.lang.Float position)

Description copied from interface: PhotoData

Set the position of the photo. This is the photo's position in the album it is in. This can be changed to place a photo between two other photos by choosing a position between the other two positions. Note that the server may change the positions to provide more space between photos if the limits of floating point rounding would cause errors, so the most recent position should be used before modifying a photo. Optimistic concurrency will catch this, however.

Specified by:

setPosition in interface PhotoData

Parameters:

position - the position of the photo in the album.

setRotation

public void setRotation(java.lang.Integer rotation)

Description copied from interface: PhotoData

Set the rotation in degrees of the photo. This can be used to rotate the photo on the server.

Specified by:

setRotation in interface PhotoData

Parameters:

rotation - the rotation of the photo.

setSize

public void setSize(java.lang.Long size)

Description copied from interface: PhotoData

Set the size of the photo. This is used on the server, setting this on the client will have no effect.

Specified by:

setSize in interface PhotoData

Parameters:

size - the size of the photo in bytes.

setTimestamp

public void setTimestamp(java.util.Date timestamp)

Description copied from interface: PhotoData

Set the timestamp on the photo. This is the time the photo itself was taken.

Specified by:

setTimestamp in interface PhotoData

Parameters:

timestamp - the timestamp on the photo.

setVersion

public void setVersion(java.lang.Long version)

Description copied from interface: PhotoData

Set the version of the photo. Used by the server to set the version, this is read only on the client.

Specified by:

setVersion in interface PhotoData

Parameters:

version - the version of the photo.

setWidth

public void setWidth(java.lang.Long width)

Description copied from interface: PhotoData

Set the width of the photo. Used by the server, this has no effect on the client.

Specified by:

setWidth in interface PhotoData

Parameters:

width - the width of the photo.

setGeoLocation

public void setGeoLocation(java.lang.Double lat,
                           java.lang.Double lon)
                    throws java.lang.IllegalArgumentException

Description copied from interface: PointData

Sets the geo-location of the entity based on the lat and long coordinates passed in. This will create a new Point object if none exists, otherwise it will copy the new coordinates into the existing object.

Specified by:

setGeoLocation in interface PointData

Parameters:

lat - The latitude coordinate, between -90 and 90 degrees.

lon - The longitude coordinate, between -180 and 180 degrees.

Throws:

java.lang.IllegalArgumentException - if the latitude and longitude coordinates are invalid.

setGeoLocation

public void setGeoLocation(Point point)

Description copied from interface: PointData

Sets the geo-location of the entity based on the Point extension. This will use the passed in extension as the geo location if none already exists, otherwise it will copy the given point's data into the existing point object.

Specified by:

setGeoLocation in interface PointData

Parameters:

point - A point containing the latitude and longitude coordinates.

getGeoLocation

public Point getGeoLocation()

Description copied from interface: PointData

Gets the geo-location of the entity.

Specified by:

getGeoLocation in interface PointData

Returns:

a Point that contains the geo-coordinates (latitude and longitude).

clearPoint

public void clearPoint()

Description copied from interface: PointData

Clears the point data and removes the extension point.

Specified by:

clearPoint in interface PointData

clearGeoBoundingBox

public void clearGeoBoundingBox()

Description copied from interface: BoxData

Clears the bounding box and removes the extension point.

Specified by:

clearGeoBoundingBox in interface BoxData

getGeoBoundingBox

public Box getGeoBoundingBox()

Description copied from interface: BoxData

Gets the bounding box of this entity.

Specified by:

getGeoBoundingBox in interface BoxData

Returns:

a Box that contains the boundary for the content of this entity.

setGeoBoundingBox

public void setGeoBoundingBox(Point lowerLeft,
                              Point upperRight)

Description copied from interface: BoxData

Sets the bounding box based on two Point 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.

Specified by:

setGeoBoundingBox in interface BoxData

Parameters:

lowerLeft - the lower left coordinate of the box.

upperRight - the upper right coordinate of the box.

setGeoBoundingBox

public void setGeoBoundingBox(Box boundingBox)

Description copied from interface: BoxData

Sets the bounding box for this entity based on a Box 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.

Specified by:

setGeoBoundingBox in interface BoxData

Parameters:

boundingBox - the box that bounds this entity.

addStreamId

public void addStreamId(java.lang.String streamId)

Description copied from interface: PhotoData

Add an individual streamId to the photo. The streamid is an opaque string stored along with the photo and can be used to identify where a photo is from or used.

Specified by:

addStreamId in interface PhotoData

getStreamIds

public java.util.List<java.lang.String> getStreamIds()

Description copied from interface: PhotoData

Stream ids can be used to specify additional information about where a photo came from, or where it is being used. For example, a client may mark each photo they edit with a streamid so that the list of edited photos can be queried efficiently.

Specified by:

getStreamIds in interface PhotoData

Returns:

a list of streamIds associated with this photo.

getMediaGroup

public MediaGroup getMediaGroup()

Description copied from interface: MediaData

Retrieve the media:group element on this element. This will return null if there was no media:group element set.

Specified by:

getMediaGroup in interface MediaData

Returns:

the media:group element on the element.

getMediaContents

public java.util.List<MediaContent> getMediaContents()

Description copied from interface: MediaData

Retrieve the list of media:content elements inside the media:group on this element. If either the media:group or media:content elements are missing then an empty list will be returned.

Specified by:

getMediaContents in interface MediaData

Returns:

a list of media:content elements found on the element.

getMediaCategories

public java.util.List<MediaCategory> getMediaCategories()

Description copied from interface: MediaData

Retrieve the list of media:category elements inside the media:group on this element. If either the media:group or media:category elements are missing then an empty list will be returned.

Specified by:

getMediaCategories in interface MediaData

Returns:

a list of media:category elements found on the element.

getMediaCredits

public java.util.List<MediaCredit> getMediaCredits()

Description copied from interface: MediaData

Retrieve the list of media:credit elements inside the media:group on this element. If either the media:group or media:credit elements are missing then an empty list will be returned.

Specified by:

getMediaCredits in interface MediaData

Returns:

a list of media:credit elements found on this element.

getMediaThumbnails

public java.util.List<MediaThumbnail> getMediaThumbnails()

Description copied from interface: MediaData

Retrieve the list of media:thumbnail elements inside the media:group on this element. If either the media:group or media:thumbnail elements are missing then an empty list will be returned.

Specified by:

getMediaThumbnails in interface MediaData

Returns:

a list of media:thumbnail elements found on the element.

getMediaKeywords

public MediaKeywords getMediaKeywords()

Description copied from interface: MediaData

Retrieve the list of media:keywords elements inside the media:group on this element. If either the media:group or media:keywords elements are missing then an empty list will be returned.

Specified by:

getMediaKeywords in interface MediaData

Returns:

the media:keywords elements found on the element.

setKeywords

public void setKeywords(MediaKeywords keywords)

Description copied from interface: MediaData

Set the media keywords on this element to the given keywords. Will create the media:group element as needed.

Specified by:

setKeywords in interface MediaData