PhotoFeed.java

/* Copyright (c) 2008 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


package com.google.gdata.data.photos;

import com.google.gdata.data.BaseFeed;
import com.google.gdata.data.ExtensionProfile;
import com.google.gdata.data.Kind;
import com.google.gdata.data.geo.Box;
import com.google.gdata.data.geo.Point;
import com.google.gdata.data.media.mediarss.MediaCategory;
import com.google.gdata.data.media.mediarss.MediaContent;
import com.google.gdata.data.media.mediarss.MediaCredit;
import com.google.gdata.data.media.mediarss.MediaGroup;
import com.google.gdata.data.media.mediarss.MediaKeywords;
import com.google.gdata.data.media.mediarss.MediaThumbnail;
import com.google.gdata.data.photos.impl.PhotoDataImpl;
import com.google.gdata.util.ServiceException;

import java.util.Date;
import java.util.List;


/**
 * Feed for a Photo in our google data api.  This feed represents a photo
 * as the container for other objects.  A Photo feed contains entries
 * of {@link CommentEntry} or {@link TagEntry} kind.  The photo feed itself
 * also contains all of the metadata available as part of a {@link PhotoData}
 * object.
 *
 * 
 */
@Kind.Term(PhotoData.PHOTO_KIND)
public class PhotoFeed extends GphotoFeed<PhotoFeed> implements PhotoData,
    AtomData {

  private final PhotoData delegate;

  /**
   * Constructs a new empty photo feed.
   */
  public PhotoFeed() {
    super();
    getCategories().add(PhotoData.PHOTO_CATEGORY);
    this.delegate = new PhotoDataImpl(this);
  }

  /**
   * Constructs a new photo feed from a shallow copy of the data in the source
   * feed.  This is used to get the correct entry type based on the category of
   * the entry.
   */
  public PhotoFeed(BaseFeed<?, ?> sourceFeed) {
    super(sourceFeed);
    getCategories().add(PhotoData.PHOTO_CATEGORY);
    this.delegate = new PhotoDataImpl(this);
  }

  /*
   * Declare all of the extensions on the photo feed.
   */
  @Override
  public void declareExtensions(ExtensionProfile extProfile) {
    delegate.declareExtensions(extProfile);
    super.declareExtensions(extProfile);
  }

  /**
   * Get a list of entries of the {@link CommentEntry} kind.
   */
  public List<CommentEntry> getCommentEntries() {
    return super.getEntries(CommentEntry.class);
  }

  /**
   * Get a list of entries of the {@link TagEntry} kind.
   */
  public List<TagEntry> getTagEntries() {
    return super.getEntries(TagEntry.class);
  }

  // Delegating methods.

  public String getAlbumId() {
    return delegate.getAlbumId();
  }

  public String getAlbumAccess() {
    return delegate.getAlbumAccess();
  }

  public void setAlbumAccess(String access) {
    delegate.setAlbumAccess(access);
  }

  public String getVideoStatus() {
    return delegate.getVideoStatus();
  }

  public String getChecksum() {
    return delegate.getChecksum();
  }

  public String getClient() {
    return delegate.getClient();
  }

  public Integer getCommentCount() throws ServiceException {
    return delegate.getCommentCount();
  }

  public Boolean getCommentsEnabled() throws ServiceException {
    return delegate.getCommentsEnabled();
  }

  public ExifTags getExifTags() {
    return delegate.getExifTags();
  }

  public Date getFeaturedDate() {
    return delegate.getFeaturedDate();
  }

  public Long getHeight() throws ServiceException {
    return delegate.getHeight();
  }
  
  public Float getPosition() throws ServiceException {
    return delegate.getPosition();
  }

  public Integer getRotation() throws ServiceException {
    return delegate.getRotation();
  }

  public Long getSize() throws ServiceException {
    return delegate.getSize();
  }

  public Date getTimestamp() throws ServiceException {
    return delegate.getTimestamp();
  }

  public Long getVersion() throws ServiceException {
    return delegate.getVersion();
  }
  
  public Long getViewCount() {
    return delegate.getViewCount();
  }

  public Long getWidth() throws ServiceException {
    return delegate.getWidth();
  }

  public void setAlbumId(Long albumId) {
    delegate.setAlbumId(albumId);
  }

  public void setAlbumId(String albumId) {
    delegate.setAlbumId(albumId);
  }

  public void setVideoStatus(String videoId) {
    delegate.setVideoStatus(videoId);
  }

  public void setChecksum(String checksum) {
    delegate.setChecksum(checksum);
  }

  public void setClient(String client) {
    delegate.setClient(client);
  }

  public void setCommentCount(Integer commentCount) {
    delegate.setCommentCount(commentCount);
  }

  public void setCommentsEnabled(Boolean commentsEnabled) {
    delegate.setCommentsEnabled(commentsEnabled);
  }

  public void setExifTags(ExifTags tags) {
    delegate.setExifTags(tags);
  }

  public void setFeaturedDate(Date featuredDate) {
    delegate.setFeaturedDate(featuredDate);
  }
  
  public void setHeight(Long height) {
    delegate.setHeight(height);
  }

  public void setPosition(Float position) {
    delegate.setPosition(position);
  }

  public void setRotation(Integer rotation) {
    delegate.setRotation(rotation);
  }

  public void setSize(Long size) {
    delegate.setSize(size);
  }

  public void setTimestamp(Date timestamp) {
    delegate.setTimestamp(timestamp);
  }

  public void setVersion(Long version) {
    delegate.setVersion(version);
  }

  public void setViewCount(Long viewCount) {
    delegate.setViewCount(viewCount);
  }
  
  public void setWidth(Long width) {
    delegate.setWidth(width);
  }

  public void setGeoLocation(Double lat, Double lon)
      throws IllegalArgumentException {
    delegate.setGeoLocation(lat, lon);
  }

  public void setGeoLocation(Point point) {
    delegate.setGeoLocation(point);
  }

  public Point getGeoLocation() {
    return delegate.getGeoLocation();
  }

  public void clearPoint() {
    delegate.clearPoint();
  }

  public Box getGeoBoundingBox() {
    return delegate.getGeoBoundingBox();
  }

  public void setGeoBoundingBox(Point lowerLeft, Point upperRight) {
    delegate.setGeoBoundingBox(lowerLeft, upperRight);
  }

  public void setGeoBoundingBox(Box boundingBox) {
    delegate.setGeoBoundingBox(boundingBox);
  }

  public void clearGeoBoundingBox() {
    delegate.clearGeoBoundingBox();
  }

  public void addStreamId(String streamId) {
    delegate.addStreamId(streamId);
  }

  public List<String> getStreamIds() {
    return delegate.getStreamIds();
  }

  public MediaGroup getMediaGroup() {
    return delegate.getMediaGroup();
  }

  public List<MediaContent> getMediaContents() {
    return delegate.getMediaContents();
  }

  public List<MediaCategory> getMediaCategories() {
    return delegate.getMediaCategories();
  }

  public List<MediaCredit> getMediaCredits() {
    return delegate.getMediaCredits();
  }

  public List<MediaThumbnail> getMediaThumbnails() {
    return delegate.getMediaThumbnails();
  }

  public MediaKeywords getMediaKeywords() {
    return delegate.getMediaKeywords();
  }

  public void setKeywords(MediaKeywords keywords) {
    delegate.setKeywords(keywords);
  }
  
  public Boolean isStarred() {
    return delegate.isStarred(); 
  }

  public void setStarred(Boolean starred) {
    delegate.setStarred(starred);
  }

  public Integer getTotalStars() {
    return delegate.getTotalStars();
  }

  public void setTotalStars(Integer totalStars) {
    delegate.setTotalStars(totalStars);
  }

}