org.apache.lucene.gdata.gom.core
Class GOMEntryImpl

java.lang.Object
  org.apache.lucene.gdata.gom.core.AbstractGOMElement
      org.apache.lucene.gdata.gom.core.GOMEntryImpl

All Implemented Interfaces:

AtomParser, GOMElement, GOMEntry, GOMExtensible, GOMXmlEntity

public class GOMEntryImpl
extends AbstractGOMElement
implements GOMEntry

The default implementation of GOMEntry

         atomEntry =
         element atom:entry {
         atomCommonAttributes,
         (      atomAuthor*
                & atomCategory*
                & atomContent?
                & atomContributor*
                & atomId
                & atomLink*
                & atomPublished?
                & atomRights?
                & atomSource?
                & atomSummary?
                & atomTitle
                & atomUpdated
                & extensionElement*)
         }
 

Author:

Simon Willnauer

Field Summary

protected List<GOMExtension>	extensions
protected List<GOMNamespace>	namespaces

Fields inherited from class org.apache.lucene.gdata.gom.core.AbstractGOMElement

extensionAttributes, localName, nsPrefix, nsUri, qname, textValue, xmlBase, xmlLang

Fields inherited from interface org.apache.lucene.gdata.gom.GOMEntry

LOCALNAME, LOCALNAME_RSS

Fields inherited from interface org.apache.lucene.gdata.gom.GOMElement

XML_BASE, XML_LANG

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

Constructor Summary

GOMEntryImpl()

Method Summary

void	addAuthor(GOMAuthor aAuthor)
void	addCategory(GOMCategory aCategory)
void	addContributor(GOMContributor aContributor)
void	addLink(GOMLink aLink)
void	addNamespace(GOMNamespace aNamespace)
List<GOMAuthor>	getAuthors()
List<GOMCategory>	getCategories() This method returns all categories and will never returnnull
AtomParser	getChildParser(javax.xml.namespace.QName aName)
GOMContent	getContent()
List<GOMContributor>	getContributor() This method returns all contributors and will never returnnull
GOMNamespace	getDefaultNamespace()
List<GOMExtension>	getExtensions()
GOMId	getId()
List<GOMLink>	getLinks() This method returns all links and will never returnnull
List<GOMNamespace>	getNamespaces()
GOMPublished	getPublished()
GOMRights	getRights()
GOMSource	getSource()
GOMSummary	getSummary()
GOMTitle	getTitle()
GOMUpdated	getUpdated()
void	processEndElement()
void	setContent(GOMContent aContent)
void	setExtensionFactory(GOMExtensionFactory aFactory)
void	setId(GOMId aId)
void	setPublished(GOMPublished aPublished)
void	setRights(GOMRights aRights)
void	setSource(GOMSource aSource)
void	setSummary(GOMSummary aSummary)
void	setTitle(GOMTitle aTitle)
void	setUpdated(GOMUpdated aUpdated)
void	writeAtomOutput(GOMOutputWriter aStreamWriter) Generates the xml element represented by this class in the ATOM 1.0 formate.
void	writeRssOutput(GOMOutputWriter aStreamWriter) Generates the xml element represented by this class in the RSS 2.0 formate.

Methods inherited from class org.apache.lucene.gdata.gom.core.AbstractGOMElement

addAttribute, getLocalName, getQname, getTextValue, getXmlBase, getXmlLang, getXmlNamespaceAttributes, processAttribute, processElementValue, setLocalName, setNamespacePrefix, setNamespaceUri, setTextValue, writeRssOutput

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.lucene.gdata.gom.GOMElement

getXmlBase, getXmlLang, writeRssOutput

Methods inherited from interface org.apache.lucene.gdata.gom.core.AtomParser

processAttribute, processElementValue

Field Detail

namespaces

protected List<GOMNamespace> namespaces

extensions

protected List<GOMExtension> extensions

Constructor Detail

GOMEntryImpl

public GOMEntryImpl()

Method Detail

addAuthor

public void addAuthor(GOMAuthor aAuthor)

Specified by:

addAuthor in interface GOMEntry

Parameters:

aAuthor - - a author to add

See Also:

GOMEntry.addAuthor(org.apache.lucene.gdata.gom.GOMAuthor)

addCategory

public void addCategory(GOMCategory aCategory)

Specified by:

addCategory in interface GOMEntry

Parameters:

aCategory - - a category to add

See Also:

GOMEntry.addCategory(org.apache.lucene.gdata.gom.GOMCategory)

addContributor

public void addContributor(GOMContributor aContributor)

Specified by:

addContributor in interface GOMEntry

Parameters:

aContributor - - a contributor to add

See Also:

GOMEntry.addContributor(org.apache.lucene.gdata.gom.GOMContributor)

addLink

public void addLink(GOMLink aLink)

Specified by:

addLink in interface GOMEntry

Parameters:

aLink - - a link to add

See Also:

GOMEntry.addLink(org.apache.lucene.gdata.gom.GOMLink)

getAuthors

public List<GOMAuthor> getAuthors()

Specified by:

getAuthors in interface GOMEntry

Returns:

- the entry author

See Also:

GOMEntry.getAuthors()

getCategories

public List<GOMCategory> getCategories()

Description copied from interface: GOMEntry

This method returns all categories and will never returnnull

Specified by:

getCategories in interface GOMEntry

Returns:

- a list of categories

See Also:

GOMEntry.getCategories()

getContributor

public List<GOMContributor> getContributor()

Description copied from interface: GOMEntry

This method returns all contributors and will never returnnull

Specified by:

getContributor in interface GOMEntry

Returns:

- a list of contributors

See Also:

GOMEntry.getContributor()

getId

public GOMId getId()

Specified by:

getId in interface GOMEntry

Returns:

- the feed id

See Also:

GOMEntry.getId()

getLinks

public List<GOMLink> getLinks()

Description copied from interface: GOMEntry

This method returns all links and will never returnnull

Specified by:

getLinks in interface GOMEntry

Returns:

- a list of links

See Also:

GOMEntry.getLinks()

getPublished

public GOMPublished getPublished()

Specified by:

getPublished in interface GOMEntry

Returns:

- the published element

See Also:

GOMEntry.getPublished()

getRights

public GOMRights getRights()

Specified by:

getRights in interface GOMEntry

Returns:

- the entry rights

See Also:

GOMEntry.getRights()

getSource

public GOMSource getSource()

Specified by:

getSource in interface GOMEntry

Returns:

- the entry source

See Also:

GOMEntry.getSource()

getSummary

public GOMSummary getSummary()

Specified by:

getSummary in interface GOMEntry

Returns:

- the summary

See Also:

GOMEntry.getSummary()

getTitle

public GOMTitle getTitle()

Specified by:

getTitle in interface GOMEntry

Returns:

- the entries title

See Also:

GOMEntry.getTitle()

getUpdated

public GOMUpdated getUpdated()

Specified by:

getUpdated in interface GOMEntry

Returns:

- the last updated element

See Also:

GOMEntry.getUpdated()

setId

public void setId(GOMId aId)

Specified by:

setId in interface GOMEntry

Parameters:

aId - - the entry id

See Also:

GOMEntry.setId(org.apache.lucene.gdata.gom.GOMId)

setPublished

public void setPublished(GOMPublished aPublished)

Specified by:

setPublished in interface GOMEntry

Parameters:

aPublished - - the published element to set

See Also:

GOMEntry.setPublished(org.apache.lucene.gdata.gom.GOMPublished)

setRights

public void setRights(GOMRights aRights)

Specified by:

setRights in interface GOMEntry

Parameters:

aRights - - the GOMRights to set

See Also:

GOMEntry.setRights(org.apache.lucene.gdata.gom.GOMRights)

setSource

public void setSource(GOMSource aSource)

Specified by:

setSource in interface GOMEntry

Parameters:

aSource - - the source to set

See Also:

GOMEntry.setSource(org.apache.lucene.gdata.gom.GOMSource)

setSummary

public void setSummary(GOMSummary aSummary)

Specified by:

setSummary in interface GOMEntry

Parameters:

aSummary - - a summary to set

See Also:

GOMEntry.setSummary(org.apache.lucene.gdata.gom.GOMSummary)

setTitle

public void setTitle(GOMTitle aTitle)

Specified by:

setTitle in interface GOMEntry

Parameters:

aTitle - - the title to set

See Also:

GOMEntry.setTitle(org.apache.lucene.gdata.gom.GOMTitle)

setUpdated

public void setUpdated(GOMUpdated aUpdated)

Specified by:

setUpdated in interface GOMEntry

Parameters:

aUpdated - - the updated element to set

See Also:

GOMEntry.setUpdated(org.apache.lucene.gdata.gom.GOMUpdated)

addNamespace

public void addNamespace(GOMNamespace aNamespace)

Specified by:

addNamespace in interface GOMEntry

Parameters:

aNamespace - - a Namespace to add

See Also:

GOMEntry.addNamespace(org.apache.lucene.gdata.gom.GOMNamespace)

getNamespaces

public List<GOMNamespace> getNamespaces()

Specified by:

getNamespaces in interface GOMEntry

Returns:

- list of all namespaces - will never be null

See Also:

GOMEntry.getNamespaces()

getDefaultNamespace

public GOMNamespace getDefaultNamespace()

Specified by:

getDefaultNamespace in interface GOMEntry

Returns:

- the default namespace

See Also:

GOMEntry.getDefaultNamespace()

writeAtomOutput

public void writeAtomOutput(GOMOutputWriter aStreamWriter)
                     throws XMLStreamException

Description copied from interface: GOMElement

Generates the xml element represented by this class in the ATOM 1.0 formate.

Specified by:

writeAtomOutput in interface GOMElement

Parameters:

aStreamWriter - - the GOMOutputWriter implementation to write the output

Throws:

XMLStreamException - - if the GOMOutputWriter throws an exception

See Also:

org.apache.lucene.gdata.gom.GOMElement#writeAtomOutput(org.apache.lucene.gdata.gom.writer.GOMStaxWriter)

writeRssOutput

public void writeRssOutput(GOMOutputWriter aStreamWriter)
                    throws XMLStreamException

Description copied from interface: GOMElement

Generates the xml element represented by this class in the RSS 2.0 formate.

Specified by:

writeRssOutput in interface GOMElement

Parameters:

aStreamWriter - - the GOMOutputWriter implementation to write the output

Throws:

XMLStreamException - - if the GOMOutputWriter throws an exception

See Also:

org.apache.lucene.gdata.gom.GOMElement#writeRssOutput(org.apache.lucene.gdata.gom.writer.GOMStaxWriter)

getChildParser

public AtomParser getChildParser(javax.xml.namespace.QName aName)

Description copied from class: AbstractGOMElement

Specified by:

getChildParser in interface AtomParser

Overrides:

getChildParser in class AbstractGOMElement

Returns:

See Also:

AbstractGOMElement.getChildParser(javax.xml.namespace.QName)

processEndElement

public void processEndElement()

Description copied from class: AbstractGOMElement

Specified by:

processEndElement in interface AtomParser

Overrides:

processEndElement in class AbstractGOMElement

See Also:

AbstractGOMElement.processEndElement()

getExtensions

public List<GOMExtension> getExtensions()

Specified by:

getExtensions in interface GOMExtensible

Returns:

- a list of all extensions specified to the extended element

See Also:

GOMExtensible.getExtensions()

setExtensionFactory

public void setExtensionFactory(GOMExtensionFactory aFactory)

Specified by:

setExtensionFactory in interface GOMExtensible

Parameters:

aFactory - - the extension factory to set

See Also:

GOMExtensible.setExtensionFactory(org.apache.lucene.gdata.gom.core.extension.GOMExtensionFactory)

getContent

public GOMContent getContent()

Specified by:

getContent in interface GOMEntry

Returns:

- the content element

See Also:

GOMEntry.getContent()

setContent

public void setContent(GOMContent aContent)

Specified by:

setContent in interface GOMEntry

Parameters:

aContent - - the content to set

See Also:

GOMEntry.setContent(org.apache.lucene.gdata.gom.GOMContent)