org.apache.abdera.parser.stax
Class FOMSource

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
All Implemented Interfaces:
Cloneable, Iterable<Element>, Base, Element, ExtensibleElement, 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
Direct Known Subclasses:
FOMFeed

public class FOMSource
extends FOMExtensibleElement
implements Source


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
  FOMSource()
           
protected FOMSource(org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory)
           
protected FOMSource(org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory, org.apache.axiom.om.OMXMLParserWrapper builder)
           
protected FOMSource(QName qname, org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory)
           
protected FOMSource(QName qname, org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory, org.apache.axiom.om.OMXMLParserWrapper builder)
           
protected FOMSource(String name, org.apache.axiom.om.OMNamespace namespace, org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory)
           
 
Method Summary
<T extends Source>
T
addAuthor(Person person)
          Adds an individual author to the entry
 Person addAuthor(String name)
          Adds an author
 Person addAuthor(String name, String email, String uri)
          Adds an author
<T extends Source>
T
addCategory(Category category)
          Adds an individual category to the entry
 Category addCategory(String term)
          Adds a category to the feed
 Category addCategory(String scheme, String term, String label)
          Adds a category to the feed
<T extends Source>
T
addContributor(Person person)
          Adds an individual contributor to this entry
 Person addContributor(String name)
          Adds a contributor
 Person addContributor(String name, String email, String uri)
          Adds a contributor
<T extends Source>
T
addLink(Link link)
          Adds an individual link to the entry
 Link addLink(String href)
          Adds an individual link element
 Link addLink(String href, String rel)
          Adds an individual link element
 Link addLink(String href, String rel, String type, String title, String hreflang, long length)
          Adds an individual link element
 Link getAlternateLink()
          Returns this entries first alternate link
 Link getAlternateLink(String type, String hreflang)
           
 IRI getAlternateLinkResolvedHref()
           
 IRI getAlternateLinkResolvedHref(String type, String hreflang)
           
 Feed getAsFeed()
          Convert the Source element into an empty Feed element
 Person getAuthor()
          Returns the first author listed for the entry
 List<Person> getAuthors()
          Returns the complete set of authors listed for the entry
 List<Category> getCategories()
          Lists the complete set of categories listed for the entry
 List<Category> getCategories(String scheme)
          Lists the complete set of categories using the specified scheme
 Collection getCollection()
          Return an app:collection element associatd with this atom:source.
 List<Person> getContributors()
          Lists the complete set of contributors for this entry
 Generator getGenerator()
          RFC4287: The "atom:generator" element's content identifies the agent used to generate a feed, for debugging and other purposes.
 IRI getIcon()
          RFC4287: The "atom:icon" element's content is an IRI reference [RFC3987] that identifies an image that provides iconic visual identification for a feed...
 IRIElement getIconElement()
          RFC4287: The "atom:icon" element's content is an IRI reference [RFC3987] that identifies an image that provides iconic visual identification for a feed...
 IRI getId()
          Returns the universally unique identifier for this feed
 IRIElement getIdElement()
          RFC4287: The "atom:id" element conveys a permanent, universally unique identifier for an entry or feed.
 Link getLink(String rel)
          Returns the first link with the specified rel attribute value
 IRI getLinkResolvedHref(String rel)
           
 List<Link> getLinks()
          Lists the complete set of links for this entry
 List<Link> getLinks(String... rels)
          Lists the complete set of links using the specified rel attributes values
 List<Link> getLinks(String rel)
          Lists the complete set of links using the specified rel attribute value
 IRI getLogo()
          RFC4287: The "atom:logo" element's content is an IRI reference [RFC3987] that identifies an image that provides visual identification for a feed.
 IRIElement getLogoElement()
          RFC4287: The "atom:logo" element's content is an IRI reference [RFC3987] that identifies an image that provides visual identification for a feed.
 String getRights()
          Returns the text of atom:rights
 Text getRightsElement()
           The rights element is typically used to convey a human readable copyright (e.g.
 Text.Type getRightsType()
          Returns the type of atom:rights
 Link getSelfLink()
          Returns the first link using the rel attribute value "self"
 IRI getSelfLinkResolvedHref()
           
 String getSubtitle()
          Returns the text value of atom:subtitle
 Text getSubtitleElement()
          RFC4287: The "atom:subtitle" element is a Text construct that conveys a human-readable description or subtitle for a feed.
 Text.Type getSubtitleType()
          Returns the atom:subtitle type
 String getTitle()
          Returns the text of atom:title
 Text getTitleElement()
          RFC4287: The "atom:title" element is a Text construct that conveys a human-readable title for an entry or feed.
 Text.Type getTitleType()
          Returns the type of atom:title
 Date getUpdated()
          Return the atom:updated value
 DateTime getUpdatedElement()
          RFC4287: The "atom:updated" element is a Date construct indicating the most recent instant in time when an entry or feed was modified in a way the publisher considers significant.
 String getUpdatedString()
          Return the atom:updated value
 IRIElement newId()
          Creates a new randomized atom:id for the entry
<T extends Source>
T
setCollection(Collection collection)
          Set the app:collection element
<T extends Source>
T
setGenerator(Generator generator)
          RFC4287: The "atom:generator" element's content identifies the agent used to generate a feed, for debugging and other purposes.
 Generator setGenerator(String uri, String version, String value)
          RFC4287: The "atom:generator" element's content identifies the agent used to generate a feed, for debugging and other purposes.
 IRIElement setIcon(String value)
          RFC4287: The "atom:icon" element's content is an IRI reference [RFC3987] that identifies an image that provides iconic visual identification for a feed...
<T extends Source>
T
setIconElement(IRIElement iri)
          RFC4287: The "atom:icon" element's content is an IRI reference [RFC3987] that identifies an image that provides iconic visual identification for a feed...
 IRIElement setId(String value)
          Sets the universally unique identifier for this feed
 IRIElement setId(String value, boolean normalize)
          Sets the universally unique identifier for this feed
<T extends Source>
T
setIdElement(IRIElement id)
          RFC4287: The "atom:id" element conveys a permanent, universally unique identifier for an entry or feed.
 IRIElement setLogo(String value)
          RFC4287: The "atom:logo" element's content is an IRI reference [RFC3987] that identifies an image that provides visual identification for a feed.
<T extends Source>
T
setLogoElement(IRIElement iri)
          RFC4287: The "atom:logo" element's content is an IRI reference [RFC3987] that identifies an image that provides visual identification for a feed.
 Text setRights(Div value)
          Sets the value of the rights as @type="xhtml"
 Text setRights(String value)
          Sets the value of the rights as @type="text"
 Text setRights(String value, Text.Type type)
          Sets the value of the rights
 Text setRightsAsHtml(String value)
          Sets the value of the rights as @type="html"
 Text setRightsAsXhtml(String value)
          Sets the value of the rights as @type="xhtml"
<T extends Source>
T
setRightsElement(Text text)
           The rights element is typically used to convey a human readable copyright (e.g.
 Text setSubtitle(Div value)
          Sets the value of the subtitle as @type="xhtml"
 Text setSubtitle(String value)
          Sets the value of the subtitle as @type="text"
 Text setSubtitle(String value, Text.Type type)
          Sets the value of the subtitle
 Text setSubtitleAsHtml(String value)
          Sets the value of the subtitle as @type="html"
 Text setSubtitleAsXhtml(String value)
          Sets the value of the subtitle as @type="xhtml"
<T extends Source>
T
setSubtitleElement(Text text)
          RFC4287: The "atom:subtitle" element is a Text construct that conveys a human-readable description or subtitle for a feed.
 Text setTitle(Div value)
          Sets the value of the title as @type="xhtml"
 Text setTitle(String value)
          Sets the value of the title as @type="text"
 Text setTitle(String value, Text.Type type)
          Sets the value of the title
 Text setTitleAsHtml(String value)
          Sets the value of the title as @type="html"
 Text setTitleAsXhtml(String value)
          Sets the value of the title as @type="xhtml"
<T extends Source>
T
setTitleElement(Text text)
          RFC4287: The "atom:title" element is a Text construct that conveys a human-readable title for an entry or feed.
 DateTime setUpdated(Date value)
          Set the atom:updated value
 DateTime setUpdated(String value)
          Set the atom:updated value
<T extends Source>
T
setUpdatedElement(DateTime updated)
          RFC4287: The "atom:updated" element is a Date construct indicating the most recent instant in time when an entry or feed was modified in a way the publisher considers significant.
 
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, addChild, 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.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
addChild, buildNext, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getFirstChildWithName, getFirstOMChild, isComplete
 
Methods inherited from interface org.apache.axiom.om.impl.OMContainerEx
setComplete
 

Constructor Detail

FOMSource

public FOMSource()

FOMSource

protected FOMSource(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

FOMSource

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

FOMSource

protected FOMSource(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

FOMSource

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

FOMSource

protected FOMSource(QName qname,
                    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

getAuthor

public Person getAuthor()
Description copied from interface: Source
Returns the first author listed for the entry

Specified by:
getAuthor in interface Source
Returns:
This feed's author

getAuthors

public List<Person> getAuthors()
Description copied from interface: Source
Returns the complete set of authors listed for the entry

Specified by:
getAuthors in interface Source
Returns:
This feeds list of authors

addAuthor

public <T extends Source> T addAuthor(Person person)
Description copied from interface: Source
Adds an individual author to the entry

Specified by:
addAuthor in interface Source
Parameters:
person - an atom:author element

addAuthor

public Person addAuthor(String name)
Description copied from interface: Source
Adds an author

Specified by:
addAuthor in interface Source
Parameters:
name - The author name
Returns:
The newly created atom:author element

addAuthor

public Person addAuthor(String name,
                        String email,
                        String uri)
Description copied from interface: Source
Adds an author

Specified by:
addAuthor in interface Source
Parameters:
name - The author name
email - The author email
uri - The author iri
Returns:
The newly created atom:author element

getCategories

public List<Category> getCategories()
Description copied from interface: Source
Lists the complete set of categories listed for the entry

Specified by:
getCategories in interface Source
Returns:
A listing of app:category elements

getCategories

public List<Category> getCategories(String scheme)
Description copied from interface: Source
Lists the complete set of categories using the specified scheme

Specified by:
getCategories in interface Source
Parameters:
scheme - A Scheme IRI
Returns:
The listing of app:category elements

addCategory

public <T extends Source> T addCategory(Category category)
Description copied from interface: Source
Adds an individual category to the entry

Specified by:
addCategory in interface Source
Parameters:
category - A atom:category element

addCategory

public Category addCategory(String term)
Description copied from interface: Source
Adds a category to the feed

Specified by:
addCategory in interface Source
Parameters:
term - A category term
Returns:
The newly created atom:category element

addCategory

public Category addCategory(String scheme,
                            String term,
                            String label)
Description copied from interface: Source
Adds a category to the feed

Specified by:
addCategory in interface Source
Parameters:
scheme - A category scheme
term - A category term
label - The human readable label
Returns:
the newly created atom:category element

getContributors

public List<Person> getContributors()
Description copied from interface: Source
Lists the complete set of contributors for this entry

Specified by:
getContributors in interface Source
Returns:
A listing of atom:contributor elements

addContributor

public <T extends Source> T addContributor(Person person)
Description copied from interface: Source
Adds an individual contributor to this entry

Specified by:
addContributor in interface Source
Parameters:
person - a atom:contributor element

addContributor

public Person addContributor(String name)
Description copied from interface: Source
Adds a contributor

Specified by:
addContributor in interface Source
Parameters:
name - The name of a contributor
Returns:
The newly created atom:contributor element

addContributor

public Person addContributor(String name,
                             String email,
                             String uri)
Description copied from interface: Source
Adds a contributor

Specified by:
addContributor in interface Source
Parameters:
name - The contributor name
email - The contributor email
uri - The contributor uri
Returns:
The atom:contributor element

getIdElement

public IRIElement getIdElement()
Description copied from interface: Source
RFC4287: The "atom:id" element conveys a permanent, universally unique identifier for an entry or feed.

Specified by:
getIdElement in interface Source
Returns:
The atom:id element

setIdElement

public <T extends Source> T setIdElement(IRIElement id)
Description copied from interface: Source
RFC4287: The "atom:id" element conveys a permanent, universally unique identifier for an entry or feed.

Specified by:
setIdElement in interface Source
Parameters:
id - A atom:id element

getId

public IRI getId()
Description copied from interface: Source
Returns the universally unique identifier for this feed

Specified by:
getId in interface Source
Returns:
The atom:id value

setId

public IRIElement setId(String value)
Description copied from interface: Source
Sets the universally unique identifier for this feed

Specified by:
setId in interface Source
Parameters:
value - The atom:id value
Returns:
The newly created atom:id element

newId

public IRIElement newId()
Description copied from interface: Source
Creates a new randomized atom:id for the entry

Specified by:
newId in interface Source

setId

public IRIElement setId(String value,
                        boolean normalize)
Description copied from interface: Source
Sets the universally unique identifier for this feed

Specified by:
setId in interface Source
Parameters:
value - The atom:id value
normalize - True if the atom:id value should be normalized
Returns:
The newly created atom:id element

getLinks

public List<Link> getLinks()
Description copied from interface: Source
Lists the complete set of links for this entry

Specified by:
getLinks in interface Source
Returns:
returns a listing of atom:link elements

getLinks

public List<Link> getLinks(String rel)
Description copied from interface: Source
Lists the complete set of links using the specified rel attribute value

Specified by:
getLinks in interface Source
Parameters:
rel - A link relation
Returns:
A listing of atom:link elements

getLinks

public List<Link> getLinks(String... rels)
Description copied from interface: Source
Lists the complete set of links using the specified rel attributes values

Specified by:
getLinks in interface Source
Returns:
A listof atom:link elements

addLink

public <T extends Source> T addLink(Link link)
Description copied from interface: Source
Adds an individual link to the entry

Specified by:
addLink in interface Source
Parameters:
link - A atom:link element

addLink

public Link addLink(String href)
Description copied from interface: Source
Adds an individual link element

Specified by:
addLink in interface Source
Parameters:
href - The href IRI of the link
Returns:
The newly created atom:link

addLink

public Link addLink(String href,
                    String rel)
Description copied from interface: Source
Adds an individual link element

Specified by:
addLink in interface Source
Parameters:
href - The href IRI of the link
rel - The link rel attribute
Returns:
The newly created atom:link

addLink

public Link addLink(String href,
                    String rel,
                    String type,
                    String title,
                    String hreflang,
                    long length)
Description copied from interface: Source
Adds an individual link element

Specified by:
addLink in interface Source
Parameters:
href - The href IRI of the link
rel - The link rel attribute
type - The link type attribute
hreflang - The link hreflang attribute
length - The length attribute
Returns:
The newly created atom:link

getRightsElement

public Text getRightsElement()
Description copied from interface: Source

The rights element is typically used to convey a human readable copyright (e.g. "<atom:rights>Copyright (c), 2006</atom:rights>).

RFC4287: The "atom:rights" element is a Text construct that conveys information about rights held in and over an entry or feed.

Specified by:
getRightsElement in interface Source
Returns:
The atom:rights element

setRightsElement

public <T extends Source> T setRightsElement(Text text)
Description copied from interface: Source

The rights element is typically used to convey a human readable copyright (e.g. "<atom:rights>Copyright (c), 2006</atom:rights>).

RFC4287: The "atom:rights" element is a Text construct that conveys information about rights held in and over an entry or feed.

Specified by:
setRightsElement in interface Source
Parameters:
text - The atom:rights element

setRights

public Text setRights(String value)
Description copied from interface: Source
Sets the value of the rights as @type="text"

Specified by:
setRights in interface Source
Parameters:
value - The atom:rights text value
Returns:
The newly created atom:rights element

setRightsAsHtml

public Text setRightsAsHtml(String value)
Description copied from interface: Source
Sets the value of the rights as @type="html"

Specified by:
setRightsAsHtml in interface Source
Parameters:
value - The atom:rights text value
Returns:
The newly created atom:rights element

setRightsAsXhtml

public Text setRightsAsXhtml(String value)
Description copied from interface: Source
Sets the value of the rights as @type="xhtml"

Specified by:
setRightsAsXhtml in interface Source
Parameters:
value - The atom:rights text value
Returns:
The newly created atom:rights element

setRights

public Text setRights(String value,
                      Text.Type type)
Description copied from interface: Source
Sets the value of the rights

Specified by:
setRights in interface Source
Parameters:
value - The atom:rights text value
type - The atom:rights text type
Returns:
The newly created atom:rights element

setRights

public Text setRights(Div value)
Description copied from interface: Source
Sets the value of the rights as @type="xhtml"

Specified by:
setRights in interface Source
Parameters:
value - The XHTML div element
Returns:
The newly created atom:rights element

getRights

public String getRights()
Description copied from interface: Source
Returns the text of atom:rights

Specified by:
getRights in interface Source
Returns:
The value of the atom:rights element

getSubtitleElement

public Text getSubtitleElement()
Description copied from interface: Source
RFC4287: The "atom:subtitle" element is a Text construct that conveys a human-readable description or subtitle for a feed.

Specified by:
getSubtitleElement in interface Source
Returns:
The atom:subtitle element

setSubtitleElement

public <T extends Source> T setSubtitleElement(Text text)
Description copied from interface: Source
RFC4287: The "atom:subtitle" element is a Text construct that conveys a human-readable description or subtitle for a feed.

Specified by:
setSubtitleElement in interface Source
Parameters:
text - A atom:subtitle element

setSubtitle

public Text setSubtitle(String value)
Description copied from interface: Source
Sets the value of the subtitle as @type="text"

Specified by:
setSubtitle in interface Source
Parameters:
value - the value of the atom:subtitle element
Returns:
The atom:subtitle element

setSubtitleAsHtml

public Text setSubtitleAsHtml(String value)
Description copied from interface: Source
Sets the value of the subtitle as @type="html"

Specified by:
setSubtitleAsHtml in interface Source
Parameters:
value - The value of the atom:subtitle element
Returns:
The newly created atom:subtitle element

setSubtitleAsXhtml

public Text setSubtitleAsXhtml(String value)
Description copied from interface: Source
Sets the value of the subtitle as @type="xhtml"

Specified by:
setSubtitleAsXhtml in interface Source
Parameters:
value - The value of the atom:subtitle element
Returns:
The newly created atom:subtitle element

setSubtitle

public Text setSubtitle(String value,
                        Text.Type type)
Description copied from interface: Source
Sets the value of the subtitle

Specified by:
setSubtitle in interface Source
Parameters:
value - The value of the atom:subtitle element
type - The atom:subtitle Text.Type
Returns:
The newly created atom:subtitle element

setSubtitle

public Text setSubtitle(Div value)
Description copied from interface: Source
Sets the value of the subtitle as @type="xhtml"

Specified by:
setSubtitle in interface Source
Parameters:
value - The atom:subtitle element
Returns:
The newly created atom:subtitle element

getSubtitle

public String getSubtitle()
Description copied from interface: Source
Returns the text value of atom:subtitle

Specified by:
getSubtitle in interface Source
Returns:
The atom:subtitle text value

getTitleElement

public Text getTitleElement()
Description copied from interface: Source
RFC4287: The "atom:title" element is a Text construct that conveys a human-readable title for an entry or feed.

Specified by:
getTitleElement in interface Source
Returns:
The atom:title element

setTitleElement

public <T extends Source> T setTitleElement(Text text)
Description copied from interface: Source
RFC4287: The "atom:title" element is a Text construct that conveys a human-readable title for an entry or feed.

Specified by:
setTitleElement in interface Source
Parameters:
text - The atom:title element

setTitle

public Text setTitle(String value)
Description copied from interface: Source
Sets the value of the title as @type="text"

Specified by:
setTitle in interface Source
Parameters:
value - The atom:title value
Returns:
The newly created atom:title element

setTitleAsHtml

public Text setTitleAsHtml(String value)
Description copied from interface: Source
Sets the value of the title as @type="html"

Specified by:
setTitleAsHtml in interface Source
Parameters:
value - The atom:title value
Returns:
The newly created atom:title element

setTitleAsXhtml

public Text setTitleAsXhtml(String value)
Description copied from interface: Source
Sets the value of the title as @type="xhtml"

Specified by:
setTitleAsXhtml in interface Source
Parameters:
value - The atom:title value
Returns:
The newly created atom:title element

setTitle

public Text setTitle(String value,
                     Text.Type type)
Description copied from interface: Source
Sets the value of the title

Specified by:
setTitle in interface Source
Parameters:
value - The atom:title value
type - The atom:title Text.Type
Returns:
The newly created atom:title element

setTitle

public Text setTitle(Div value)
Description copied from interface: Source
Sets the value of the title as @type="xhtml"

Specified by:
setTitle in interface Source
Parameters:
value - The XHTML div
Returns:
The newly created atom:title element

getTitle

public String getTitle()
Description copied from interface: Source
Returns the text of atom:title

Specified by:
getTitle in interface Source
Returns:
The text value of the atom:title element

getUpdatedElement

public DateTime getUpdatedElement()
Description copied from interface: Source
RFC4287: The "atom:updated" element is a Date construct indicating the most recent instant in time when an entry or feed was modified in a way the publisher considers significant. Therefore, not all modifications necessarily result in a changed atom:updated value.

Specified by:
getUpdatedElement in interface Source
Returns:
the atom:updated element

setUpdatedElement

public <T extends Source> T setUpdatedElement(DateTime updated)
Description copied from interface: Source
RFC4287: The "atom:updated" element is a Date construct indicating the most recent instant in time when an entry or feed was modified in a way the publisher considers significant. Therefore, not all modifications necessarily result in a changed atom:updated value.

Specified by:
setUpdatedElement in interface Source
Parameters:
updated - A atom:updated element

getUpdatedString

public String getUpdatedString()
Description copied from interface: Source
Return the atom:updated value

Specified by:
getUpdatedString in interface Source
Returns:
The serialized string form value of atom:updated

getUpdated

public Date getUpdated()
Description copied from interface: Source
Return the atom:updated value

Specified by:
getUpdated in interface Source
Returns:
The atom:updated as a java.util.Date

setUpdated

public DateTime setUpdated(Date value)
Description copied from interface: Source
Set the atom:updated value

Specified by:
setUpdated in interface Source
Parameters:
value - The java.util.Date
Returns:
The newly created atom:updated element

setUpdated

public DateTime setUpdated(String value)
Description copied from interface: Source
Set the atom:updated value

Specified by:
setUpdated in interface Source
Parameters:
value - The serialized string date
Returns:
The newly created atom:updated element

getGenerator

public Generator getGenerator()
Description copied from interface: Source
RFC4287: The "atom:generator" element's content identifies the agent used to generate a feed, for debugging and other purposes.

Specified by:
getGenerator in interface Source
Returns:
The atom:generator

setGenerator

public <T extends Source> T setGenerator(Generator generator)
Description copied from interface: Source
RFC4287: The "atom:generator" element's content identifies the agent used to generate a feed, for debugging and other purposes.

Specified by:
setGenerator in interface Source
Parameters:
generator - A atom:generator element

setGenerator

public Generator setGenerator(String uri,
                              String version,
                              String value)
Description copied from interface: Source
RFC4287: The "atom:generator" element's content identifies the agent used to generate a feed, for debugging and other purposes.

Specified by:
setGenerator in interface Source
Parameters:
uri - The iri attribute
version - The version attribute
value - The value attribute
Returns:
A newly created atom:generator element

getIconElement

public IRIElement getIconElement()
Description copied from interface: Source
RFC4287: The "atom:icon" element's content is an IRI reference [RFC3987] that identifies an image that provides iconic visual identification for a feed... The image SHOULD have an aspect ratio of one (horizontal) to one (vertical) and SHOULD be suitable for presentation at a small size.

Specified by:
getIconElement in interface Source
Returns:
the atom:icon element

setIconElement

public <T extends Source> T setIconElement(IRIElement iri)
Description copied from interface: Source
RFC4287: The "atom:icon" element's content is an IRI reference [RFC3987] that identifies an image that provides iconic visual identification for a feed... The image SHOULD have an aspect ratio of one (horizontal) to one (vertical) and SHOULD be suitable for presentation at a small size.

Specified by:
setIconElement in interface Source
Parameters:
iri - The atom:icon element

setIcon

public IRIElement setIcon(String value)
Description copied from interface: Source
RFC4287: The "atom:icon" element's content is an IRI reference [RFC3987] that identifies an image that provides iconic visual identification for a feed... The image SHOULD have an aspect ratio of one (horizontal) to one (vertical) and SHOULD be suitable for presentation at a small size.

Specified by:
setIcon in interface Source
Parameters:
value - The atom:icon IRI value

getIcon

public IRI getIcon()
Description copied from interface: Source
RFC4287: The "atom:icon" element's content is an IRI reference [RFC3987] that identifies an image that provides iconic visual identification for a feed... The image SHOULD have an aspect ratio of one (horizontal) to one (vertical) and SHOULD be suitable for presentation at a small size.

Specified by:
getIcon in interface Source
Returns:
The atom:icon value

getLogoElement

public IRIElement getLogoElement()
Description copied from interface: Source
RFC4287: The "atom:logo" element's content is an IRI reference [RFC3987] that identifies an image that provides visual identification for a feed. The image SHOULD have an aspect ratio of 2 (horizontal) to 1 (vertical).

Specified by:
getLogoElement in interface Source
Returns:
the atom:logo element

setLogoElement

public <T extends Source> T setLogoElement(IRIElement iri)
Description copied from interface: Source
RFC4287: The "atom:logo" element's content is an IRI reference [RFC3987] that identifies an image that provides visual identification for a feed. The image SHOULD have an aspect ratio of 2 (horizontal) to 1 (vertical).

Specified by:
setLogoElement in interface Source
Parameters:
iri - The atom:logo element

setLogo

public IRIElement setLogo(String value)
Description copied from interface: Source
RFC4287: The "atom:logo" element's content is an IRI reference [RFC3987] that identifies an image that provides visual identification for a feed. The image SHOULD have an aspect ratio of 2 (horizontal) to 1 (vertical).

Specified by:
setLogo in interface Source
Parameters:
value - The atom:logo value
Returns:
The newly created atom:logo element

getLogo

public IRI getLogo()
Description copied from interface: Source
RFC4287: The "atom:logo" element's content is an IRI reference [RFC3987] that identifies an image that provides visual identification for a feed. The image SHOULD have an aspect ratio of 2 (horizontal) to 1 (vertical).

Specified by:
getLogo in interface Source
Returns:
The atom:logo element value

getLink

public Link getLink(String rel)
Description copied from interface: Source
Returns the first link with the specified rel attribute value

Specified by:
getLink in interface Source
Parameters:
rel - A link relation
Returns:
The newly created atom:link element

getSelfLink

public Link getSelfLink()
Description copied from interface: Source
Returns the first link using the rel attribute value "self"

Specified by:
getSelfLink in interface Source
Returns:
An atom:link

getAlternateLink

public Link getAlternateLink()
Description copied from interface: Source
Returns this entries first alternate link

Specified by:
getAlternateLink in interface Source
Returns:
An atom:link

getLinkResolvedHref

public IRI getLinkResolvedHref(String rel)
Specified by:
getLinkResolvedHref in interface Source
Parameters:
rel - A link relation
Returns:
An atom:link

getSelfLinkResolvedHref

public IRI getSelfLinkResolvedHref()
Specified by:
getSelfLinkResolvedHref in interface Source
Returns:
An atom:link

getAlternateLinkResolvedHref

public IRI getAlternateLinkResolvedHref()
Specified by:
getAlternateLinkResolvedHref in interface Source
Returns:
An atom:link

getRightsType

public Text.Type getRightsType()
Description copied from interface: Source
Returns the type of atom:rights

Specified by:
getRightsType in interface Source
Returns:
The Text.Type of the atom:rights element

getSubtitleType

public Text.Type getSubtitleType()
Description copied from interface: Source
Returns the atom:subtitle type

Specified by:
getSubtitleType in interface Source
Returns:
The atom:subtitle Text.Type

getTitleType

public Text.Type getTitleType()
Description copied from interface: Source
Returns the type of atom:title

Specified by:
getTitleType in interface Source
Returns:
The atom:title Text.Type value

getCollection

public Collection getCollection()
Description copied from interface: Source
Return an app:collection element associatd with this atom:source. The Atom Publishing Protocol allows an app:collection to be contained by atom:feed to specify the collection to which the feed is associated.

Specified by:
getCollection in interface Source
Returns:
An app:collection element

setCollection

public <T extends Source> T setCollection(Collection collection)
Description copied from interface: Source
Set the app:collection element

Specified by:
setCollection in interface Source
Parameters:
collection - An app:collection element

getAlternateLink

public Link getAlternateLink(String type,
                             String hreflang)
Specified by:
getAlternateLink in interface Source
Parameters:
type - A media type
hreflang - A target language
Returns:
A matching atom:link

getAlternateLinkResolvedHref

public IRI getAlternateLinkResolvedHref(String type,
                                        String hreflang)
Specified by:
getAlternateLinkResolvedHref in interface Source
Parameters:
type - A media type
hreflang - A target language
Returns:
A matching atom:link

getAsFeed

public Feed getAsFeed()
Description copied from interface: Source
Convert the Source element into an empty Feed element

Specified by:
getAsFeed in interface Source


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