FeatureFeed.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.maps;

import com.google.gdata.data.BaseFeed;
import com.google.gdata.data.Kind;
import com.google.gdata.data.Link;

/**
 * Describes a feature feed.
 *
 * 
 */
@Kind.Term(FeatureEntry.KIND)
public class FeatureFeed extends BaseFeed<FeatureFeed, FeatureEntry> {

  /**
   * Default mutable constructor.
   */
  public FeatureFeed() {
    super(FeatureEntry.class);
    getCategories().add(FeatureEntry.CATEGORY);
  }

  /**
   * Constructs a new instance by doing a shallow copy of data from an existing
   * {@link BaseFeed} instance.
   *
   * @param sourceFeed source feed
   */
  public FeatureFeed(BaseFeed<?, ?> sourceFeed) {
    super(FeatureEntry.class, sourceFeed);
  }

  /**
   * Returns the link that provides the URI of the full feed (without any query
   * parameters).
   *
   * @return Link that provides the URI of the full feed (without any query
   *     parameters) or {@code null} for none.
   */
  public Link getAtomFeedLink() {
    return getLink(Link.Rel.FEED, Link.Type.ATOM);
  }

  @Override
  public String toString() {
    return "{FeatureFeed " + super.toString() + "}";
  }


  private boolean isKmlDefault = true;

  public void setKmlDefault(boolean isDefault) {
    isKmlDefault = isDefault;
  }

  /**
   * Override generateAtom() method to change the default namespace to kml.
   */
  @Override
  public void generateAtom(com.google.gdata.util.common.xml.XmlWriter w,
      com.google.gdata.data.ExtensionProfile extProfile)
      throws java.io.IOException {

    if (isKmlDefault) {
      w.setDefaultNamespace(DataConstants.KML_NAMESPACE);
    }
    super.generateAtom(w, extProfile);
  }
}