|
|||||||||
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.Source
com.google.gdata.data.BaseFeed<F,E>
com.google.gdata.data.media.MediaFeed<F,GphotoEntry>
com.google.gdata.data.photos.GphotoFeed<AlbumFeed>
com.google.gdata.data.photos.AlbumFeed
public class AlbumFeed
Feed for an Album in our google photos api. This feed represents an album
as the container for other objects. An Album feed contains entries
of PhotoEntry
or TagEntry
kind. The album feed itself also
contains all of the metadata available as part of an AlbumData
object.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.google.gdata.data.BaseFeed |
---|
BaseFeed.FeedHandler, BaseFeed.FeedState |
Nested classes/interfaces inherited from class com.google.gdata.data.Source |
---|
Source.SourceHandler, Source.SourceState |
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.BaseFeed |
---|
entries, entryClass, feedState |
Fields inherited from class com.google.gdata.data.Source |
---|
srcState |
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, KIND |
Constructor Summary | |
---|---|
AlbumFeed()
Constructs a new empty album feed. |
|
AlbumFeed(BaseFeed<?,?> sourceFeed)
Constructs a new album feed from a shallow copy of the data in the source feed. |
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. |
java.lang.Long |
getBytesUsed()
The number of bytes that are used by photos in this album. |
java.lang.Integer |
getCommentCount()
The number of comments on the album. |
java.lang.Boolean |
getCommentsEnabled()
Whether or not commenting is allowed on this album. |
java.util.Date |
getDate()
The date the album was taken. |
Box |
getGeoBoundingBox()
Gets the bounding box of this entity. |
Point |
getGeoLocation()
Gets the geo-location of the entity. |
java.lang.String |
getLocation()
The location of the album is a string representing where the photos in the album where taken. |
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.String |
getName()
The name of the album is its canonicalized title. |
java.lang.String |
getNickname()
The nickname of the user who owns the album. |
java.util.List<PhotoEntry> |
getPhotoEntries()
Get a list of entries of the PhotoEntry kind. |
java.lang.Integer |
getPhotosLeft()
The number of spaces for photos that are available in the album. |
java.lang.Integer |
getPhotosUsed()
The number of photos that are contained in this album. |
java.util.List<TagEntry> |
getTagEntries()
Get a list of entries of the TagEntry kind. |
java.lang.String |
getUsername()
The username of the owner of the album. |
PhotoEntry |
insertPhoto(MediaSource photoSource)
Insert a photo into this album by inserting a MediaSource
containing the photo data. |
void |
setAccess(java.lang.String access)
Set the access for the album this data object represents. |
void |
setBytesUsed(java.lang.Long bytesUsed)
Set the number of bytes used in the album this data object represents. |
void |
setCommentCount(java.lang.Integer commentCount)
Set the number of comments on the album. |
void |
setCommentsEnabled(java.lang.Boolean commentsEnabled)
Set the whether comments are enabled in the album. |
void |
setDate(java.util.Date date)
Set the 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 |
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 |
setName(java.lang.String name)
Set 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 |
setPhotosLeft(java.lang.Integer photosLeft)
Set the number of photos remaining 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 |
setUsername(java.lang.String username)
Set the username for the owner of the album this data object represents. |
Methods inherited from class com.google.gdata.data.photos.GphotoFeed |
---|
generateRss, getDescription, getGphotoId, setDescription, setGphotoId, setGphotoId |
Methods inherited from class com.google.gdata.data.media.MediaFeed |
---|
insert, insert, setService |
Methods inherited from class com.google.gdata.data.BaseFeed |
---|
addAdaptor, createEntry, generate, generateAtom, generateFeedEnd, generateFeedStart, getAdaptedFeed, getAdaptor, getAdaptors, getCanPost, getEntries, getEntries, getEntryPostLink, getEtag, getFeedBatchLink, getHandler, getItemsPerPage, getKind, getNextLink, getPreviousLink, getSelectedFields, getSelf, getSelfLink, getService, getStartIndex, getTotalResults, getVersionId, insert, parseAtom, parseAtom, parseAtom, readFeed, readFeed, setCanPost, setEntries, setEtag, setItemsPerPage, setKind, setSelectedFields, setStartIndex, setTotalResults, setVersionId, visitChildren |
Methods inherited from class com.google.gdata.data.Source |
---|
addHtmlLink, addLink, addLink, generateInnerAtom, getAuthors, getCategories, getContributors, getGenerator, getHtmlLink, getIcon, getId, getLink, getLinks, getLinks, getLogo, getRights, getSubtitle, getTitle, getUpdated, removeLinks, removeLinks, setGenerator, setGenerator, setIcon, setId, setLogo, setRights, setSubtitle, setTitle, setUpdated |
Methods inherited from class com.google.gdata.data.AbstractExtension |
---|
consumeAttributes, disableStrictValidation, enableStrictValidation, eq, generateAttributes, getExtensionLocalName, getExtensionNamespace, isImmutable, isStrictValidation, 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 |
Methods inherited from interface com.google.gdata.data.IFeed |
---|
getGenerator, getLogo, getSubtitle, setGenerator, setLogo |
Methods inherited from interface com.google.gdata.data.IAtom |
---|
addLink, getAuthors, getCategories, getId, getLink, getLinks, getTitle, getUpdated, removeLinks, removeLinks, setId, setUpdated |
Constructor Detail |
---|
public AlbumFeed()
public AlbumFeed(BaseFeed<?,?> sourceFeed)
Method Detail |
---|
public void declareExtensions(ExtensionProfile extProfile)
BaseFeed
The implementation of this method for BaseFeed will declare any extensions associated with the contained entry type.
declareExtensions
in interface Kind.Adaptor
declareExtensions
in interface Extensible
declareExtensions
in class GphotoFeed<AlbumFeed>
extProfile
- the ExtensionProfile to initialize.ExtensionProfile.addDeclarations(Kind.Adaptor)
public PhotoEntry insertPhoto(MediaSource photoSource) throws ServiceException, java.io.IOException
MediaSource
containing the photo data.
ServiceException
java.io.IOException
public java.util.List<PhotoEntry> getPhotoEntries()
PhotoEntry
kind.
public java.util.List<TagEntry> getTagEntries()
TagEntry
kind.
public java.lang.String getAccess()
AlbumData
getAccess
in interface AlbumData
public java.lang.Long getBytesUsed() throws ServiceException
AlbumData
getBytesUsed
in interface AlbumData
ServiceException
public java.lang.Integer getCommentCount() throws ServiceException
AlbumData
getCommentCount
in interface AlbumData
ServiceException
public java.lang.Boolean getCommentsEnabled() throws ServiceException
AlbumData
getCommentsEnabled
in interface AlbumData
ServiceException
public java.util.Date getDate() throws ServiceException
AlbumData
getDate
in interface AlbumData
ServiceException
public java.lang.String getLocation()
AlbumData
getLocation
in interface AlbumData
public java.lang.String getName()
AlbumData
getName
in interface AlbumData
public java.lang.String getNickname()
AlbumData
getNickname
in interface AlbumData
public java.lang.Integer getPhotosLeft() throws ServiceException
AlbumData
getPhotosLeft
in interface AlbumData
ServiceException
public java.lang.Integer getPhotosUsed() throws ServiceException
AlbumData
getPhotosUsed
in interface AlbumData
ServiceException
public java.lang.String getUsername()
AlbumData
getUsername
in interface AlbumData
public void setAccess(java.lang.String access)
AlbumData
setAccess
in interface AlbumData
access
- the access level of the album.public void setBytesUsed(java.lang.Long bytesUsed)
AlbumData
setBytesUsed
in interface AlbumData
bytesUsed
- the number of bytes used.public void setCommentCount(java.lang.Integer commentCount)
AlbumData
setCommentCount
in interface AlbumData
commentCount
- the number of comments on the album.public void setCommentsEnabled(java.lang.Boolean commentsEnabled)
AlbumData
setCommentsEnabled
in interface AlbumData
commentsEnabled
- true if comments are enabled in the album.public void setDate(java.util.Date date)
AlbumData
setDate
in interface AlbumData
date
- the date the album represents.public void setLocation(java.lang.String location)
AlbumData
setLocation
in interface AlbumData
location
- the location of the album.public void setName(java.lang.String name)
AlbumData
AtomData.setTitle(com.google.gdata.data.TextConstruct)
.
setName
in interface AlbumData
name
- the canonical name of the album.public void setNickname(java.lang.String nickname)
AlbumData
setNickname
in interface AlbumData
nickname
- the nickname of the owner.public void setPhotosLeft(java.lang.Integer photosLeft)
AlbumData
setPhotosLeft
in interface AlbumData
photosLeft
- the number of photos left.public void setPhotosUsed(java.lang.Integer photosUsed)
AlbumData
setPhotosUsed
in interface AlbumData
photosUsed
- the number of photos used.public void setUsername(java.lang.String username)
AlbumData
setUsername
in interface AlbumData
username
- the username of the owner.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 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
null
will be returned.
getMediaKeywords
in interface MediaData
null
.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 |