public class

PhotoEntry

extends GphotoEntry<E extends GphotoEntry<E>>
implements AtomData PhotoData
java.lang.Object
   ↳ com.google.gdata.data.AbstractExtension
     ↳ com.google.gdata.data.ExtensionPoint
       ↳ com.google.gdata.data.BaseEntry<E extends com.google.gdata.data.BaseEntry>
         ↳ com.google.gdata.data.media.MediaEntry<E extends com.google.gdata.data.BaseEntry<E>>
           ↳ com.google.gdata.data.photos.GphotoEntry<E extends com.google.gdata.data.photos.GphotoEntry<E>>
             ↳ com.google.gdata.data.photos.PhotoEntry

Class Overview

Entry for photo kinds, contains photo metadata.

Summary

Constants
String KIND Photo kind term value.
[Expand]
Inherited Constants
From interface com.google.gdata.data.photos.PhotoData
Fields
public static final Category CATEGORY Photo kind category.
[Expand]
Inherited Fields
From class com.google.gdata.data.photos.GphotoEntry
From class com.google.gdata.data.BaseEntry
From class com.google.gdata.data.ExtensionPoint
From class com.google.gdata.data.AbstractExtension
From interface com.google.gdata.data.photos.PhotoData
Public Constructors
PhotoEntry()
Default mutable constructor.
PhotoEntry(BaseEntry<?> sourceEntry)
Constructs a new instance by doing a shallow copy of data from an existing BaseEntry instance.
Public Methods
void addStreamId(String streamId)
Add an individual streamId to the photo.
void addStreamIdsExt(GphotoStreamId streamIdsExt)
Adds a new the streamIds on this 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.
String getAlbumAccess()
GphotoAccess getAlbumAccessExt()
Returns the access level for the album.
String getAlbumId()
The id of the album the photo is on.
GphotoAlbumId getAlbumIdExt()
Returns the album ID of the album this photo is in.
String getChecksum()
The checksum on the photo.
GphotoChecksum getChecksumExt()
Returns the the checksum for the photo provided by the client.
String getClient()
The client string stored on the photo.
GphotoClient getClientExt()
Returns the the client that uploaded the photo.
Integer getCommentCount()
The number of comments on this photo.
GphotoCommentCount getCommentCountExt()
Returns the the count of comments on this photo.
Boolean getCommentsEnabled()
Gets the status of the commenting preference on the photo.
GphotoCommentsEnabled getCommentsEnabledExt()
Returns the whether comments are enabled on this photo.
ExifTags getExifTags()
Returns the the exif information on the photo.
Date getFeaturedDate()
GphotoFeaturedDate getFeaturedDateExt()
Returns the datetime in unix timestamp format for when the photo was featured.
PhotoFeed getFeed(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.
W3CPoint getGeoPoint()
Returns the geolocation as a geo:point.
GeoRssBox getGeoRssBox()
Returns the geo bounding box as a georss:box.
GeoRssPoint getGeoRssPoint()
Returns the geolocation as a georss:point.
GeoRssWhere getGeoRssWhere()
Returns the geolocation as a georss:where.
GmlEnvelope getGmlEnvelope()
Returns the geo bounding box as a gml:Envelope.
GmlPoint getGmlPoint()
Returns the geolocation as a gml:point.
Long getHeight()
The height of the photo in pixels.
GphotoHeight getHeightExt()
Returns the the height of the photo.
GphotoImageVersion getImageVersionExt()
Returns the the version of the image bytes.
List<MediaCategory> getMediaCategories()
Retrieve the list of media:category elements inside the media:group on this element.
List<MediaContent> getMediaContents()
Retrieve the list of media:content elements inside the media:group on this element.
List<MediaCredit> getMediaCredits()
Retrieve the list of media:credit elements inside the media:group on this element.
MediaGroup getMediaGroup()
Returns the mediarss group for media metadata.
MediaKeywords getMediaKeywords()
Retrieve the list of media:keywords elements inside the media:group on this element.
List<MediaThumbnail> getMediaThumbnails()
Retrieve the list of media:thumbnail elements inside the media:group on this element.
GphotoOriginalVideo getOriginalVideo()
Returns the the properties of the original video.
Float getPosition()
The position of the photo in the album.
GphotoPosition getPositionExt()
Returns the position of the photo in its album.
Integer getRotation()
The rotation of the photo.
GphotoRotation getRotationExt()
Returns the the rotation of the photo in degrees.
Long getSize()
The size of the photo in bytes.
GphotoSize getSizeExt()
Returns the the size of the photo in bytes.
GphotoStarred getStarredExt()
Returns the if viewer starred the photo and total number of stars.
List<String> getStreamIds()
Stream ids can be used to specify additional information about where a photo came from, or where it is being used.
List<GphotoStreamId> getStreamIdsExt()
Returns the the streamIds on this photo.
Date getTimestamp()
The time the photo was taken.
GphotoTimestamp getTimestampExt()
Returns the the time the photo was taken.
Integer getTotalStars()
The number of users who starred this photo.
Long getVersion()
The version of the image.
GphotoVersion getVersionExt()
Returns the version of the photo metadata.
String getVideoStatus()
The video status in case the photo entry is a video.
GphotoVideoStatus getVideoStatusExt()
Returns the the status of the video upload if this is a video.
Long getViewCount()
GphotoViewCount getViewCountExt()
Returns the the number of views for this image.
Long getWidth()
The width of the photo in pixels.
GphotoWidth getWidthExt()
Returns the the width of the photo.
boolean hasAlbumAccessExt()
Returns whether it has the access level for the album.
boolean hasAlbumIdExt()
Returns whether it has the album ID of the album this photo is in.
boolean hasChecksumExt()
Returns whether it has the the checksum for the photo provided by the client.
boolean hasClientExt()
Returns whether it has the the client that uploaded the photo.
boolean hasCommentCountExt()
Returns whether it has the the count of comments on this photo.
boolean hasCommentsEnabledExt()
Returns whether it has the whether comments are enabled on this photo.
boolean hasExifTags()
Returns whether it has the the exif information on the photo.
boolean hasFeaturedDateExt()
Returns whether it has the datetime in unix timestamp format for when the photo was featured.
boolean hasGeoPoint()
Returns whether it has the geolocation as a geo:point.
boolean hasGeoRssBox()
Returns whether it has the geo bounding box as a georss:box.
boolean hasGeoRssPoint()
Returns whether it has the geolocation as a georss:point.
boolean hasGeoRssWhere()
Returns whether it has the geolocation as a georss:where.
boolean hasGmlEnvelope()
Returns whether it has the geo bounding box as a gml:Envelope.
boolean hasGmlPoint()
Returns whether it has the geolocation as a gml:point.
boolean hasHeightExt()
Returns whether it has the the height of the photo.
boolean hasImageVersionExt()
Returns whether it has the the version of the image bytes.
boolean hasMediaGroup()
Returns whether it has the mediarss group for media metadata.
boolean hasOriginalVideo()
Returns whether it has the the properties of the original video.
boolean hasPositionExt()
Returns whether it has the position of the photo in its album.
boolean hasRotationExt()
Returns whether it has the the rotation of the photo in degrees.
boolean hasSizeExt()
Returns whether it has the the size of the photo in bytes.
boolean hasStarredExt()
Returns whether it has the if viewer starred the photo and total number of stars.
boolean hasStreamIdsExt()
Returns whether it has the the streamIds on this photo.
boolean hasTimestampExt()
Returns whether it has the the time the photo was taken.
boolean hasVersionExt()
Returns whether it has the version of the photo metadata.
boolean hasVideoStatusExt()
Returns whether it has the the status of the video upload if this is a video.
boolean hasViewCountExt()
Returns whether it has the the number of views for this image.
boolean hasWidthExt()
Returns whether it has the the width of the photo.
Boolean isStarred()
If this photo is starred by current user.
void setAlbumAccess(String access)
Set the access for the album that contains this photo.
void setAlbumAccessExt(GphotoAccess albumAccessExt)
Sets the access level for the album.
void setAlbumId(String albumId)
Set the albumId of the photo as a string, the album the photo is in.
void setAlbumId(Long albumId)
Sets the id of the album the photo is in.
void setAlbumIdExt(GphotoAlbumId albumIdExt)
Sets the album ID of the album this photo is in.
void setChecksum(String checksum)
Set the checksum of the photo.
void setChecksumExt(GphotoChecksum checksumExt)
Sets the the checksum for the photo provided by the client.
void setClient(String client)
Set the client string on the photo.
void setClientExt(GphotoClient clientExt)
Sets the the client that uploaded the photo.
void setCommentCount(Integer commentCount)
Set the number of comments on the photo.
void setCommentCountExt(GphotoCommentCount commentCountExt)
Sets the the count of comments on this photo.
void setCommentsEnabled(Boolean commentsEnabled)
Sets whether comments can be made on the photo.
void setCommentsEnabledExt(GphotoCommentsEnabled commentsEnabledExt)
Sets the whether comments are enabled on this photo.
void setExifTags(ExifTags exifTags)
Sets the the exif information on the photo.
void setFeaturedDate(Date featuredDate)
Sets the date that the photo was featured.
void setFeaturedDateExt(GphotoFeaturedDate featuredDateExt)
Sets the datetime in unix timestamp format for when the photo was featured.
void setGeoBoundingBox(Point lowerLeft, Point upperRight)
Sets the bounding box based on two Point objects.
void setGeoBoundingBox(Box boundingBox)
Sets the bounding box for this entity based on a Box extension.
void setGeoLocation(Double lat, 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 setGeoPoint(W3CPoint geoPoint)
Sets the geolocation as a geo:point.
void setGeoRssBox(GeoRssBox geoRssBox)
Sets the geo bounding box as a georss:box.
void setGeoRssPoint(GeoRssPoint geoRssPoint)
Sets the geolocation as a georss:point.
void setGeoRssWhere(GeoRssWhere geoRssWhere)
Sets the geolocation as a georss:where.
void setGmlEnvelope(GmlEnvelope gmlEnvelope)
Sets the geo bounding box as a gml:Envelope.
void setGmlPoint(GmlPoint gmlPoint)
Sets the geolocation as a gml:point.
void setHeight(Long height)
Set the height of the photo.
void setHeightExt(GphotoHeight heightExt)
Sets the the height of the photo.
void setImageVersionExt(GphotoImageVersion imageVersionExt)
Sets the the version of the image bytes.
void setKeywords(MediaKeywords keywords)
Set the media keywords on this element to the given keywords.
void setMediaGroup(MediaGroup mediaGroup)
Sets the mediarss group for media metadata.
void setOriginalVideo(GphotoOriginalVideo originalVideo)
Sets the the properties of the original video.
void setPosition(Float position)
Set the position of the photo.
void setPositionExt(GphotoPosition positionExt)
Sets the position of the photo in its album.
void setRotation(Integer rotation)
Set the rotation in degrees of the photo.
void setRotationExt(GphotoRotation rotationExt)
Sets the the rotation of the photo in degrees.
void setSize(Long size)
Set the size of the photo.
void setSizeExt(GphotoSize sizeExt)
Sets the the size of the photo in bytes.
void setStarred(Boolean starred)
Sets if this photo is starred by current user.
void setStarredExt(GphotoStarred starredExt)
Sets the if viewer starred the photo and total number of stars.
void setTimestamp(Date timestamp)
Set the timestamp on the photo.
void setTimestampExt(GphotoTimestamp timestampExt)
Sets the the time the photo was taken.
void setTotalStars(Integer totalStars)
Sets the number of users who starred this photo.
void setVersion(Long version)
Set the version of the photo.
void setVersionExt(GphotoVersion versionExt)
Sets the version of the photo metadata.
void setVideoStatus(String videoStatus)
Set the video status of the photo entry.
void setVideoStatusExt(GphotoVideoStatus videoStatusExt)
Sets the the status of the video upload if this is a video.
void setViewCount(Long viewCount)
Sets the view count for this photo.
void setViewCountExt(GphotoViewCount viewCountExt)
Sets the the number of views for this image.
void setWidth(Long width)
Set the width of the photo.
void setWidthExt(GphotoWidth widthExt)
Sets the the width of the photo.
String toString()
Protected Methods
void validate()
Checks the attributes to see if there are any problems.
[Expand]
Inherited Methods
From class com.google.gdata.data.photos.GphotoEntry
From class com.google.gdata.data.media.MediaEntry
From class com.google.gdata.data.BaseEntry
From class com.google.gdata.data.ExtensionPoint
From class com.google.gdata.data.AbstractExtension
From class java.lang.Object
From interface com.google.gdata.data.Extension
From interface com.google.gdata.data.IAtom
From interface com.google.gdata.data.IEntry
From interface com.google.gdata.data.Kind.Adaptable
From interface com.google.gdata.data.Kind.Adaptor
From interface com.google.gdata.data.geo.BoxData
From interface com.google.gdata.data.geo.PointData
From interface com.google.gdata.data.media.IMediaEntry
From interface com.google.gdata.data.photos.AtomData
From interface com.google.gdata.data.photos.Extensible
From interface com.google.gdata.data.photos.GphotoData
From interface com.google.gdata.data.photos.MediaData
From interface com.google.gdata.data.photos.PhotoData

Constants

public static final String KIND

Photo kind term value.

Constant Value: "http://schemas.google.com/photos/2007#photo"

Fields

public static final Category CATEGORY

Photo kind category.

Public Constructors

public PhotoEntry ()

Default mutable constructor.

public PhotoEntry (BaseEntry<?> sourceEntry)

Constructs a new instance by doing a shallow copy of data from an existing BaseEntry instance.

Parameters
sourceEntry Source entry

Public Methods

public void addStreamId (String streamId)

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.

Parameters
streamId

public void addStreamIdsExt (GphotoStreamId streamIdsExt)

Adds a new the streamIds on this photo.

Parameters
streamIdsExt The streamIds on this photo

public void clearGeoBoundingBox ()

Clears the bounding box and removes the extension point.

public void clearPoint ()

Clears the point data and removes the extension point.

public void declareExtensions (ExtensionProfile extProfile)

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.

Parameters
extProfile The ExtensionProfile to initialize.

public String getAlbumAccess ()

public GphotoAccess getAlbumAccessExt ()

Returns the access level for the album.

Returns
  • access level for the album

public String getAlbumId ()

The id of the album the photo is on.

Returns
  • the gphoto:albumId of the photo.

public GphotoAlbumId getAlbumIdExt ()

Returns the album ID of the album this photo is in.

Returns
  • album ID of the album this photo is in

public String getChecksum ()

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.

Returns
  • the gphoto:checksum of the photo.

public GphotoChecksum getChecksumExt ()

Returns the the checksum for the photo provided by the client.

Returns
  • the checksum for the photo provided by the client

public String getClient ()

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

Returns
  • the gphoto:client of the photo.

public GphotoClient getClientExt ()

Returns the the client that uploaded the photo.

Returns
  • the client that uploaded the photo

public Integer getCommentCount ()

The number of comments on this photo.

Returns
  • the comment count on the photo.
Throws
ServiceException no longer, but used to.

public GphotoCommentCount getCommentCountExt ()

Returns the the count of comments on this photo.

Returns
  • the count of comments on this photo

public Boolean getCommentsEnabled ()

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

Returns
  • true if comments are enabled on the photo.
Throws
ServiceException no longer, but used to.

public GphotoCommentsEnabled getCommentsEnabledExt ()

Returns the whether comments are enabled on this photo.

Returns
  • whether comments are enabled on this photo

public ExifTags getExifTags ()

Returns the the exif information on the photo.

Returns
  • the exif information on the photo

public Date getFeaturedDate ()

Returns
  • date that the photo was featured.

public GphotoFeaturedDate getFeaturedDateExt ()

Returns the datetime in unix timestamp format for when the photo was featured.

Returns
  • datetime in unix timestamp format for when the photo was featured

public PhotoFeed getFeed (String... kinds)

Retrieve the photo feed and associated entries. The kinds parameter is a list of the type of associated entries to return. For example PhotoFeed photoAndComments = photoEntry.getFeed(CommentEntry.KIND, TagEntry.KIND); If no kind parameters are passed, the default of 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
IOException
ServiceException
See Also

public Box getGeoBoundingBox ()

Gets the bounding box of this entity.

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

public Point getGeoLocation ()

Gets the geo-location of the entity.

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

public W3CPoint getGeoPoint ()

Returns the geolocation as a geo:point.

Returns
  • geolocation as a geo:point

public GeoRssBox getGeoRssBox ()

Returns the geo bounding box as a georss:box.

Returns
  • geo bounding box as a georss:box

public GeoRssPoint getGeoRssPoint ()

Returns the geolocation as a georss:point.

Returns
  • geolocation as a georss:point

public GeoRssWhere getGeoRssWhere ()

Returns the geolocation as a georss:where.

Returns
  • geolocation as a georss:where

public GmlEnvelope getGmlEnvelope ()

Returns the geo bounding box as a gml:Envelope.

Returns
  • geo bounding box as a gml:Envelope

public GmlPoint getGmlPoint ()

Returns the geolocation as a gml:point.

Returns
  • geolocation as a gml:point

public Long getHeight ()

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).

Returns
  • the gphoto:height of the photo.
Throws
ServiceException no longer, but used to.

public GphotoHeight getHeightExt ()

Returns the the height of the photo.

Returns
  • the height of the photo

public GphotoImageVersion getImageVersionExt ()

Returns the the version of the image bytes.

Returns
  • the version of the image bytes

public List<MediaCategory> getMediaCategories ()

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.

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

public List<MediaContent> getMediaContents ()

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.

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

public List<MediaCredit> getMediaCredits ()

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.

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

public MediaGroup getMediaGroup ()

Returns the mediarss group for media metadata.

Returns
  • mediarss group for media metadata

public MediaKeywords getMediaKeywords ()

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 null will be returned.

Returns
  • the media:keywords elements found on the element, or null.

public List<MediaThumbnail> getMediaThumbnails ()

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.

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

public GphotoOriginalVideo getOriginalVideo ()

Returns the the properties of the original video.

Returns
  • the properties of the original video

public Float getPosition ()

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.

Returns
  • the gphoto:position of the photo.
Throws
ServiceException no longer, but used to.

public GphotoPosition getPositionExt ()

Returns the position of the photo in its album.

Returns
  • position of the photo in its album

public Integer getRotation ()

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.

Returns
  • the gphoto:rotation of the photo.
Throws
ServiceException no longer, but used to.

public GphotoRotation getRotationExt ()

Returns the the rotation of the photo in degrees.

Returns
  • the rotation of the photo in degrees

public Long getSize ()

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

Returns
  • the gphoto:size of the photo.
Throws
ServiceException no longer, but used to.

public GphotoSize getSizeExt ()

Returns the the size of the photo in bytes.

Returns
  • the size of the photo in bytes

public GphotoStarred getStarredExt ()

Returns the if viewer starred the photo and total number of stars.

Returns
  • if viewer starred the photo and total number of stars

public List<String> getStreamIds ()

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.

Returns
  • a list of streamIds associated with this photo.

public List<GphotoStreamId> getStreamIdsExt ()

Returns the the streamIds on this photo.

Returns
  • the streamIds on this photo

public Date getTimestamp ()

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

Returns
  • the gphoto:timestamp of the photo.
Throws
ServiceException no longer, but used to.

public GphotoTimestamp getTimestampExt ()

Returns the the time the photo was taken.

Returns
  • the time the photo was taken

public Integer getTotalStars ()

The number of users who starred this photo.

Returns
  • the number of users who starred this photo.

public Long getVersion ()

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).

Returns
  • the gphoto:version on the photo.
Throws
ServiceException no longer, but used to.

public GphotoVersion getVersionExt ()

Returns the version of the photo metadata.

Returns
  • version of the photo metadata

public String getVideoStatus ()

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

Returns
  • the gphoto:videostatus of the video/photo.

public GphotoVideoStatus getVideoStatusExt ()

Returns the the status of the video upload if this is a video.

Returns
  • the status of the video upload if this is a video

public Long getViewCount ()

Returns
  • the number of views for this photo.

public GphotoViewCount getViewCountExt ()

Returns the the number of views for this image.

Returns
  • the number of views for this image

public Long getWidth ()

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).

Returns
  • the gphoto:width of the photo.
Throws
ServiceException no longer, but used to.

public GphotoWidth getWidthExt ()

Returns the the width of the photo.

Returns
  • the width of the photo

public boolean hasAlbumAccessExt ()

Returns whether it has the access level for the album.

Returns
  • whether it has the access level for the album

public boolean hasAlbumIdExt ()

Returns whether it has the album ID of the album this photo is in.

Returns
  • whether it has the album ID of the album this photo is in

public boolean hasChecksumExt ()

Returns whether it has the the checksum for the photo provided by the client.

Returns
  • whether it has the the checksum for the photo provided by the client

public boolean hasClientExt ()

Returns whether it has the the client that uploaded the photo.

Returns
  • whether it has the the client that uploaded the photo

public boolean hasCommentCountExt ()

Returns whether it has the the count of comments on this photo.

Returns
  • whether it has the the count of comments on this photo

public boolean hasCommentsEnabledExt ()

Returns whether it has the whether comments are enabled on this photo.

Returns
  • whether it has the whether comments are enabled on this photo

public boolean hasExifTags ()

Returns whether it has the the exif information on the photo.

Returns
  • whether it has the the exif information on the photo

public boolean hasFeaturedDateExt ()

Returns whether it has the datetime in unix timestamp format for when the photo was featured.

Returns
  • whether it has the datetime in unix timestamp format for when the photo was featured

public boolean hasGeoPoint ()

Returns whether it has the geolocation as a geo:point.

Returns
  • whether it has the geolocation as a geo:point

public boolean hasGeoRssBox ()

Returns whether it has the geo bounding box as a georss:box.

Returns
  • whether it has the geo bounding box as a georss:box

public boolean hasGeoRssPoint ()

Returns whether it has the geolocation as a georss:point.

Returns
  • whether it has the geolocation as a georss:point

public boolean hasGeoRssWhere ()

Returns whether it has the geolocation as a georss:where.

Returns
  • whether it has the geolocation as a georss:where

public boolean hasGmlEnvelope ()

Returns whether it has the geo bounding box as a gml:Envelope.

Returns
  • whether it has the geo bounding box as a gml:Envelope

public boolean hasGmlPoint ()

Returns whether it has the geolocation as a gml:point.

Returns
  • whether it has the geolocation as a gml:point

public boolean hasHeightExt ()

Returns whether it has the the height of the photo.

Returns
  • whether it has the the height of the photo

public boolean hasImageVersionExt ()

Returns whether it has the the version of the image bytes.

Returns
  • whether it has the the version of the image bytes

public boolean hasMediaGroup ()

Returns whether it has the mediarss group for media metadata.

Returns
  • whether it has the mediarss group for media metadata

public boolean hasOriginalVideo ()

Returns whether it has the the properties of the original video.

Returns
  • whether it has the the properties of the original video

public boolean hasPositionExt ()

Returns whether it has the position of the photo in its album.

Returns
  • whether it has the position of the photo in its album

public boolean hasRotationExt ()

Returns whether it has the the rotation of the photo in degrees.

Returns
  • whether it has the the rotation of the photo in degrees

public boolean hasSizeExt ()

Returns whether it has the the size of the photo in bytes.

Returns
  • whether it has the the size of the photo in bytes

public boolean hasStarredExt ()

Returns whether it has the if viewer starred the photo and total number of stars.

Returns
  • whether it has the if viewer starred the photo and total number of stars

public boolean hasStreamIdsExt ()

Returns whether it has the the streamIds on this photo.

Returns
  • whether it has the the streamIds on this photo

public boolean hasTimestampExt ()

Returns whether it has the the time the photo was taken.

Returns
  • whether it has the the time the photo was taken

public boolean hasVersionExt ()

Returns whether it has the version of the photo metadata.

Returns
  • whether it has the version of the photo metadata

public boolean hasVideoStatusExt ()

Returns whether it has the the status of the video upload if this is a video.

Returns
  • whether it has the the status of the video upload if this is a video

public boolean hasViewCountExt ()

Returns whether it has the the number of views for this image.

Returns
  • whether it has the the number of views for this image

public boolean hasWidthExt ()

Returns whether it has the the width of the photo.

Returns
  • whether it has the the width of the photo

public Boolean isStarred ()

If this photo is starred by current user.

Returns
  • if this photo is starred by current user.

public void setAlbumAccess (String access)

Set the access for the album that contains this photo.

Parameters
access The access of the album.

public void setAlbumAccessExt (GphotoAccess albumAccessExt)

Sets the access level for the album.

Parameters
albumAccessExt Access level for the album or null to reset

public void setAlbumId (String albumId)

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

Parameters
albumId

public void setAlbumId (Long albumId)

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.

Parameters
albumId

public void setAlbumIdExt (GphotoAlbumId albumIdExt)

Sets the album ID of the album this photo is in.

Parameters
albumIdExt Album ID of the album this photo is in or null to reset

public void setChecksum (String checksum)

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

Parameters
checksum The checksum on the photo, computed by a client.

public void setChecksumExt (GphotoChecksum checksumExt)

Sets the the checksum for the photo provided by the client.

Parameters
checksumExt The checksum for the photo provided by the client or null to reset

public void setClient (String client)

Set the client string on the photo.

Parameters
client The client that created the photo.

public void setClientExt (GphotoClient clientExt)

Sets the the client that uploaded the photo.

Parameters
clientExt The client that uploaded the photo or null to reset

public void setCommentCount (Integer commentCount)

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

Parameters
commentCount The number of comments on the photo.

public void setCommentCountExt (GphotoCommentCount commentCountExt)

Sets the the count of comments on this photo.

Parameters
commentCountExt The count of comments on this photo or null to reset

public void setCommentsEnabled (Boolean commentsEnabled)

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.

Parameters
commentsEnabled True if comments are enabled in the photo.

public void setCommentsEnabledExt (GphotoCommentsEnabled commentsEnabledExt)

Sets the whether comments are enabled on this photo.

Parameters
commentsEnabledExt Whether comments are enabled on this photo or null to reset

public void setExifTags (ExifTags exifTags)

Sets the the exif information on the photo.

Parameters
exifTags The exif information on the photo or null to reset

public void setFeaturedDate (Date featuredDate)

Sets the date that the photo was featured.

Parameters
featuredDate The date that the photo was featured.

public void setFeaturedDateExt (GphotoFeaturedDate featuredDateExt)

Sets the datetime in unix timestamp format for when the photo was featured.

Parameters
featuredDateExt Datetime in unix timestamp format for when the photo was featured or null to reset

public void setGeoBoundingBox (Point lowerLeft, Point upperRight)

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.

Parameters
lowerLeft The lower left coordinate of the box.
upperRight The upper right coordinate of the box.

public void setGeoBoundingBox (Box boundingBox)

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.

Parameters
boundingBox The box that bounds this entity.

public void setGeoLocation (Double lat, Double lon)

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.

Parameters
lat The latitude coordinate, between -90 and 90 degrees.
lon The longitude coordinate, between -180 and 180 degrees.

public void setGeoLocation (Point point)

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.

Parameters
point A point containing the latitude and longitude coordinates.

public void setGeoPoint (W3CPoint geoPoint)

Sets the geolocation as a geo:point.

Parameters
geoPoint Geolocation as a geo:point or null to reset

public void setGeoRssBox (GeoRssBox geoRssBox)

Sets the geo bounding box as a georss:box.

Parameters
geoRssBox Geo bounding box as a georss:box or null to reset

public void setGeoRssPoint (GeoRssPoint geoRssPoint)

Sets the geolocation as a georss:point.

Parameters
geoRssPoint Geolocation as a georss:point or null to reset

public void setGeoRssWhere (GeoRssWhere geoRssWhere)

Sets the geolocation as a georss:where.

Parameters
geoRssWhere Geolocation as a georss:where or null to reset

public void setGmlEnvelope (GmlEnvelope gmlEnvelope)

Sets the geo bounding box as a gml:Envelope.

Parameters
gmlEnvelope Geo bounding box as a gml:Envelope or null to reset

public void setGmlPoint (GmlPoint gmlPoint)

Sets the geolocation as a gml:point.

Parameters
gmlPoint Geolocation as a gml:point or null to reset

public void setHeight (Long height)

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

Parameters
height The height of the photo.

public void setHeightExt (GphotoHeight heightExt)

Sets the the height of the photo.

Parameters
heightExt The height of the photo or null to reset

public void setImageVersionExt (GphotoImageVersion imageVersionExt)

Sets the the version of the image bytes.

Parameters
imageVersionExt The version of the image bytes or null to reset

public void setKeywords (MediaKeywords keywords)

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

Parameters
keywords

public void setMediaGroup (MediaGroup mediaGroup)

Sets the mediarss group for media metadata.

Parameters
mediaGroup Mediarss group for media metadata or null to reset

public void setOriginalVideo (GphotoOriginalVideo originalVideo)

Sets the the properties of the original video.

Parameters
originalVideo The properties of the original video or null to reset

public void setPosition (Float position)

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.

Parameters
position The position of the photo in the album.

public void setPositionExt (GphotoPosition positionExt)

Sets the position of the photo in its album.

Parameters
positionExt Position of the photo in its album or null to reset

public void setRotation (Integer rotation)

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

Parameters
rotation The rotation of the photo.

public void setRotationExt (GphotoRotation rotationExt)

Sets the the rotation of the photo in degrees.

Parameters
rotationExt The rotation of the photo in degrees or null to reset

public void setSize (Long size)

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

Parameters
size The size of the photo in bytes.

public void setSizeExt (GphotoSize sizeExt)

Sets the the size of the photo in bytes.

Parameters
sizeExt The size of the photo in bytes or null to reset

public void setStarred (Boolean starred)

Sets if this photo is starred by current user.

Parameters
starred If this photo is starred by current user.

public void setStarredExt (GphotoStarred starredExt)

Sets the if viewer starred the photo and total number of stars.

Parameters
starredExt If viewer starred the photo and total number of stars or null to reset

public void setTimestamp (Date timestamp)

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

Parameters
timestamp The timestamp on the photo.

public void setTimestampExt (GphotoTimestamp timestampExt)

Sets the the time the photo was taken.

Parameters
timestampExt The time the photo was taken or null to reset

public void setTotalStars (Integer totalStars)

Sets the number of users who starred this photo.

Parameters
totalStars The number of users who starred this photo.

public void setVersion (Long version)

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

Parameters
version The version of the photo.

public void setVersionExt (GphotoVersion versionExt)

Sets the version of the photo metadata.

Parameters
versionExt Version of the photo metadata or null to reset

public void setVideoStatus (String videoStatus)

Set the video status of the photo entry.

Parameters
videoStatus

public void setVideoStatusExt (GphotoVideoStatus videoStatusExt)

Sets the the status of the video upload if this is a video.

Parameters
videoStatusExt The status of the video upload if this is a video or null to reset

public void setViewCount (Long viewCount)

Sets the view count for this photo.

Parameters
viewCount The number of views for this photo.

public void setViewCountExt (GphotoViewCount viewCountExt)

Sets the the number of views for this image.

Parameters
viewCountExt The number of views for this image or null to reset

public void setWidth (Long width)

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

Parameters
width The width of the photo.

public void setWidthExt (GphotoWidth widthExt)

Sets the the width of the photo.

Parameters
widthExt The width of the photo or null to reset

public String toString ()

Protected Methods

protected void validate ()

Checks the attributes to see if there are any problems. Default implementation does nothing, though generally this is discouraged unless there really are no restrictions.