|
|||||||||
| 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<AlbumEntry>
com.google.gdata.data.photos.AlbumEntry
public class AlbumEntry
Entry for album kinds, contains album metadata.
| 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 | |
|---|---|
static Category |
CATEGORY
Album kind category. |
static java.lang.String |
KIND
Album kind term value. |
| 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.AlbumData |
|---|
ALBUM_CATEGORY, ALBUM_KIND |
| Constructor Summary | |
|---|---|
AlbumEntry()
Default mutable constructor. |
|
AlbumEntry(BaseEntry<?> sourceEntry)
Constructs a new instance by doing a shallow copy of data from an existing BaseEntry instance. |
|
| Method Summary | |
|---|---|
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 |
getAccess()
The access level of the album, either private, protected, or public. |
GphotoAccess |
getAccessExt()
Returns the access level for the album. |
java.lang.Long |
getBytesUsed()
The number of bytes that are used by photos in this album. |
GphotoBytesUsed |
getBytesUsedExt()
Returns the number of bytes used by this album. |
java.lang.Integer |
getCommentCount()
The number of comments on the album. |
GphotoCommentCount |
getCommentCountExt()
Returns the number of comments on this album. |
java.lang.Boolean |
getCommentsEnabled()
Whether or not commenting is allowed on this album. |
GphotoCommentsEnabled |
getCommentsEnabledExt()
Returns the comments enabled field, which is true if comments are enabled for this album. |
java.util.Date |
getDate()
The date the album was taken. |
GphotoTimestamp |
getDateExt()
Returns the user date of the album. |
AlbumFeed |
getFeed(java.lang.String... kinds)
Retrieve the album 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. |
java.lang.String |
getLocation()
The location of the album is a string representing where the photos in the album where taken. |
GphotoLocation |
getLocationExt()
Returns the textual location of the album. |
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()
Returns the mediarss group for media metadata. |
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.String |
getName()
The name of the album is its canonicalized title. |
GphotoName |
getNameExt()
Returns the canonical name of the album. |
java.lang.String |
getNickname()
The nickname of the user who owns the album. |
GphotoNickname |
getNicknameExt()
Returns the nickname of the owner of the album. |
java.lang.Integer |
getPhotosLeft()
The number of spaces for photos that are available in the album. |
GphotoPhotosLeft |
getPhotosLeftExt()
Returns the number of photos that can be uploaded to this album. |
java.lang.Integer |
getPhotosUsed()
The number of photos that are contained in this album. |
GphotoPhotosUsed |
getPhotosUsedExt()
Returns the number of photos that have been uploaded to this album. |
java.lang.String |
getUsername()
The username of the owner of the album. |
GphotoUsername |
getUsernameExt()
Returns the username of the owner of the album. |
boolean |
hasAccessExt()
Returns whether it has the access level for the album. |
boolean |
hasBytesUsedExt()
Returns whether it has the number of bytes used by this album. |
boolean |
hasCommentCountExt()
Returns whether it has the number of comments on this album. |
boolean |
hasCommentsEnabledExt()
Returns whether it has the comments enabled field, which is true if comments are enabled for this album. |
boolean |
hasDateExt()
Returns whether it has the user date of the album. |
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 |
hasLocationExt()
Returns whether it has the textual location of the album. |
boolean |
hasMediaGroup()
Returns whether it has the mediarss group for media metadata. |
boolean |
hasNameExt()
Returns whether it has the canonical name of the album. |
boolean |
hasNicknameExt()
Returns whether it has the nickname of the owner of the album. |
boolean |
hasPhotosLeftExt()
Returns whether it has the number of photos that can be uploaded to this album. |
boolean |
hasPhotosUsedExt()
Returns whether it has the number of photos that have been uploaded to this album. |
boolean |
hasUsernameExt()
Returns whether it has the username of the owner of the album. |
void |
setAccess(java.lang.String access)
Set the access for the album this data object represents. |
void |
setAccessExt(GphotoAccess accessExt)
Sets the access level for the album. |
void |
setBytesUsed(java.lang.Long bytesUsed)
Set the number of bytes used in the album this data object represents. |
void |
setBytesUsedExt(GphotoBytesUsed bytesUsedExt)
Sets the number of bytes used by this album. |
void |
setCommentCount(java.lang.Integer commentCount)
Set the number of comments on the album. |
void |
setCommentCountExt(GphotoCommentCount commentCountExt)
Sets the number of comments on this album. |
void |
setCommentsEnabled(java.lang.Boolean commentsEnabled)
Set the whether comments are enabled in the album. |
void |
setCommentsEnabledExt(GphotoCommentsEnabled commentsEnabledExt)
Sets the comments enabled field, which is true if comments are enabled for this album. |
void |
setDate(java.util.Date date)
Set the date of the album. |
void |
setDateExt(GphotoTimestamp dateExt)
Sets the user date of the album. |
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 |
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 |
setKeywords(MediaKeywords keywords)
Set the media keywords on this element to the given keywords. |
void |
setLocation(java.lang.String location)
Set the location string for where the photos in the album were taken. |
void |
setLocationExt(GphotoLocation locationExt)
Sets the textual location of the album. |
void |
setMediaGroup(MediaGroup mediaGroup)
Sets the mediarss group for media metadata. |
void |
setName(java.lang.String name)
Set the canonical name of the album. |
void |
setNameExt(GphotoName nameExt)
Sets the canonical name of the album. |
void |
setNickname(java.lang.String nickname)
Set the nickname for the owner of the album this data object represents. |
void |
setNicknameExt(GphotoNickname nicknameExt)
Sets the nickname of the owner of the album. |
void |
setPhotosLeft(java.lang.Integer photosLeft)
Set the number of photos remaining that can be uploaded to this album. |
void |
setPhotosLeftExt(GphotoPhotosLeft photosLeftExt)
Sets the number of photos that can be uploaded to this album. |
void |
setPhotosUsed(java.lang.Integer photosUsed)
Set the number of photos used on the album this data object represents. |
void |
setPhotosUsedExt(GphotoPhotosUsed photosUsedExt)
Sets the number of photos that have been uploaded to this album. |
void |
setUsername(java.lang.String username)
Set the username for the owner of the album this data object represents. |
void |
setUsernameExt(GphotoUsername usernameExt)
Sets the username of the owner of the album. |
java.lang.String |
toString()
|
protected void |
validate()
Checks the attributes to see if there are any problems. |
| 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, getKind, getLink, getLinks, getLinks, getPlainTextContent, getPubControl, getPublished, getRights, getSelf, getSelfLink, getService, getSource, getSummary, getTextContent, getTitle, getUpdated, getVersionId, isDraft, parseAtom, parseAtom, parseAtom, readEntry, readEntry, removeLinks, removeLinks, setCanEdit, setContent, setContent, setDraft, setEdited, setEtag, setId, setKind, 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 |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface com.google.gdata.data.photos.AtomData |
|---|
getAuthors, getCategories, getContributors, getDescription, getId, getLinks, getRights, getTitle, getUpdated, setDescription, setId, setRights, setTitle, setUpdated |
| Methods inherited from interface com.google.gdata.data.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.IEntry |
|---|
getCanEdit, getContent, getEdited, getEditLink, getPublished, getSummary, setCanEdit, setEdited, setPublished |
| Methods inherited from interface com.google.gdata.data.IAtom |
|---|
addLink, getAuthors, getCategories, getEtag, getId, getKind, getLink, getLinks, getSelfLink, getTitle, getUpdated, getVersionId, removeLinks, removeLinks, setEtag, setId, setKind, setUpdated, setVersionId |
| Field Detail |
|---|
public static final java.lang.String KIND
public static final Category CATEGORY
| Constructor Detail |
|---|
public AlbumEntry()
public AlbumEntry(BaseEntry<?> sourceEntry)
BaseEntry instance.
sourceEntry - source entry| Method Detail |
|---|
public void declareExtensions(ExtensionProfile extProfile)
ExtensionPoint
declareExtensions in interface Kind.AdaptordeclareExtensions in interface ExtensibledeclareExtensions in class GphotoEntry<AlbumEntry>extProfile - the ExtensionProfile to initialize.ExtensionProfile.addDeclarations(Kind.Adaptor)public GphotoAccess getAccessExt()
public void setAccessExt(GphotoAccess accessExt)
accessExt - access level for the album or null to resetpublic boolean hasAccessExt()
public GphotoBytesUsed getBytesUsedExt()
public void setBytesUsedExt(GphotoBytesUsed bytesUsedExt)
bytesUsedExt - number of bytes used by this album or null
to resetpublic boolean hasBytesUsedExt()
public GphotoCommentCount getCommentCountExt()
public void setCommentCountExt(GphotoCommentCount commentCountExt)
commentCountExt - number of comments on this album or
null to resetpublic boolean hasCommentCountExt()
public GphotoCommentsEnabled getCommentsEnabledExt()
public void setCommentsEnabledExt(GphotoCommentsEnabled commentsEnabledExt)
commentsEnabledExt - comments enabled field, which is true if comments
are enabled for this album or null to resetpublic boolean hasCommentsEnabledExt()
public GphotoTimestamp getDateExt()
public void setDateExt(GphotoTimestamp dateExt)
dateExt - user date of the album or null to resetpublic boolean hasDateExt()
public W3CPoint getGeoPoint()
public void setGeoPoint(W3CPoint geoPoint)
geoPoint - geolocation as a geo:point or null to resetpublic boolean hasGeoPoint()
public GeoRssBox getGeoRssBox()
public void setGeoRssBox(GeoRssBox geoRssBox)
geoRssBox - geo bounding box as a georss:box or null to
resetpublic boolean hasGeoRssBox()
public GeoRssPoint getGeoRssPoint()
public void setGeoRssPoint(GeoRssPoint geoRssPoint)
geoRssPoint - geolocation as a georss:point or null to
resetpublic boolean hasGeoRssPoint()
public GeoRssWhere getGeoRssWhere()
public void setGeoRssWhere(GeoRssWhere geoRssWhere)
geoRssWhere - geolocation as a georss:where or null to
resetpublic boolean hasGeoRssWhere()
public GmlEnvelope getGmlEnvelope()
public void setGmlEnvelope(GmlEnvelope gmlEnvelope)
gmlEnvelope - geo bounding box as a gml:Envelope or null
to resetpublic boolean hasGmlEnvelope()
public GmlPoint getGmlPoint()
public void setGmlPoint(GmlPoint gmlPoint)
gmlPoint - geolocation as a gml:point or null to resetpublic boolean hasGmlPoint()
public GphotoLocation getLocationExt()
public void setLocationExt(GphotoLocation locationExt)
locationExt - textual location of the album or null to
resetpublic boolean hasLocationExt()
public MediaGroup getMediaGroup()
getMediaGroup in interface MediaDatapublic void setMediaGroup(MediaGroup mediaGroup)
mediaGroup - mediarss group for media metadata or null to
resetpublic boolean hasMediaGroup()
public GphotoName getNameExt()
public void setNameExt(GphotoName nameExt)
nameExt - canonical name of the album or null to resetpublic boolean hasNameExt()
public GphotoNickname getNicknameExt()
public void setNicknameExt(GphotoNickname nicknameExt)
nicknameExt - nickname of the owner of the album or null
to resetpublic boolean hasNicknameExt()
public GphotoPhotosLeft getPhotosLeftExt()
public void setPhotosLeftExt(GphotoPhotosLeft photosLeftExt)
photosLeftExt - number of photos that can be uploaded to this album or
null to resetpublic boolean hasPhotosLeftExt()
public GphotoPhotosUsed getPhotosUsedExt()
public void setPhotosUsedExt(GphotoPhotosUsed photosUsedExt)
photosUsedExt - number of photos that have been uploaded to this album
or null to resetpublic boolean hasPhotosUsedExt()
public GphotoUsername getUsernameExt()
public void setUsernameExt(GphotoUsername usernameExt)
usernameExt - username of the owner of the album or null
to resetpublic boolean hasUsernameExt()
protected void validate()
AbstractExtension
validate in class AbstractExtensionpublic java.lang.String toString()
toString in class java.lang.Object
public AlbumFeed getFeed(java.lang.String... kinds)
throws java.io.IOException,
ServiceException
AlbumFeed albumAndPhotos = albumEntry.getFeed(PhotoData.KIND,
TagData.KIND); If no kind parameters are passed, the default of
PhotoData.KIND will be used.
kinds - the kinds of entries to retrieve, or empty to use the default.
java.io.IOException
ServiceExceptionPhotoData.KIND,
TagData.KINDpublic java.lang.String getAccess()
AlbumData
getAccess in interface AlbumDatapublic java.lang.Long getBytesUsed()
AlbumData
getBytesUsed in interface AlbumDatapublic java.lang.Integer getCommentCount()
AlbumData
getCommentCount in interface AlbumDatapublic java.lang.Boolean getCommentsEnabled()
AlbumData
getCommentsEnabled in interface AlbumDatapublic java.util.Date getDate()
AlbumData
getDate in interface AlbumDatapublic java.lang.String getLocation()
AlbumData
getLocation in interface AlbumDatapublic java.lang.String getName()
AlbumData
getName in interface AlbumDatapublic java.lang.String getNickname()
AlbumData
getNickname in interface AlbumDatapublic java.lang.Integer getPhotosLeft()
AlbumData
getPhotosLeft in interface AlbumDatapublic java.lang.Integer getPhotosUsed()
AlbumData
getPhotosUsed in interface AlbumDatapublic java.lang.String getUsername()
AlbumData
getUsername in interface AlbumDatapublic void setAccess(java.lang.String access)
AlbumData
setAccess in interface AlbumDataaccess - the access level of the album.public void setBytesUsed(java.lang.Long bytesUsed)
AlbumData
setBytesUsed in interface AlbumDatabytesUsed - the number of bytes used.public void setCommentCount(java.lang.Integer commentCount)
AlbumData
setCommentCount in interface AlbumDatacommentCount - the number of comments on the album.public void setCommentsEnabled(java.lang.Boolean commentsEnabled)
AlbumData
setCommentsEnabled in interface AlbumDatacommentsEnabled - true if comments are enabled in the album.public void setDate(java.util.Date date)
AlbumData
setDate in interface AlbumDatadate - the date the album represents.public void setLocation(java.lang.String location)
AlbumData
setLocation in interface AlbumDatalocation - the location of the album.public void setName(java.lang.String name)
AlbumDataAtomData.setTitle(com.google.gdata.data.TextConstruct).
setName in interface AlbumDataname - the canonical name of the album.public void setNickname(java.lang.String nickname)
AlbumData
setNickname in interface AlbumDatanickname - the nickname of the owner.public void setPhotosLeft(java.lang.Integer photosLeft)
AlbumData
setPhotosLeft in interface AlbumDataphotosLeft - the number of photos left.public void setPhotosUsed(java.lang.Integer photosUsed)
AlbumData
setPhotosUsed in interface AlbumDataphotosUsed - the number of photos used.public void setUsername(java.lang.String username)
AlbumData
setUsername in interface AlbumDatausername - the username of the owner.public Point getGeoLocation()
PointData
getGeoLocation in interface PointData
public void setGeoLocation(java.lang.Double lat,
java.lang.Double lon)
PointData
setGeoLocation in interface PointDatalat - The latitude coordinate, between -90 and 90 degrees.lon - The longitude coordinate, between -180 and 180 degrees.public void setGeoLocation(Point point)
PointData
setGeoLocation in interface PointDatapoint - A point containing the latitude and longitude coordinates.
public void setGeoBoundingBox(Point lowerLeft,
Point upperRight)
BoxDataPoint objects. If there is an
existing Box on this object, the new points will be copied into the
existing box rather than creating a new box.
setGeoBoundingBox in interface BoxDatalowerLeft - the lower left coordinate of the box.upperRight - the upper right coordinate of the box.public void setGeoBoundingBox(Box boundingBox)
BoxDataBox extension. If
there is an existing Box on this object, the new box will have its points
copied into the existing box rather than using the passed-in box.
setGeoBoundingBox in interface BoxDataboundingBox - the box that bounds this entity.public Box getGeoBoundingBox()
BoxData
getGeoBoundingBox in interface BoxDatapublic void clearPoint()
PointData
clearPoint in interface PointDatapublic void clearGeoBoundingBox()
BoxData
clearGeoBoundingBox in interface BoxDatapublic java.util.List<MediaCategory> getMediaCategories()
MediaData
getMediaCategories in interface MediaDatapublic java.util.List<MediaContent> getMediaContents()
MediaData
getMediaContents in interface MediaDatapublic java.util.List<MediaCredit> getMediaCredits()
MediaData
getMediaCredits in interface MediaDatapublic MediaKeywords getMediaKeywords()
MediaDatanull will be returned.
getMediaKeywords in interface MediaDatanull.public java.util.List<MediaThumbnail> getMediaThumbnails()
MediaData
getMediaThumbnails in interface MediaDatapublic 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 | ||||||||