RSSSyndicationModule.java

//$Id: RSSSyndicationModule.java,v 1.1 2007/04/14 11:38:59 jw_mt Exp $
package org.gnu.stealthp.rsslib;

/**
 * Handler for Syndycation information.
 *
 * <blockquote>
 * <em>This module, both source code and documentation, is in the
 * Public Domain, and comes with <strong>NO WARRANTY</strong>.</em>
 * </blockquote>
 *
 *
 *  <h2><a name="namespaces">Namespace Declarations</a></h2>
 *  <ul>
 *  <li><b>xmlns:sy="http://purl.org/rss/1.0/modules/syndication/"</b></li>
 *  </ul>
 *  <h2><a name="model">Model</a></h2>
 *  <p>
 *  <em><channel> Elements:</em></p>
 *  <ul>
 *  <li><b><sy:updatePeriod></b> ( 'hourly' | 'daily' | 'weekly' | 'monthly' | 'yearly' )</li>
 *  <li><b><sy:updateFrequency></b> ( a positive integer )</li>
 *  <li><b><sy:updateBase></b> ( #PCDATA ) [<a href="http://www.w3.org/TR/NOTE-datetime">W3CDTF</a>]</li>
 *  </ul>
 *
 * @since RSSLIB4J 0.1
 * @author Francesco aka 'Stealthp' stealthp[@]stealthp.org
 * @version 0.2
 */


public class RSSSyndicationModule {

  private String updatePeriod,
      updateFrequency,
      updateBase;

  /**
   * Set the feed update period
   * @param t ( 'hourly' | 'daily' | 'weekly' | 'monthly' | 'yearly' )
   */
  public void setSyUpdatePeriod(String t) {
    updatePeriod = t;
  }

  /**
   * Set the update frequency
   * @param t could be an integer value
   */
  public void setSyUpdateFrequency(String t) {
    updateFrequency = t;
  }

  /**
   * The date of updateBase
   * @param t the date
   */
  public void setSyUpdateBase(String t) {
    updateBase = t;
  }

  /**
   * Get the period
   * @return the period
   */
  public String getSyUpdatePeriod() {
    return updatePeriod;
  }

  /**
   * Get the update frequecy
   * @return the frequency
   */
  public String getSyUpdateFrequency() {
    return updateFrequency;
  }

  /**
   * Get the date
   * @return the date
   */
  public String getSyUpdateBase() {
    return updateBase;
  }

  /**
   * Information string
   * @return an info
   */
  public String toString() {
    String info = "UPD_PERIOD: " + updatePeriod + "\nUPD_FREQ: " +
        updateFrequency + "\nUPD_BASE: " + updateBase;
    return info;
  }
}