|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.restlet.resource.Variant
org.restlet.resource.Representation
org.restlet.resource.StreamRepresentation
org.restlet.resource.OutputRepresentation
org.restlet.resource.XmlRepresentation
public abstract class XmlRepresentation
Representation based on an XML document. It knows how to evaluate XPath expressions and how to manage a namespace context. This class also offers convenient methods to validate the document against a specified XML scheme.
Field Summary |
---|
Fields inherited from class org.restlet.resource.Representation |
---|
UNKNOWN_SIZE |
Constructor Summary | |
---|---|
XmlRepresentation(MediaType mediaType)
Constructor. |
|
XmlRepresentation(MediaType mediaType,
long expectedSize)
Constructor. |
Method Summary | |
---|---|
abstract java.lang.Object |
evaluate(java.lang.String expression,
javax.xml.namespace.QName returnType)
Evaluates an XPath expression and returns the result as in the given return type. |
java.lang.Boolean |
getBoolean(java.lang.String expression)
Evaluates an XPath expression as a boolean. |
protected javax.xml.parsers.DocumentBuilder |
getDocumentBuilder()
Returns a document builder properly configured. |
javax.xml.transform.dom.DOMSource |
getDomSource()
Returns a DOM source. |
java.lang.String |
getNamespaceURI(java.lang.String prefix)
|
org.w3c.dom.Node |
getNode(java.lang.String expression)
Evaluates an XPath expression as a DOM Node. |
NodeSet |
getNodes(java.lang.String expression)
Evaluates an XPath expression as a DOM NodeList. |
java.lang.Double |
getNumber(java.lang.String expression)
Evaluates an XPath expression as a number. |
java.lang.String |
getPrefix(java.lang.String namespaceURI)
|
java.util.Iterator<java.lang.String> |
getPrefixes(java.lang.String namespaceURI)
|
javax.xml.transform.sax.SAXSource |
getSaxSource()
Returns a SAX source. |
static javax.xml.transform.sax.SAXSource |
getSaxSource(Representation xmlRepresentation)
Returns a SAX source. |
javax.xml.transform.stream.StreamSource |
getStreamSource()
Returns a stream of XML markup. |
java.lang.String |
getText(java.lang.String expression)
Evaluates an XPath expression as a string. |
boolean |
isNamespaceAware()
Indicates if processing is namespace aware. |
void |
putNamespace(java.lang.String prefix,
java.lang.String namespaceURI)
Puts a new mapping between a prefix and a namespace URI. |
void |
release()
Releases the namespaces map. |
void |
setNamespaceAware(boolean namespaceAware)
Indicates if processing is namespace aware. |
void |
validate(Representation schemaRepresentation)
Validates the XML representation against a given schema. |
void |
validate(Representation schemaRepresentation,
javax.xml.transform.Result result)
Validates the XML representation against a given schema. |
void |
validate(javax.xml.validation.Schema schema)
Validates the XML representation against a given schema. |
void |
validate(javax.xml.validation.Schema schema,
javax.xml.transform.Result result)
Validates the XML representation against a given schema. |
Methods inherited from class org.restlet.resource.OutputRepresentation |
---|
getStream |
Methods inherited from class org.restlet.resource.StreamRepresentation |
---|
getChannel, getReader, write, write |
Methods inherited from class org.restlet.resource.Representation |
---|
checkDigest, checkDigest, computeDigest, createEmpty, exhaust, getAvailableSize, getDigest, getDownloadName, getExpirationDate, getModificationDate, getRange, getSize, getTag, getText, isAvailable, isDownloadable, isTransient, setAvailable, setDigest, setDownloadable, setDownloadName, setExpirationDate, setModificationDate, setRange, setSize, setTag, setTransient, write |
Methods inherited from class org.restlet.resource.Variant |
---|
getCharacterSet, getEncodings, getIdentifier, getLanguages, getMediaType, setCharacterSet, setEncodings, setIdentifier, setIdentifier, setLanguages, setMediaType |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public XmlRepresentation(MediaType mediaType)
mediaType
- The representation's mediaType.public XmlRepresentation(MediaType mediaType, long expectedSize)
mediaType
- The representation's mediaType.expectedSize
- The expected input stream size.Method Detail |
---|
public static javax.xml.transform.sax.SAXSource getSaxSource(Representation xmlRepresentation) throws java.io.IOException
xmlRepresentation
- The XML representation to wrap.
java.io.IOException
public abstract java.lang.Object evaluate(java.lang.String expression, javax.xml.namespace.QName returnType) throws java.lang.Exception
returnType
- The qualified name of the return type.
java.lang.Exception
XPathException
,
XPathConstants
public java.lang.Boolean getBoolean(java.lang.String expression)
protected javax.xml.parsers.DocumentBuilder getDocumentBuilder() throws java.io.IOException
java.io.IOException
public javax.xml.transform.dom.DOMSource getDomSource() throws java.io.IOException
java.io.IOException
public java.lang.String getNamespaceURI(java.lang.String prefix)
getNamespaceURI
in interface javax.xml.namespace.NamespaceContext
public org.w3c.dom.Node getNode(java.lang.String expression)
public NodeSet getNodes(java.lang.String expression)
public java.lang.Double getNumber(java.lang.String expression)
public java.lang.String getPrefix(java.lang.String namespaceURI)
getPrefix
in interface javax.xml.namespace.NamespaceContext
public java.util.Iterator<java.lang.String> getPrefixes(java.lang.String namespaceURI)
getPrefixes
in interface javax.xml.namespace.NamespaceContext
public javax.xml.transform.sax.SAXSource getSaxSource() throws java.io.IOException
java.io.IOException
public javax.xml.transform.stream.StreamSource getStreamSource() throws java.io.IOException
java.io.IOException
public java.lang.String getText(java.lang.String expression)
public boolean isNamespaceAware()
public void putNamespace(java.lang.String prefix, java.lang.String namespaceURI)
prefix
- The namespace prefix.namespaceURI
- The namespace URI.public void release()
release
in class OutputRepresentation
public void setNamespaceAware(boolean namespaceAware)
namespaceAware
- Indicates if processing is namespace aware.public void validate(Representation schemaRepresentation) throws java.lang.Exception
schemaRepresentation
- The XML schema representation to use.
java.lang.Exception
public void validate(Representation schemaRepresentation, javax.xml.transform.Result result) throws java.lang.Exception
schemaRepresentation
- The XML schema representation to use.result
- The Result object that receives (possibly augmented) XML.
java.lang.Exception
public void validate(javax.xml.validation.Schema schema) throws java.lang.Exception
schema
- The XML schema to use.
java.lang.Exception
public void validate(javax.xml.validation.Schema schema, javax.xml.transform.Result result) throws java.lang.Exception
schema
- The XML schema to use.result
- The Result object that receives (possibly augmented) XML.
java.lang.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |