|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Document<T extends Element>
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 | |
---|---|
void |
addProcessingInstruction(java.lang.String target,
java.lang.String value)
Add a processing instruction to the document |
void |
addStylesheet(java.lang.String href,
java.lang.String media)
Add a xml-stylesheet processing instruction to the document |
org.apache.abdera.i18n.iri.IRI |
getBaseUri()
Returns the Base URI of the document. |
java.lang.String |
getCharset()
Gets the charset used for this document |
javax.activation.MimeType |
getContentType()
Returns the content type of this document |
EntityTag |
getEntityTag()
Return the entity tag for this document |
java.lang.String |
getLanguage()
Get the language |
org.apache.abdera.i18n.lang.Lang |
getLanguageTag()
Returns the value of the xml:lang attribute as a Lang object |
java.util.Date |
getLastModified()
Returns the last modified date for this document |
boolean |
getMustPreserveWhitespace()
|
java.lang.String[] |
getProcessingInstruction(java.lang.String target)
Get the values for the given processing instruction |
T |
getRoot()
Returns the root element of the document (equivalent to DOM's getDocumentElement) |
java.lang.String |
getSlug()
Get the slug for this document |
XmlUtil.XMLVersion |
getXmlVersion()
Get the XMLVersion used by this document |
void |
setBaseUri(java.lang.String base)
Sets the Base URI of the document. |
void |
setCharset(java.lang.String charset)
Sets the charset used for this document |
void |
setContentType(java.lang.String contentType)
Sets the content type for this document |
void |
setEntityTag(EntityTag tag)
Set the entity tag for this document |
void |
setEntityTag(java.lang.String tag)
Set the entity tag for this document |
void |
setLanguage(java.lang.String lang)
set the base language |
void |
setLastModified(java.util.Date lastModified)
Sets the last modified date for this document |
void |
setMustPreserveWhitespace(boolean preserve)
|
void |
setRoot(T root)
Sets the root element of the document |
void |
setSlug(java.lang.String slug)
Set the slug for this document |
Methods inherited from interface org.apache.abdera.model.Base |
---|
addComment, clone, getDefaultWriterOptions, getFactory, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo |
Method Detail |
---|
T getRoot()
void setRoot(T root)
root
- Set the root element of the documentorg.apache.abdera.i18n.iri.IRI getBaseUri()
void setBaseUri(java.lang.String base)
base
- The Base URI
IRISyntaxException
- if the IRI is malformedjavax.activation.MimeType getContentType()
void setContentType(java.lang.String contentType)
contentType
- The content type of document
MimeTypeParseException
- if the content type is malformedjava.util.Date getLastModified()
void setLastModified(java.util.Date lastModified)
lastModified
- the last-modified datejava.lang.String getCharset()
void setCharset(java.lang.String charset)
charset
- The character encoding to usevoid addProcessingInstruction(java.lang.String target, java.lang.String value)
target
- The processing instruction targetvalue
- The processing instruction valuejava.lang.String[] getProcessingInstruction(java.lang.String target)
void addStylesheet(java.lang.String href, java.lang.String media)
href
- The href of the stylesheetmedia
- The media target for this stylesheet or null if noneEntityTag getEntityTag()
void setEntityTag(EntityTag tag)
void setEntityTag(java.lang.String tag)
java.lang.String getLanguage()
org.apache.abdera.i18n.lang.Lang getLanguageTag()
void setLanguage(java.lang.String lang)
java.lang.String getSlug()
void setSlug(java.lang.String slug)
boolean getMustPreserveWhitespace()
void setMustPreserveWhitespace(boolean preserve)
XmlUtil.XMLVersion getXmlVersion()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |