SageTV Platform
V9.0

sage.media.rss
Class RSSChannel

java.lang.Object
  extended by sage.media.rss.RSSObject
      extended by sage.media.rss.RSSChannel
All Implemented Interfaces:
java.io.Serializable

public class RSSChannel
extends RSSObject

RSSChannel's definitions class.

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY.

Since:
RSSLIB4J 0.1
See Also:
Serialized Form

Field Summary
 
Fields inherited from class sage.media.rss.RSSObject
about, dc, dc_container, description, link, pdate, title
 
Constructor Summary
RSSChannel()
           
 
Method Summary
 void addItem(RSSItem itm)
          Add an RSSItem to a channel object
 void addRSSSequence(RSSSequence s)
          Set the channel's item's sequece
 java.lang.String getCopyright()
          Get the chyannel's copyright
 java.lang.String getDocs()
          Get the docs url about Rss specifications
 java.lang.String getGenerator()
          Get the generator program's channel
 java.util.LinkedList getItems()
          Get a linkedList wich contains the Channel's RSSItem
 RSSSequence getItemsSequence()
          Get the sequnce from the channel
This element should be always present
 java.lang.String getLanguage()
          Get the language of channell
 java.lang.String getLastBuildDate()
          Get channel's lastBuildDate
 RSSImage getRSSImage()
          Get a RSSImage from the channel
 RSSSyndicationModule getRSSSyndicationModule()
          Get the syndication module object from the RSS object
 RSSTextInput getRSSTextInput()
          Get a RSSTextInput object from the channel
 java.lang.String getTTL()
          Return the TTL's channel
 java.lang.String getWebMaster()
          Get the webmaster email
 void setCopyright(java.lang.String copyright)
          Set channel's copyright
 void setDocs(java.lang.String docs)
          Set the documentator
 void setGenerator(java.lang.String generator)
          Set the gerator
 void setLanguage(java.lang.String language)
          Set the language of channel
 void setLastBuildDate(java.lang.String lastBuildDate)
          Set the lastBuildDate
 void setManagingEditor(java.lang.String managingEditor)
          Set the managingEditor
 void setRSSImage(RSSImage im)
          Set a RSSImage object associated to the channel
 void setRSSTextInput(RSSTextInput in)
          Set a RSSTextInput object to a channel
 void setSyndicationModule(RSSSyndicationModule s)
          Set syndication module for channel's
 void setTTL(java.lang.String ttl)
          Set the TTL time
 void setWebMaster(java.lang.String webMaster)
          Set the webMaster
 java.lang.String toDebugString()
          Useful for debug
 
Methods inherited from class sage.media.rss.RSSObject
addDoublinCoreElement, getAboutAttribute, getDescription, getDoublinCoreElements, getLink, getPubDate, getRSSDoublinCoreModule, getTitle, setAboutAttribute, setDescription, setLink, setPubDate, setRSSDoublinCoreModule, setTitle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RSSChannel

public RSSChannel()
Method Detail

setLanguage

public void setLanguage(java.lang.String language)
Set the language of channel

Parameters:
language - The language the channel is written in

setCopyright

public void setCopyright(java.lang.String copyright)
Set channel's copyright

Parameters:
copyright - Copyright notice for content in the channel

setLastBuildDate

public void setLastBuildDate(java.lang.String lastBuildDate)
Set the lastBuildDate

Parameters:
lastBuildDate - The last time the content of the channel changed

setManagingEditor

public void setManagingEditor(java.lang.String managingEditor)
Set the managingEditor

Parameters:
managingEditor - Email address for person responsible for editorial content

setWebMaster

public void setWebMaster(java.lang.String webMaster)
Set the webMaster

Parameters:
webMaster - Email address for person responsible for technical issues relating to channel.

setGenerator

public void setGenerator(java.lang.String generator)
Set the gerator

Parameters:
generator - A string indicating the program used to generate the channel

setTTL

public void setTTL(java.lang.String ttl)
Set the TTL time

Parameters:
ttl - the time to live

setDocs

public void setDocs(java.lang.String docs)
Set the documentator

Parameters:
docs - thw documentator

setRSSImage

public void setRSSImage(RSSImage im)
Set a RSSImage object associated to the channel

Parameters:
im - Specifies a GIF, JPEG or PNG image that can be displayed with the channel.

setRSSTextInput

public void setRSSTextInput(RSSTextInput in)
Set a RSSTextInput object to a channel

Parameters:
in - Specifies a text input box that can be displayed with the channel

getLastBuildDate

public java.lang.String getLastBuildDate()
Get channel's lastBuildDate

Returns:
lastBuildDate

getCopyright

public java.lang.String getCopyright()
Get the chyannel's copyright

Returns:
copyright (optional)

getGenerator

public java.lang.String getGenerator()
Get the generator program's channel

Returns:
generator (optional)

getTTL

public java.lang.String getTTL()
Return the TTL's channel

Returns:
TTL (optional)

getDocs

public java.lang.String getDocs()
Get the docs url about Rss specifications

Returns:
the url (optional)

getLanguage

public java.lang.String getLanguage()
Get the language of channell

Returns:
language (optional)

getWebMaster

public java.lang.String getWebMaster()
Get the webmaster email

Returns:
email of webmaster (optional)

getRSSTextInput

public RSSTextInput getRSSTextInput()
Get a RSSTextInput object from the channel

Returns:
the RSSTextInput or null

addItem

public void addItem(RSSItem itm)
Add an RSSItem to a channel object

Parameters:
itm - the RSSItem item

addRSSSequence

public void addRSSSequence(RSSSequence s)
Set the channel's item's sequece

Parameters:
s - The RSSSequence

getRSSImage

public RSSImage getRSSImage()
Get a RSSImage from the channel

Returns:
RSSImage if exists (optional)

getItems

public java.util.LinkedList getItems()
Get a linkedList wich contains the Channel's RSSItem

Returns:
the RSSItems's list

getItemsSequence

public RSSSequence getItemsSequence()
Get the sequnce from the channel
This element should be always present

Returns:
the RSSSequence

setSyndicationModule

public void setSyndicationModule(RSSSyndicationModule s)
Set syndication module for channel's

Parameters:
s - syndication namespaces module

getRSSSyndicationModule

public RSSSyndicationModule getRSSSyndicationModule()
Get the syndication module object from the RSS object

Returns:
The object or null

toDebugString

public java.lang.String toDebugString()
Useful for debug

Specified by:
toDebugString in class RSSObject
Returns:
An info string about channel

SageTV Platform
V9.0

SageTV is a trademark or registered trademark of Google, Inc. in the US and other countries.
Copyright 2000-2015 The SageTV Authors. All Rights Reserved.