org.apache.abdera.model
Interface Document<T extends Element>

All Superinterfaces:
Base, Cloneable, Serializable

public interface Document<T extends Element>
extends Base, Serializable

The top level artifact of the Feed Object Model. The Parser component processes data from an InputStream and returns a Document instance. The type of Document returned depends on the XML format being parsed. The Feed Object Model supports four basic types of documents: FeedDocument, EntryDocument, ServiceDocument (Atom Publishing Protocol Introspection Documents) and XmlDocument (any arbitrary XML).


Method Summary
 Document<T> addProcessingInstruction(String target, String value)
          Add a processing instruction to the document
 Document<T> addStylesheet(String href, String media)
          Add a xml-stylesheet processing instruction to the document
 IRI getBaseUri()
          Returns the Base URI of the document.
 String getCharset()
          Gets the charset used for this document
 javax.activation.MimeType getContentType()
          Returns the content type of this document
 org.apache.abdera.util.EntityTag getEntityTag()
          Return the entity tag for this document
 String getLanguage()
          Get the language
 Lang getLanguageTag()
          Returns the value of the xml:lang attribute as a Lang object
 Date getLastModified()
          Returns the last modified date for this document
 boolean getMustPreserveWhitespace()
          Return true if insignificant whitespace must be preserved
 String[] getProcessingInstruction(String target)
          Get the values for the given processing instruction
 T getRoot()
          Returns the root element of the document (equivalent to DOM's getDocumentElement)
 String getSlug()
          Get the slug for this document
 org.apache.abdera.util.XmlUtil.XMLVersion getXmlVersion()
          Get the XMLVersion used by this document
 Document<T> setBaseUri(String base)
          Sets the Base URI of the document.
 Document<T> setCharset(String charset)
          Sets the charset used for this document
 Document<T> setContentType(String contentType)
          Sets the content type for this document
 Document<T> setEntityTag(org.apache.abdera.util.EntityTag tag)
          Set the entity tag for this document
 Document<T> setEntityTag(String tag)
          Set the entity tag for this document
 Document<T> setLanguage(String lang)
          set the base language
 Document<T> setLastModified(Date lastModified)
          Sets the last modified date for this document
 Document<T> setMustPreserveWhitespace(boolean preserve)
          Set to true to preserve insignificant whitespace
 Document<T> setRoot(T root)
          Sets the root element of the document
 Document<T> setSlug(String slug)
          Set the slug for this document
 
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
 

Method Detail

getRoot

T getRoot()
Returns the root element of the document (equivalent to DOM's getDocumentElement)

Returns:
The root element of the document

setRoot

Document<T> setRoot(T root)
Sets the root element of the document

Parameters:
root - Set the root element of the document

getBaseUri

IRI getBaseUri()
Returns the Base URI of the document. All relative URI's contained in the document will be resolved according to this base.

Returns:
The Base IRI

setBaseUri

Document<T> setBaseUri(String base)
Sets the Base URI of the document. All relative URI's contained in the document will be resolved according to this base.

Parameters:
base - The Base URI
Throws:
IRISyntaxException - if the IRI is malformed

getContentType

javax.activation.MimeType getContentType()
Returns the content type of this document

Returns:
The content type of this document

setContentType

Document<T> setContentType(String contentType)
Sets the content type for this document

Parameters:
contentType - The content type of document
Throws:
MimeTypeParseException - if the content type is malformed

getLastModified

Date getLastModified()
Returns the last modified date for this document

Returns:
The last-modified date

setLastModified

Document<T> setLastModified(Date lastModified)
Sets the last modified date for this document

Parameters:
lastModified - the last-modified date

getCharset

String getCharset()
Gets the charset used for this document

Returns:
The character encoding used for this document

setCharset

Document<T> setCharset(String charset)
Sets the charset used for this document

Parameters:
charset - The character encoding to use

addProcessingInstruction

Document<T> addProcessingInstruction(String target,
                                     String value)
Add a processing instruction to the document

Parameters:
target - The processing instruction target
value - The processing instruction value

getProcessingInstruction

String[] getProcessingInstruction(String target)
Get the values for the given processing instruction


addStylesheet

Document<T> addStylesheet(String href,
                          String media)
Add a xml-stylesheet processing instruction to the document

Parameters:
href - The href of the stylesheet
media - The media target for this stylesheet or null if none

getEntityTag

org.apache.abdera.util.EntityTag getEntityTag()
Return the entity tag for this document


setEntityTag

Document<T> setEntityTag(org.apache.abdera.util.EntityTag tag)
Set the entity tag for this document


setEntityTag

Document<T> setEntityTag(String tag)
Set the entity tag for this document


getLanguage

String getLanguage()
Get the language


getLanguageTag

Lang getLanguageTag()
Returns the value of the xml:lang attribute as a Lang object


setLanguage

Document<T> setLanguage(String lang)
set the base language


getSlug

String getSlug()
Get the slug for this document


setSlug

Document<T> setSlug(String slug)
Set the slug for this document


getMustPreserveWhitespace

boolean getMustPreserveWhitespace()
Return true if insignificant whitespace must be preserved


setMustPreserveWhitespace

Document<T> setMustPreserveWhitespace(boolean preserve)
Set to true to preserve insignificant whitespace


getXmlVersion

org.apache.abdera.util.XmlUtil.XMLVersion getXmlVersion()
Get the XMLVersion used by this document



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