FileDocCategorySizeDatePackage
GOMDocument.javaAPI DocApache Lucene 2.1.03252Wed Feb 14 10:46:00 GMT 2007org.apache.lucene.gdata.gom

GOMDocument

public interface GOMDocument

GOMDocument acts as a container for GOMElements to render the containing GOMElement as a valid xml document. This class renderes the

<?xml version="1.0" encoding="UTF-8"?>
header to the outputstream before the containing element will be rendered.

author
Simon Willnauer
param

Fields Summary
Constructors Summary
Methods Summary
public abstract java.lang.StringgetCharacterEncoding()
Gets the xml charset encoding

return
- the specified char encoding

public abstract TgetRootElement()
Getter for the root element of the xml e.g GOMDocument

return
- the root elmenent

public abstract java.lang.StringgetVersion()
Gets the xml version

return
- the xml version string

public abstract voidsetCharacterEncoding(java.lang.String aEncoding)
Sets the xml charset encoding

param
aEncoding - the charset encoding to set

public abstract voidsetRootElement(T aRootElement)
setter for the root element of the xml e.g GOMDocument

param
aRootElement - the root element to set

public abstract voidsetVersion(java.lang.String aVersion)
Sets the xml version

param
aVersion - the version string

public abstract voidwriteAtomOutput(org.apache.lucene.gdata.gom.writer.GOMOutputWriter aStreamWriter)
Generates a complete xml document starting with the header followed by the output of the specified root element in the ATOM 1.0 formate.

param
aStreamWriter - the {@link GOMOutputWriter} implementation to write the output
throws
XMLStreamException - if the {@link GOMOutputWriter} throws an exception

public abstract voidwriteRssOutput(org.apache.lucene.gdata.gom.writer.GOMOutputWriter aStreamWriter)
Generates a complete xml document starting with the header followed by the output of the specified root element in the RSS 2.0 formate.

param
aStreamWriter - the {@link GOMOutputWriter} implementation to write the output
throws
XMLStreamException - if the {@link GOMOutputWriter} throws an exception