File Doc Category Size Date Package
GOMFeed.java API Doc Apache Lucene 2.1.0 3752 Wed Feb 14 10:46:00 GMT 2007 org.apache.lucene.gdata.gom

GOMFeed

public interface GOMFeed implements GOMExtensible, GOMSource

Class representing the "atom:feed" element. The "atom:feed" element is the document (i.e., top-level) element of an Atom Feed Document, acting as a container for metadata and data associated with the feed. Its element children consist of metadata elements followed by zero or more atom:entry child elements.

atom:feed {
atomCommonAttributes,
(atomAuthor* & atomCategory* &
atomContributor* &
atomGenerator? & atomIcon? &
atomId &
atomLink* &
atomLogo? &
atomRights? &
atomSubtitle? &
atomTitle &
atomUpdated &
extensionElement*),
atomEntry* }

author: Simon Willnauer
see: org.apache.lucene.gdata.gom.GOMExtensible
see: org.apache.lucene.gdata.gom.GOMExtension
see: org.apache.lucene.gdata.gom.GOMDocument

Fields Summary
public static final String
LOCALNAME
Atom local name for the xml element
public static final String
LOCALNAME_RSS
RSS local name for the xml element
public static final String
RSS_CHANNEL_ELEMENT_NAME
RSS channel localname as Rss starts with
<rss><channel>
Constructors Summary
Methods Summary
public void addNamespace(GOMNamespace aNamespace)
this class can contain namespaces which will be rendered into the start element.
<feed xmlns:myNs="someNamespace"></feed>
param
aNamespace - a namespace to add
public GOMNamespace getDefaultNamespace()
return
the default namespace - this will always be {@link GOMNamespace#ATOM_NAMESPACE}
public java.util.List getEntries()
return
- a list of added entries, this method will never return null.
public int getItemsPerPage()
return
- the OpenSearch namespace element itemsPerPage text value.
public java.util.List getNamespaces()
return
- all declared namespaces, excluding the default namespace, this method will never return null.
see
GOMFeed#getDefaultNamespace()
public int getStartIndex()
return
- the OpenSearch namespace element startIndex text value.
public void setItemsPerPage(int aInt)
param
aInt - the OpenSearch namespace element itemsPerPage text value as an integer.
public void setStartIndex(int aIndex)
param
aIndex - the OpenSearch namespace element startIndex text value as an integer.