org.apache.abdera.parser.stax
Class FOMFeed

java.lang.Object
  extended by org.apache.axiom.om.impl.llom.OMNodeImpl
      extended by org.apache.axiom.om.impl.llom.OMElementImpl
          extended by org.apache.abdera.parser.stax.FOMElement
              extended by org.apache.abdera.parser.stax.FOMExtensibleElement
                  extended by org.apache.abdera.parser.stax.FOMSource
                      extended by org.apache.abdera.parser.stax.FOMFeed
All Implemented Interfaces:
Cloneable, Iterable<Element>, Base, Element, ExtensibleElement, Feed, Source, Constants, org.apache.axiom.om.impl.OMContainerEx, org.apache.axiom.om.impl.OMNodeEx, org.apache.axiom.om.OMConstants, org.apache.axiom.om.OMContainer, org.apache.axiom.om.OMElement, org.apache.axiom.om.OMNode

public class FOMFeed
extends FOMSource
implements Feed


Field Summary
 
Fields inherited from class org.apache.axiom.om.impl.llom.OMElementImpl
attributes, DEFAULT_DEFAULT_NS_OBJECT, firstChild, lastChild, localName, namespaces, noPrefixNamespaceCounter, ns, qName
 
Fields inherited from class org.apache.axiom.om.impl.llom.OMNodeImpl
builder, done, factory, nextSibling, nodeType, parent, previousSibling
 
Fields inherited from interface org.apache.axiom.om.OMNode
CDATA_SECTION_NODE, COMMENT_NODE, DTD_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, PI_NODE, SPACE_NODE, TEXT_NODE
 
Fields inherited from interface org.apache.abdera.util.Constants
ACCEPT, AID, ALTERNATE, APP_MEDIA_TYPE, APP_NS, APP_NS_PRE_RFC, APP_PREFIX, ATITLE, ATOM_MEDIA_TYPE, ATOM_NS, AURI, AUTHOR, BASE, CAT_MEDIA_TYPE, CATEGORIES, CATEGORY, CLASS, COLLECTION, CONFIG_FACTORY, CONFIG_PARSER, CONFIG_PARSERFACTORY, CONFIG_STREAMWRITER, CONFIG_WRITER, CONFIG_WRITERFACTORY, CONFIG_XPATH, CONTENT, CONTRIBUTOR, CONTROL, CONTROL_NS, CONTROL_PREFIX, DEFAULT_FACTORY, DEFAULT_PARSER, DEFAULT_PARSERFACTORY, DEFAULT_STREAMWRITER, DEFAULT_WRITER, DEFAULT_WRITERFACTORY, DEFAULT_XPATH, DIV, DRAFT, EDITED, EMAIL, ENTRY, ENTRY_MEDIA_TYPE, FEED, FEED_MEDIA_TYPE, FIXED, GENERATOR, HREF, HREFLANG, HTML, ICON, ID, LABEL, LANG, LENGTH, LINK, LN_ACCEPT, LN_ALTERNATE, LN_ALTERNATE_MULTIPART_RELATED, LN_AUTHOR, LN_BASE, LN_CATEGORIES, LN_CATEGORY, LN_CLASS, LN_COLLECTION, LN_CONTENT, LN_CONTRIBUTOR, LN_CONTROL, LN_DIV, LN_DRAFT, LN_EDITED, LN_EMAIL, LN_ENTRY, LN_FEED, LN_FIXED, LN_GENERATOR, LN_HREF, LN_HREFLANG, LN_ICON, LN_ID, LN_LABEL, LN_LANG, LN_LENGTH, LN_LINK, LN_LOGO, LN_NAME, LN_PUBLISHED, LN_REL, LN_RIGHTS, LN_SCHEME, LN_SERVICE, LN_SOURCE, LN_SPACE, LN_SRC, LN_SUBTITLE, LN_SUMMARY, LN_TERM, LN_TITLE, LN_TYPE, LN_UPDATED, LN_URI, LN_VERSION, LN_WORKSPACE, LOGO, MULTIPART_RELATED_TYPE, NAME, NAMED_PARSER, NAMED_WRITER, NO, PRE_RFC_ACCEPT, PRE_RFC_CATEGORIES, PRE_RFC_COLLECTION, PRE_RFC_CONTROL, PRE_RFC_DRAFT, PRE_RFC_EDITED, PRE_RFC_SERVICE, PRE_RFC_WORKSPACE, PREFIX, PREFIXED_TITLE, PUBLISHED, REL, RIGHTS, SCHEME, SERVICE, SOURCE, SPACE, SRC, STREAM_WRITER, SUBTITLE, SUMMARY, TERM, TEXT, TITLE, TYPE, UPDATED, URI, VERSION, WORKSPACE, XHTML, XHTML_NS, XML, XML_MEDIA_TYPE, XML_NS, YES
 
Fields inherited from interface org.apache.axiom.om.OMConstants
ARRAY_ITEM_LOCALNAME, ARRAY_ITEM_NS_PREFIX, ARRAY_ITEM_NSURI, ARRAY_ITEM_QNAME, DATA_HANDLER, DEFAULT_CHAR_SET_ENCODING, DEFAULT_DEFAULT_NAMESPACE, DEFAULT_XML_VERSION, IS_BINARY, IS_DATA_HANDLERS_AWARE, PULL_TYPE_BUILDER, PUSH_TYPE_BUILDER, XMLATTRTYPE_CDATA, XMLATTRTYPE_ENTITIES, XMLATTRTYPE_ENTITY, XMLATTRTYPE_ID, XMLATTRTYPE_IDREF, XMLATTRTYPE_IDREFS, XMLATTRTYPE_NMTOKEN, XMLATTRTYPE_NMTOKENS, XMLATTRTYPE_NOTATION, XMLNS_NS_PREFIX, XMLNS_NS_URI, XMLNS_PREFIX, XMLNS_URI
 
Constructor Summary
  FOMFeed()
           
protected FOMFeed(org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory)
           
protected FOMFeed(org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory, org.apache.axiom.om.OMXMLParserWrapper builder)
           
protected FOMFeed(QName qname, org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory)
           
protected FOMFeed(QName qname, org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory, org.apache.axiom.om.OMXMLParserWrapper builder)
           
protected FOMFeed(String name, org.apache.axiom.om.OMNamespace namespace, org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory)
           
 
Method Summary
 void addChild(org.apache.axiom.om.OMNode node)
           
 Entry addEntry()
          Adds a new Entry to the end of the Feeds collection of entries
 Feed addEntry(Entry entry)
          Adds a new Entry to the end of the Feeds collection of entries
 Source getAsSource()
          Creates a Source element from this Feed
 List<Entry> getEntries()
          Returns the complete set of entries contained in this feed
 Entry getEntry(String id)
          Retrieves the first entry in the feed with the given atom:id value
 Entry insertEntry()
          Adds a new Entry to the start of the Feeds collection of entries
 Feed insertEntry(Entry entry)
          Adds a new Entry to the start of the Feeds collection of entries
 Feed sortEntries(Comparator<Entry> comparator)
          Sorts entries using the given comparator
 Feed sortEntriesByEdited(boolean new_first)
          Sorts entries by the app:edited property.
 Feed sortEntriesByUpdated(boolean new_first)
          Sorts entries by the atom:updated property
 
Methods inherited from class org.apache.abdera.parser.stax.FOMSource
addAuthor, addAuthor, addAuthor, addCategory, addCategory, addCategory, addContributor, addContributor, addContributor, addLink, addLink, addLink, addLink, getAlternateLink, getAlternateLink, getAlternateLinkResolvedHref, getAlternateLinkResolvedHref, getAsFeed, getAuthor, getAuthors, getCategories, getCategories, getCollection, getContributors, getGenerator, getIcon, getIconElement, getId, getIdElement, getLink, getLinkResolvedHref, getLinks, getLinks, getLinks, getLogo, getLogoElement, getRights, getRightsElement, getRightsType, getSelfLink, getSelfLinkResolvedHref, getSubtitle, getSubtitleElement, getSubtitleType, getTitle, getTitleElement, getTitleType, getUpdated, getUpdatedElement, getUpdatedString, newId, setCollection, setGenerator, setGenerator, setIcon, setIconElement, setId, setId, setIdElement, setLogo, setLogoElement, setRights, setRights, setRights, setRightsAsHtml, setRightsAsXhtml, setRightsElement, setSubtitle, setSubtitle, setSubtitle, setSubtitleAsHtml, setSubtitleAsXhtml, setSubtitleElement, setTitle, setTitle, setTitle, setTitleAsHtml, setTitleAsXhtml, setTitleElement, setUpdated, setUpdated, setUpdatedElement
 
Methods inherited from class org.apache.abdera.parser.stax.FOMExtensibleElement
addExtension, addExtension, addExtension, addExtension, addExtension, addExtensions, addSimpleExtension, addSimpleExtension, getExtension, getExtension, getExtensions, getExtensions, getExtensions, getSimpleExtension, getSimpleExtension
 
Methods inherited from class org.apache.abdera.parser.stax.FOMElement
_copyElement, _create, _getChildrenAsSet, _getElementValue, _getStringValue, _getUriValue, _parse, _removeAllChildren, _removeChildren, _resolve, _setChild, _setElementValue, addComment, clone, complete, declareIfNecessary, declareNS, getAttributes, getAttributeValue, getAttributeValue, getBaseUri, getDefaultWriterOptions, getDocument, getElements, getExtensionAttributes, getFactory, getFirstChild, getFirstChild, getLanguage, getLanguageTag, getLocale, getMustPreserveWhitespace, getNamespaces, getNextSibling, getNextSibling, getParentElement, getPreviousSibling, getPreviousSibling, getResolvedBaseUri, getText, getText, getTextElement, getWrapped, isDeclared, iterator, removeAttribute, removeAttribute, selectLink, setAttributeValue, setAttributeValue, setBaseUri, setBaseUri, setHtmlText, setLanguage, setMustPreserveWhitespace, setParentDocument, setParentElement, setText, setText, setTextElement, setTextText, setXhtmlText, setXhtmlText, toFormattedString, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo
 
Methods inherited from class org.apache.axiom.om.impl.llom.OMElementImpl
addAttribute, addAttribute, build, buildNext, buildWithAttachments, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, detach, discard, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getBuilder, getChildElements, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getDefaultNamespace, getFirstChildWithName, getFirstElement, getFirstOMChild, getLineNumber, getLocalName, getNamespace, getNextOMSibling, getQName, getTextAsQName, getTrimmedText, getType, getXMLStreamReader, getXMLStreamReaderWithoutCaching, internalSerialize, internalSerialize, internalSerializeAndConsume, isComplete, notifyChildComplete, removeAttribute, resolveQName, setBuilder, setFirstChild, setLastChild, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, toString, toStringWithConsume
 
Methods inherited from class org.apache.axiom.om.impl.llom.OMNodeImpl
close, getOMFactory, getParent, getPreviousOMSibling, importNode, insertSiblingAfter, insertSiblingBefore, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setComplete, setNextOMSibling, setParent, setPreviousOMSibling, setType
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.abdera.model.Source
addAuthor, addAuthor, addAuthor, addCategory, addCategory, addCategory, addContributor, addContributor, addContributor, addLink, addLink, addLink, addLink, getAlternateLink, getAlternateLink, getAlternateLinkResolvedHref, getAlternateLinkResolvedHref, getAsFeed, getAuthor, getAuthors, getCategories, getCategories, getCollection, getContributors, getGenerator, getIcon, getIconElement, getId, getIdElement, getLink, getLinkResolvedHref, getLinks, getLinks, getLinks, getLogo, getLogoElement, getRights, getRightsElement, getRightsType, getSelfLink, getSelfLinkResolvedHref, getSubtitle, getSubtitleElement, getSubtitleType, getTitle, getTitleElement, getTitleType, getUpdated, getUpdatedElement, getUpdatedString, newId, setCollection, setGenerator, setGenerator, setIcon, setIconElement, setId, setId, setIdElement, setLogo, setLogoElement, setRights, setRights, setRights, setRightsAsHtml, setRightsAsXhtml, setRightsElement, setSubtitle, setSubtitle, setSubtitle, setSubtitleAsHtml, setSubtitleAsXhtml, setSubtitleElement, setTitle, setTitle, setTitle, setTitleAsHtml, setTitleAsXhtml, setTitleElement, setUpdated, setUpdated, setUpdatedElement
 
Methods inherited from interface org.apache.abdera.model.ExtensibleElement
addExtension, addExtension, addExtension, addExtension, addExtension, addSimpleExtension, addSimpleExtension, getExtension, getExtension, getExtensions, getExtensions, getExtensions, getSimpleExtension, getSimpleExtension
 
Methods inherited from interface org.apache.abdera.model.Element
declareNS, discard, getAttributes, getAttributeValue, getAttributeValue, getBaseUri, getDocument, getElements, getExtensionAttributes, getFirstChild, getFirstChild, getLanguage, getLanguageTag, getLocale, getMustPreserveWhitespace, getNamespaces, getNextSibling, getNextSibling, getParentElement, getPreviousSibling, getPreviousSibling, getQName, getResolvedBaseUri, getText, removeAttribute, removeAttribute, setAttributeValue, setAttributeValue, setBaseUri, setBaseUri, setLanguage, setMustPreserveWhitespace, setParentElement, setText, setText
 
Methods inherited from interface org.apache.abdera.model.Base
addComment, clone, complete, getDefaultWriterOptions, getFactory, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo
 
Methods inherited from interface java.lang.Iterable
iterator
 
Methods inherited from interface org.apache.axiom.om.OMElement
addAttribute, addAttribute, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getBuilder, getChildElements, getDefaultNamespace, getFirstElement, getLineNumber, getLocalName, getNamespace, getQName, getTextAsQName, getXMLStreamReader, getXMLStreamReaderWithoutCaching, removeAttribute, resolveQName, setBuilder, setFirstChild, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, toString, toStringWithConsume
 
Methods inherited from interface org.apache.axiom.om.OMNode
build, buildWithAttachments, close, detach, discard, getNextOMSibling, getOMFactory, getParent, getPreviousOMSibling, getType, insertSiblingAfter, insertSiblingBefore, isComplete, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume
 
Methods inherited from interface org.apache.axiom.om.OMContainer
buildNext, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getFirstChildWithName, getFirstOMChild, isComplete
 
Methods inherited from interface org.apache.axiom.om.impl.OMContainerEx
setComplete
 

Constructor Detail

FOMFeed

public FOMFeed()

FOMFeed

protected FOMFeed(String name,
                  org.apache.axiom.om.OMNamespace namespace,
                  org.apache.axiom.om.OMContainer parent,
                  org.apache.axiom.om.OMFactory factory)
           throws org.apache.axiom.om.OMException
Throws:
org.apache.axiom.om.OMException

FOMFeed

protected FOMFeed(QName qname,
                  org.apache.axiom.om.OMContainer parent,
                  org.apache.axiom.om.OMFactory factory)

FOMFeed

protected FOMFeed(QName qname,
                  org.apache.axiom.om.OMContainer parent,
                  org.apache.axiom.om.OMFactory factory,
                  org.apache.axiom.om.OMXMLParserWrapper builder)

FOMFeed

protected FOMFeed(org.apache.axiom.om.OMContainer parent,
                  org.apache.axiom.om.OMFactory factory)
           throws org.apache.axiom.om.OMException
Throws:
org.apache.axiom.om.OMException

FOMFeed

protected FOMFeed(org.apache.axiom.om.OMContainer parent,
                  org.apache.axiom.om.OMFactory factory,
                  org.apache.axiom.om.OMXMLParserWrapper builder)
           throws org.apache.axiom.om.OMException
Throws:
org.apache.axiom.om.OMException
Method Detail

getEntries

public List<Entry> getEntries()
Description copied from interface: Feed
Returns the complete set of entries contained in this feed

Specified by:
getEntries in interface Feed
Returns:
A listing of atom:entry elements

addEntry

public Feed addEntry(Entry entry)
Description copied from interface: Feed
Adds a new Entry to the end of the Feeds collection of entries

Specified by:
addEntry in interface Feed
Parameters:
entry - Add an entry

addEntry

public Entry addEntry()
Description copied from interface: Feed
Adds a new Entry to the end of the Feeds collection of entries

Specified by:
addEntry in interface Feed
Returns:
A newly created atom:entry

insertEntry

public Feed insertEntry(Entry entry)
Description copied from interface: Feed
Adds a new Entry to the start of the Feeds collection of entries

Specified by:
insertEntry in interface Feed
Parameters:
entry - An atom:entry to insert

insertEntry

public Entry insertEntry()
Description copied from interface: Feed
Adds a new Entry to the start of the Feeds collection of entries

Specified by:
insertEntry in interface Feed
Returns:
A newly created atom:entry

getAsSource

public Source getAsSource()
Description copied from interface: Feed
Creates a Source element from this Feed

Specified by:
getAsSource in interface Feed
Returns:
Returns a copy of this atom:feed as a atom:source element

addChild

public void addChild(org.apache.axiom.om.OMNode node)
Specified by:
addChild in interface org.apache.axiom.om.OMContainer
Overrides:
addChild in class org.apache.axiom.om.impl.llom.OMElementImpl

sortEntriesByUpdated

public Feed sortEntriesByUpdated(boolean new_first)
Description copied from interface: Feed
Sorts entries by the atom:updated property

Specified by:
sortEntriesByUpdated in interface Feed
Parameters:
new_first - If true, entries with newer atom:updated values will come first

sortEntriesByEdited

public Feed sortEntriesByEdited(boolean new_first)
Description copied from interface: Feed
Sorts entries by the app:edited property. if app:edited is null, use app:updated

Specified by:
sortEntriesByEdited in interface Feed

sortEntries

public Feed sortEntries(Comparator<Entry> comparator)
Description copied from interface: Feed
Sorts entries using the given comparator

Specified by:
sortEntries in interface Feed
Parameters:
comparator - Sort the entries using the comparator

getEntry

public Entry getEntry(String id)
Description copied from interface: Feed
Retrieves the first entry in the feed with the given atom:id value

Specified by:
getEntry in interface Feed
Parameters:
id - The id to retrieve
Returns:
The matching atom:entry


Copyright © 2006-2012 Apache Software Foundation. All Rights Reserved.