org.restlet.resource
Class XmlRepresentation

java.lang.Object
  extended by org.restlet.resource.Variant
      extended by org.restlet.resource.Representation
          extended by org.restlet.resource.StreamRepresentation
              extended by org.restlet.resource.OutputRepresentation
                  extended by org.restlet.resource.XmlRepresentation
All Implemented Interfaces:
NamespaceContext
Direct Known Subclasses:
DomRepresentation, SaxRepresentation

public abstract class XmlRepresentation
extends OutputRepresentation
implements NamespaceContext

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.

Author:
Jerome Louvel

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  Object evaluate(String expression, QName returnType)
          Evaluates an XPath expression and returns the result as in the given return type.
 Boolean getBoolean(String expression)
          Evaluates an XPath expression as a boolean.
protected  DocumentBuilder getDocumentBuilder()
          Returns a document builder properly configured.
 DOMSource getDomSource()
          Returns a DOM source.
 String getNamespaceURI(String prefix)
          
 Node getNode(String expression)
          Evaluates an XPath expression as a DOM Node.
 NodeSet getNodes(String expression)
          Evaluates an XPath expression as a DOM NodeList.
 Double getNumber(String expression)
          Evaluates an XPath expression as a number.
 String getPrefix(String namespaceURI)
          
 Iterator<String> getPrefixes(String namespaceURI)
          
 SAXSource getSaxSource()
          Returns a SAX source.
static SAXSource getSaxSource(Representation xmlRepresentation)
          Returns a SAX source.
 StreamSource getStreamSource()
          Returns a stream of XML markup.
 String getText(String expression)
          Evaluates an XPath expression as a string.
 boolean isNamespaceAware()
          Indicates if processing is namespace aware.
 void putNamespace(String prefix, 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, Result result)
          Validates the XML representation against a given schema.
 void validate(Schema schema)
          Validates the XML representation against a given schema.
 void validate(Schema schema, 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

XmlRepresentation

public XmlRepresentation(MediaType mediaType)
Constructor.

Parameters:
mediaType - The representation's mediaType.

XmlRepresentation

public XmlRepresentation(MediaType mediaType,
                         long expectedSize)
Constructor.

Parameters:
mediaType - The representation's mediaType.
expectedSize - The expected input stream size.
Method Detail

getSaxSource

public static SAXSource getSaxSource(Representation xmlRepresentation)
                              throws IOException
Returns a SAX source.

Parameters:
xmlRepresentation - The XML representation to wrap.
Returns:
A SAX source.
Throws:
IOException

evaluate

public abstract Object evaluate(String expression,
                                QName returnType)
                         throws Exception
Evaluates an XPath expression and returns the result as in the given return type.

Parameters:
returnType - The qualified name of the return type.
Returns:
The evaluation result.
Throws:
Exception
See Also:
XPathException, XPathConstants

getBoolean

public Boolean getBoolean(String expression)
Evaluates an XPath expression as a boolean. If the evaluation fails, null will be returned.

Returns:
The evaluation result.

getDocumentBuilder

protected DocumentBuilder getDocumentBuilder()
                                      throws IOException
Returns a document builder properly configured.

Returns:
A document builder properly configured.
Throws:
IOException

getDomSource

public DOMSource getDomSource()
                       throws IOException
Returns a DOM source.

Returns:
A DOM source.
Throws:
IOException

getNamespaceURI

public String getNamespaceURI(String prefix)

Specified by:
getNamespaceURI in interface NamespaceContext

getNode

public Node getNode(String expression)
Evaluates an XPath expression as a DOM Node. If the evaluation fails, null will be returned.

Returns:
The evaluation result.

getNodes

public NodeSet getNodes(String expression)
Evaluates an XPath expression as a DOM NodeList. If the evaluation fails, null will be returned.

Returns:
The evaluation result.

getNumber

public Double getNumber(String expression)
Evaluates an XPath expression as a number. If the evaluation fails, null will be returned.

Returns:
The evaluation result.

getPrefix

public String getPrefix(String namespaceURI)

Specified by:
getPrefix in interface NamespaceContext

getPrefixes

public Iterator<String> getPrefixes(String namespaceURI)

Specified by:
getPrefixes in interface NamespaceContext

getSaxSource

public SAXSource getSaxSource()
                       throws IOException
Returns a SAX source.

Returns:
A SAX source.
Throws:
IOException

getStreamSource

public StreamSource getStreamSource()
                             throws IOException
Returns a stream of XML markup.

Returns:
A stream of XML markup.
Throws:
IOException

getText

public String getText(String expression)
Evaluates an XPath expression as a string.

Returns:
The evaluation result.

isNamespaceAware

public boolean isNamespaceAware()
Indicates if processing is namespace aware.

Returns:
True if processing is namespace aware.

putNamespace

public void putNamespace(String prefix,
                         String namespaceURI)
Puts a new mapping between a prefix and a namespace URI.

Parameters:
prefix - The namespace prefix.
namespaceURI - The namespace URI.

release

public void release()
Releases the namespaces map.

Overrides:
release in class OutputRepresentation

setNamespaceAware

public void setNamespaceAware(boolean namespaceAware)
Indicates if processing is namespace aware.

Parameters:
namespaceAware - Indicates if processing is namespace aware.

validate

public void validate(Representation schemaRepresentation)
              throws Exception
Validates the XML representation against a given schema.

Parameters:
schemaRepresentation - The XML schema representation to use.
Throws:
Exception

validate

public void validate(Representation schemaRepresentation,
                     Result result)
              throws Exception
Validates the XML representation against a given schema.

Parameters:
schemaRepresentation - The XML schema representation to use.
result - The Result object that receives (possibly augmented) XML.
Throws:
Exception

validate

public void validate(Schema schema)
              throws Exception
Validates the XML representation against a given schema.

Parameters:
schema - The XML schema to use.
Throws:
Exception

validate

public void validate(Schema schema,
                     Result result)
              throws Exception
Validates the XML representation against a given schema.

Parameters:
schema - The XML schema to use.
result - The Result object that receives (possibly augmented) XML.
Throws:
Exception


Copyright © 2005-2008 Noelios Technologies.