org.restlet.ext.atom
Class Feed

java.lang.Object
  extended by org.restlet.resource.Variant
      extended by org.restlet.resource.Representation
          extended by org.restlet.resource.StreamRepresentation
              extended by org.restlet.resource.OutputRepresentation
                  extended by org.restlet.resource.XmlRepresentation
                      extended by org.restlet.resource.SaxRepresentation
                          extended by org.restlet.ext.atom.Feed
All Implemented Interfaces:
javax.xml.namespace.NamespaceContext

public class Feed
extends SaxRepresentation

Atom Feed Document, acting as a component for metadata and data associated with the feed.

Author:
Jerome Louvel

Field Summary
static java.lang.String ATOM_NAMESPACE
          Atom Syndication Format namespace.
static java.lang.String XHTML_NAMESPACE
          XHTML namespace.
 
Fields inherited from class org.restlet.resource.Representation
UNKNOWN_SIZE
 
Constructor Summary
Feed()
          Constructor.
Feed(Representation xmlFeed)
          Constructor.
 
Method Summary
 java.util.List<Person> getAuthors()
          Returns the authors of the entry.
 java.util.List<Category> getCategories()
          Returns the categories associated with the entry.
 java.util.List<Person> getContributors()
          Returns the contributors to the entry.
 java.util.List<Entry> getEntries()
          Returns the individual entries, acting as a components for associated metadata and data.
 Generator getGenerator()
          Returns the agent used to generate a feed.
 Reference getIcon()
          Returns the image that provides iconic visual identification for a feed.
 java.lang.String getId()
          Returns the permanent, universally unique identifier for the entry.
 java.util.List<Link> getLinks()
          Returns the references from the entry to Web resources.
 Reference getLogo()
          Returns the image that provides visual identification for a feed.
 Text getRights()
          Returns the information about rights held in and over an entry.
 Text getSubtitle()
          Returns the short summary, abstract, or excerpt of an entry.
 Text getTitle()
          Returns the human-readable title for the entry.
 java.util.Date getUpdated()
          Returns the most recent moment when the entry was modified in a significant way.
 void setGenerator(Generator generator)
          Sets the agent used to generate a feed.
 void setIcon(Reference icon)
          Sets the image that provides iconic visual identification for a feed.
 void setId(java.lang.String id)
          Sets the permanent, universally unique identifier for the entry.
 void setLogo(Reference logo)
          Sets the image that provides visual identification for a feed.
 void setRights(Text rights)
          Sets the information about rights held in and over an entry.
 void setSubtitle(Text subtitle)
          Sets the short summary, abstract, or excerpt of an entry.
 void setTitle(Text title)
          Sets the human-readable title for the entry.
 void setUpdated(java.util.Date updated)
          Sets the most recent moment when the entry was modified in a significant way.
 void write(XmlWriter writer)
          Writes the representation to a XML writer.
 void writeElement(XmlWriter writer)
          Writes the current object as an XML element using the given SAX writer.
 
Methods inherited from class org.restlet.resource.SaxRepresentation
evaluate, getSaxSource, parse, release, setSaxSource, write
 
Methods inherited from class org.restlet.resource.XmlRepresentation
getBoolean, getDocumentBuilder, getDomSource, getNamespaceURI, getNode, getNodes, getNumber, getPrefix, getPrefixes, getSaxSource, getStreamSource, getText, isNamespaceAware, putNamespace, setNamespaceAware, validate, validate, validate, validate
 
Methods inherited from class org.restlet.resource.OutputRepresentation
getStream
 
Methods inherited from class org.restlet.resource.StreamRepresentation
getChannel, getReader, write, write
 
Methods inherited from class org.restlet.resource.Representation
checkDigest, checkDigest, computeDigest, createEmpty, exhaust, getAvailableSize, getDigest, getDownloadName, getExpirationDate, getModificationDate, getRange, getSize, getTag, getText, isAvailable, isDownloadable, isTransient, setAvailable, setDigest, setDownloadable, setDownloadName, setExpirationDate, setModificationDate, setRange, setSize, setTag, setTransient
 
Methods inherited from class org.restlet.resource.Variant
getCharacterSet, getEncodings, getIdentifier, getLanguages, getMediaType, setCharacterSet, setEncodings, setIdentifier, setIdentifier, setLanguages, setMediaType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ATOM_NAMESPACE

public static final java.lang.String ATOM_NAMESPACE
Atom Syndication Format namespace.

See Also:
Constant Field Values

XHTML_NAMESPACE

public static final java.lang.String XHTML_NAMESPACE
XHTML namespace.

See Also:
Constant Field Values
Constructor Detail

Feed

public Feed()
Constructor.


Feed

public Feed(Representation xmlFeed)
     throws java.io.IOException
Constructor.

Parameters:
xmlFeed - The XML feed document.
Throws:
java.io.IOException
Method Detail

getAuthors

public java.util.List<Person> getAuthors()
Returns the authors of the entry.

Returns:
The authors of the entry.

getCategories

public java.util.List<Category> getCategories()
Returns the categories associated with the entry.

Returns:
The categories associated with the entry.

getContributors

public java.util.List<Person> getContributors()
Returns the contributors to the entry.

Returns:
The contributors to the entry.

getEntries

public java.util.List<Entry> getEntries()
Returns the individual entries, acting as a components for associated metadata and data.

Returns:
The individual entries, acting as a components for associated metadata and data.

getGenerator

public Generator getGenerator()
Returns the agent used to generate a feed.

Returns:
The agent used to generate a feed.

getIcon

public Reference getIcon()
Returns the image that provides iconic visual identification for a feed.

Returns:
The image that provides iconic visual identification for a feed.

getId

public java.lang.String getId()
Returns the permanent, universally unique identifier for the entry.

Returns:
The permanent, universally unique identifier for the entry.

getLinks

public java.util.List<Link> getLinks()
Returns the references from the entry to Web resources.

Returns:
The references from the entry to Web resources.

getLogo

public Reference getLogo()
Returns the image that provides visual identification for a feed.

Returns:
The image that provides visual identification for a feed.

getRights

public Text getRights()
Returns the information about rights held in and over an entry.

Returns:
The information about rights held in and over an entry.

getSubtitle

public Text getSubtitle()
Returns the short summary, abstract, or excerpt of an entry.

Returns:
The short summary, abstract, or excerpt of an entry.

getTitle

public Text getTitle()
Returns the human-readable title for the entry.

Returns:
The human-readable title for the entry.

getUpdated

public java.util.Date getUpdated()
Returns the most recent moment when the entry was modified in a significant way.

Returns:
The most recent moment when the entry was modified in a significant way.

setGenerator

public void setGenerator(Generator generator)
Sets the agent used to generate a feed.

Parameters:
generator - The agent used to generate a feed.

setIcon

public void setIcon(Reference icon)
Sets the image that provides iconic visual identification for a feed.

Parameters:
icon - The image that provides iconic visual identification for a feed.

setId

public void setId(java.lang.String id)
Sets the permanent, universally unique identifier for the entry.

Parameters:
id - The permanent, universally unique identifier for the entry.

setLogo

public void setLogo(Reference logo)
Sets the image that provides visual identification for a feed.

Parameters:
logo - The image that provides visual identification for a feed.

setRights

public void setRights(Text rights)
Sets the information about rights held in and over an entry.

Parameters:
rights - The information about rights held in and over an entry.

setSubtitle

public void setSubtitle(Text subtitle)
Sets the short summary, abstract, or excerpt of an entry.

Parameters:
subtitle - The short summary, abstract, or excerpt of an entry.

setTitle

public void setTitle(Text title)
Sets the human-readable title for the entry.

Parameters:
title - The human-readable title for the entry.

setUpdated

public void setUpdated(java.util.Date updated)
Sets the most recent moment when the entry was modified in a significant way.

Parameters:
updated - The most recent moment when the entry was modified in a significant way.

write

public void write(XmlWriter writer)
           throws java.io.IOException
Writes the representation to a XML writer.

Overrides:
write in class SaxRepresentation
Parameters:
writer - The XML writer to write to.
Throws:
java.io.IOException

writeElement

public void writeElement(XmlWriter writer)
                  throws org.xml.sax.SAXException
Writes the current object as an XML element using the given SAX writer.

Parameters:
writer - The SAX writer.
Throws:
org.xml.sax.SAXException


Copyright © 2005-2008 Noelios Technologies.