org.apache.lucene.gdata.gom
Interface GOMElement

All Superinterfaces:

AtomParser, GOMXmlEntity

All Known Subinterfaces:

GOMAuthor, GOMCategory, GOMContent, GOMContributor, GOMDateConstruct, GOMEntry, GOMExtension, GOMFeed, GOMGenerator, GOMIcon, GOMId, GOMLink, GOMLogo, GOMPerson, GOMPublished, GOMRights, GOMSource, GOMSubtitle, GOMSummary, GOMTextConstruct, GOMTime, GOMTitle, GOMUpdated

All Known Implementing Classes:

AbstractGOMElement, ArbitraryGOMXml, GOMAuthorImpl, GOMCategoryImpl, GOMContentImpl, GOMContributorImpl, GOMDateConstructImpl, GOMEntryImpl, GOMGeneratorImpl, GOMIconImpl, GOMLinkImpl, GOMLogoImpl, GOMPersonImpl, GOMPublishedImpl, GOMRightsImpl, GOMSourceImpl, GOMSubtitleImpl, GOMSummaryImpl, GOMTextContructImpl, GOMTitleImpl, GOMUpdatedImpl, SimpleGOMElementImpl

public interface GOMElement
extends GOMXmlEntity, AtomParser

Abstract interface which should be assignable from all classes representing xml elements within the GData Object Model.

Author:

Simon Willnauer

Field Summary

static String	XML_BASE xml:base attribute localpart
static String	XML_LANG xml:lang attribute localpart

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

String	getXmlBase()
String	getXmlLang()
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.
void	writeRssOutput(GOMOutputWriter aStreamWriter, String rssName) Generates the xml element represented by this class in the RSS 2.0 formate using the parameter rssName as the element local name

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

getLocalName, getQname, getTextValue, setLocalName, setNamespacePrefix, setNamespaceUri, setTextValue

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

getChildParser, processAttribute, processElementValue, processEndElement

Field Detail

XML_LANG

static final String XML_LANG

xml:lang attribute localpart

See Also:

Constant Field Values

XML_BASE

static final String XML_BASE

xml:base attribute localpart

See Also:

Constant Field Values

Method Detail

getXmlBase

String getXmlBase()

Returns:

the xml:base attribute value

getXmlLang

String getXmlLang()

Returns:

the xml:lang attribute value

writeAtomOutput

void writeAtomOutput(GOMOutputWriter aStreamWriter)
                     throws XMLStreamException

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

Parameters:

aStreamWriter - - the GOMOutputWriter implementation to write the output

Throws:

XMLStreamException - - if the GOMOutputWriter throws an exception

writeRssOutput

void writeRssOutput(GOMOutputWriter aStreamWriter)
                    throws XMLStreamException

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

Parameters:

aStreamWriter - - the GOMOutputWriter implementation to write the output

Throws:

XMLStreamException - - if the GOMOutputWriter throws an exception

writeRssOutput

void writeRssOutput(GOMOutputWriter aStreamWriter,
                    String rssName)
                    throws XMLStreamException

Generates the xml element represented by this class in the RSS 2.0 formate using the parameter rssName as the element local name

Parameters:

rssName - - the local name to render the element

aStreamWriter - - the GOMOutputWriter implementation to write the output

Throws:

XMLStreamException - - if the GOMOutputWriter throws an exception