|
|||||||||
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.BaseEntry<E>
com.google.gdata.data.media.MediaEntry<E>
com.google.gdata.data.photos.GphotoEntry<PhotoEntry>
com.google.gdata.data.photos.PhotoEntry
public class PhotoEntry
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.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 |
---|
public PhotoEntry()
public PhotoEntry(BaseEntry<?> sourceEntry)
Method Detail |
---|
public void declareExtensions(ExtensionProfile extProfile)
ExtensionPoint
declareExtensions
in interface Kind.Adaptor
declareExtensions
in interface Extensible
declareExtensions
in class GphotoEntry<PhotoEntry>
extProfile
- the ExtensionProfile to initialize.ExtensionProfile.addDeclarations(Kind.Adaptor)
public PhotoFeed getFeed(java.lang.String... kinds) throws java.io.IOException, ServiceException
PhotoFeed photoTagsAndComments = photoEntry.getFeed(CommentData.KIND,
TagData.KIND);
If no kind parameters are passed, the default of
CommentData.KIND
will be used.
kinds
- the kinds of entries to retrieve, or empty to use the default.
java.io.IOException
ServiceException
CommentData.KIND
,
TagData.KIND
public java.lang.String getAlbumId()
PhotoData
getAlbumId
in interface PhotoData
public java.lang.String getVideoStatus()
PhotoData
getVideoStatus
in interface PhotoData
public java.lang.String getChecksum()
PhotoData
getChecksum
in interface PhotoData
public java.lang.String getClient()
PhotoData
getClient
in interface PhotoData
public java.lang.Integer getCommentCount() throws ServiceException
PhotoData
getCommentCount
in interface PhotoData
ServiceException
public java.lang.Boolean getCommentsEnabled() throws ServiceException
PhotoData
getCommentsEnabled
in interface PhotoData
ServiceException
public ExifTags getExifTags()
PhotoData
ExifTags
for more information on available exif fields.
getExifTags
in interface PhotoData
public java.lang.Long getHeight() throws ServiceException
PhotoData
getHeight
in interface PhotoData
ServiceException
public java.lang.Float getPosition() throws ServiceException
PhotoData
getPosition
in interface PhotoData
ServiceException
public java.lang.Integer getRotation() throws ServiceException
PhotoData
getRotation
in interface PhotoData
ServiceException
public java.lang.Long getSize() throws ServiceException
PhotoData
getSize
in interface PhotoData
ServiceException
public java.util.Date getTimestamp() throws ServiceException
PhotoData
getTimestamp
in interface PhotoData
ServiceException
public java.lang.Long getVersion() throws ServiceException
PhotoData
getVersion
in interface PhotoData
ServiceException
public java.lang.Long getWidth() throws ServiceException
PhotoData
getWidth
in interface PhotoData
ServiceException
public void setAlbumId(java.lang.Long albumId)
PhotoData
setAlbumId
in interface PhotoData
public void setAlbumId(java.lang.String albumId)
PhotoData
setAlbumId
in interface PhotoData
public void setVideoStatus(java.lang.String videoStatus)
PhotoData
setVideoStatus
in interface PhotoData
public void setChecksum(java.lang.String checksum)
PhotoData
setChecksum
in interface PhotoData
checksum
- the checksum on the photo, computed by a client.public void setClient(java.lang.String client)
PhotoData
setClient
in interface PhotoData
client
- the client that created the photo.public void setCommentCount(java.lang.Integer commentCount)
PhotoData
setCommentCount
in interface PhotoData
commentCount
- the number of comments on the photo.public void setCommentsEnabled(java.lang.Boolean commentsEnabled)
PhotoData
setCommentsEnabled
in interface PhotoData
commentsEnabled
- true if comments are enabled in the photo.public void setExifTags(ExifTags tags)
PhotoData
setExifTags
in interface PhotoData
tags
- the exif tags for the photo, a collection of exif tags.public void setHeight(java.lang.Long height)
PhotoData
setHeight
in interface PhotoData
height
- the height of the photo.public void setPosition(java.lang.Float position)
PhotoData
setPosition
in interface PhotoData
position
- the position of the photo in the album.public void setRotation(java.lang.Integer rotation)
PhotoData
setRotation
in interface PhotoData
rotation
- the rotation of the photo.public void setSize(java.lang.Long size)
PhotoData
setSize
in interface PhotoData
size
- the size of the photo in bytes.public void setTimestamp(java.util.Date timestamp)
PhotoData
setTimestamp
in interface PhotoData
timestamp
- the timestamp on the photo.public void setVersion(java.lang.Long version)
PhotoData
setVersion
in interface PhotoData
version
- the version of the photo.public void setWidth(java.lang.Long width)
PhotoData
setWidth
in interface PhotoData
width
- the width of the photo.public void setGeoLocation(java.lang.Double lat, java.lang.Double lon) throws java.lang.IllegalArgumentException
PointData
setGeoLocation
in interface PointData
lat
- 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 PointData
point
- A point containing the latitude and longitude coordinates.public Point getGeoLocation()
PointData
getGeoLocation
in interface PointData
public void clearPoint()
PointData
clearPoint
in interface PointData
public void clearGeoBoundingBox()
BoxData
clearGeoBoundingBox
in interface BoxData
public Box getGeoBoundingBox()
BoxData
getGeoBoundingBox
in interface BoxData
public void setGeoBoundingBox(Point lowerLeft, Point upperRight)
BoxData
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.
setGeoBoundingBox
in interface BoxData
lowerLeft
- the lower left coordinate of the box.upperRight
- the upper right coordinate of the box.public void setGeoBoundingBox(Box boundingBox)
BoxData
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.
setGeoBoundingBox
in interface BoxData
boundingBox
- the box that bounds this entity.public void addStreamId(java.lang.String streamId)
PhotoData
addStreamId
in interface PhotoData
public java.util.List<java.lang.String> getStreamIds()
PhotoData
getStreamIds
in interface PhotoData
public MediaGroup getMediaGroup()
MediaData
getMediaGroup
in interface MediaData
public java.util.List<MediaContent> getMediaContents()
MediaData
getMediaContents
in interface MediaData
public java.util.List<MediaCategory> getMediaCategories()
MediaData
getMediaCategories
in interface MediaData
public java.util.List<MediaCredit> getMediaCredits()
MediaData
getMediaCredits
in interface MediaData
public java.util.List<MediaThumbnail> getMediaThumbnails()
MediaData
getMediaThumbnails
in interface MediaData
public MediaKeywords getMediaKeywords()
MediaData
getMediaKeywords
in interface MediaData
public void setKeywords(MediaKeywords keywords)
MediaData
setKeywords
in interface MediaData
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |