org.apache.lucene.gdata.gom
Interface GOMEntry

All Superinterfaces:
AtomParser, GOMElement, GOMExtensible, GOMXmlEntity
All Known Implementing Classes:
GOMEntryImpl

public interface GOMEntry
extends GOMXmlEntity, GOMElement, GOMExtensible

The GOMEntry class represents a "atom:entry" element in the GData Object Model.

The "atom:entry" element represents an individual entry, acting as a container for metadata and data associated with the entry. This element can appear as a child of the atom:feed element, or it can appear as the document (i.e., top-level) element of a stand-alone Atom Entry Document.

RelaxNG Schema:

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

Author:
Simon Willnauer

Field Summary
static String LOCALNAME
          Atom 1.0 local name for the xml element
static String LOCALNAME_RSS
          RSS 2.0 local name for the xml element
 
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
 
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
 GOMContent getContent()
           
 List<GOMContributor> getContributor()
          This method returns all contributors and will never returnnull
 GOMNamespace getDefaultNamespace()
           
 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 setContent(GOMContent content)
           
 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)
           
 
Methods inherited from interface org.apache.lucene.gdata.gom.GOMElement
getXmlBase, getXmlLang, writeAtomOutput, writeRssOutput, writeRssOutput
 
Methods inherited from interface org.apache.lucene.gdata.gom.core.AtomParser
getChildParser, processAttribute, processElementValue, processEndElement
 
Methods inherited from interface org.apache.lucene.gdata.gom.GOMExtensible
getExtensions, setExtensionFactory
 

Field Detail

LOCALNAME

static final String LOCALNAME
Atom 1.0 local name for the xml element

See Also:
Constant Field Values

LOCALNAME_RSS

static final String LOCALNAME_RSS
RSS 2.0 local name for the xml element

See Also:
Constant Field Values
Method Detail

addAuthor

void addAuthor(GOMAuthor aAuthor)
Parameters:
aAuthor - - a author to add
See Also:
GOMAuthor

addCategory

void addCategory(GOMCategory aCategory)
Parameters:
aCategory - - a category to add
See Also:
GOMCategory

addContributor

void addContributor(GOMContributor aContributor)
Parameters:
aContributor - - a contributor to add
See Also:
GOMContributor

addLink

void addLink(GOMLink aLink)
Parameters:
aLink - - a link to add
See Also:
GOMLink

getAuthors

List<GOMAuthor> getAuthors()
Returns:
- the entry author
See Also:
GOMAuthor

getCategories

List<GOMCategory> getCategories()
This method returns all categories and will never returnnull

Returns:
- a list of categories
See Also:
GOMCategory

getContributor

List<GOMContributor> getContributor()
This method returns all contributors and will never returnnull

Returns:
- a list of contributors
See Also:
GOMContributor

getId

GOMId getId()
Returns:
- the feed id
See Also:
GOMId

setId

void setId(GOMId aId)
Parameters:
aId - - the entry id
See Also:
GOMId

getRights

GOMRights getRights()
Returns:
- the entry rights
See Also:
GOMRights

setRights

void setRights(GOMRights aRights)
Parameters:
aRights - - the GOMRights to set
See Also:
GOMRights

getTitle

GOMTitle getTitle()
Returns:
- the entries title
See Also:
GOMTitle

setTitle

void setTitle(GOMTitle aTitle)
Parameters:
aTitle - - the title to set
See Also:
GOMTitle

getUpdated

GOMUpdated getUpdated()
Returns:
- the last updated element
See Also:
GOMUpdated

setUpdated

void setUpdated(GOMUpdated aUpdated)
Parameters:
aUpdated - - the updated element to set
See Also:
GOMUpdated

getLinks

List<GOMLink> getLinks()
This method returns all links and will never returnnull

Returns:
- a list of links
See Also:
GOMLink

setSummary

void setSummary(GOMSummary aSummary)
Parameters:
aSummary - - a summary to set
See Also:
GOMSummary

getSummary

GOMSummary getSummary()
Returns:
- the summary
See Also:
GOMSummary

setSource

void setSource(GOMSource aSource)
Parameters:
aSource - - the source to set
See Also:
GOMSource

getSource

GOMSource getSource()
Returns:
- the entry source
See Also:
GOMSource

setPublished

void setPublished(GOMPublished aPublished)
Parameters:
aPublished - - the published element to set
See Also:
GOMPublished

getPublished

GOMPublished getPublished()
Returns:
- the published element
See Also:
GOMPublished

getContent

GOMContent getContent()
Returns:
- the content element
See Also:
GOMContent

setContent

void setContent(GOMContent content)
Parameters:
content - - the content to set
See Also:
GOMContent

addNamespace

void addNamespace(GOMNamespace aNamespace)
Parameters:
aNamespace - - a Namespace to add
See Also:
GOMNamespace

getNamespaces

List<GOMNamespace> getNamespaces()
Returns:
- list of all namespaces - will never be null
See Also:
GOMNamespace

getDefaultNamespace

GOMNamespace getDefaultNamespace()
Returns:
- the default namespace
See Also:
GOMNamespace


Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.