org.apache.lucene.gdata.gom
Interface GOMFeed
- All Superinterfaces:
- AtomParser, GOMElement, GOMExtensible, GOMSource, GOMXmlEntity
public interface GOMFeed
- extends GOMSource, GOMExtensible
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 Also:
GOMExtensible
,
GOMExtension
,
GOMDocument
Fields inherited from interface org.apache.lucene.gdata.gom.core.AtomParser |
DUPLICATE_ATTRIBUTE, DUPLICATE_ELEMENT, DUPLICATE_ELEMENT_VALUE, INVALID_ATTRIBUTE, INVALID_ELEMENT_VALUE, MISSING_ELEMENT_ATTRIBUTE, MISSING_ELEMENT_CHILD, MISSING_ELEMENT_VALUE, MISSING_ELEMENT_VALUE_PLAIN, UNEXPECTED_ATTRIBUTE, UNEXPECTED_ELEMENT, UNEXPECTED_ELEMENT_CHILD, UNEXPECTED_ELEMENT_VALUE, URECOGNIZED_ELEMENT_CHILD |
Methods inherited from interface org.apache.lucene.gdata.gom.GOMSource |
addAuthor, addCategory, addContributor, addLink, getAuthors, getCategories, getContributor, getGenerator, getIcon, getId, getLinks, getLogo, getRights, getSubtitle, getTitle, getUpdated, setGenerator, setIcon, setId, setLogo, setRights, setSubtitle, setTitle, setUpdated |
LOCALNAME
static final String LOCALNAME
- Atom local name for the xml element
- See Also:
- Constant Field Values
LOCALNAME_RSS
static final String LOCALNAME_RSS
- RSS local name for the xml element
- See Also:
- Constant Field Values
RSS_CHANNEL_ELEMENT_NAME
static final String RSS_CHANNEL_ELEMENT_NAME
- RSS channel localname as Rss starts with
<rss><channel>
- See Also:
- Constant Field Values
addNamespace
void addNamespace(GOMNamespace aNamespace)
- this class can contain namespaces which will be rendered into the start
element.
<feed xmlns:myNs="someNamespace"></feed>
- Parameters:
aNamespace
- -
a namespace to add
getNamespaces
List<GOMNamespace> getNamespaces()
- Returns:
- - all declared namespaces, excluding the default namespace, this
method will never return
null
. - See Also:
getDefaultNamespace()
getEntries
List<GOMEntry> getEntries()
- Returns:
- - a list of added entries, this method will never return
null
.
getItemsPerPage
int getItemsPerPage()
- Returns:
- - the OpenSearch namespace element itemsPerPage text
value.
getStartIndex
int getStartIndex()
- Returns:
- - the OpenSearch namespace element startIndex text value.
setStartIndex
void setStartIndex(int aIndex)
- Parameters:
aIndex
- -
the OpenSearch namespace element startIndex text value
as an integer.
setItemsPerPage
void setItemsPerPage(int aInt)
- Parameters:
aInt
- -
the OpenSearch namespace element itemsPerPage text
value as an integer.
getDefaultNamespace
GOMNamespace getDefaultNamespace()
- Returns:
- the default namespace - this will always be
GOMNamespace.ATOM_NAMESPACE
Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.