XmlQueryResultWriter (Sesame API release 1.2.7)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.openrdf.sesame.query
Class XmlQueryResultWriter

java.lang.Object
  org.openrdf.sesame.query.XmlQueryResultWriter

All Implemented Interfaces:: TableQueryResultListener

public class XmlQueryResultWriter
extends Object
implements TableQueryResultListener

A TableQueryResultListener that converts query results into an XML document. The resulting XML document for a successful query has the following form:

 <xml version="1.0" encoding="UTF-8"?>
 <tableQueryResult>
    <header>
        <columnName>X</columnName>
        <columnName>Y</columnName>
    </header>
    <tuple>
        <uri>http://foo.com/bar</uri>
        <literal>some text</literal>
    </tuple>
    <tuple>
        <bNode>node1234</bNode>
        <literal xml:lang="en">foobar</literal>
    </tuple>
    <tuple>
        <bNode>node5678</bNode>
        <literal datatype="http://www.w3.org/1999/02/22-rdf-syntax-ns#XMLLiteral"><foo>bar</foo></literal>
    </tuple>
 </tableQueryResult>

In case of an error, the error will be reported in the query result itself, e.g.:

 <?xml version="1.0" encoding="UTF-8"?>
 <tableQueryResult>
    <error type="MalformedQueryError">Expected '>', found ' '</error>
 </tableQueryResult>

or:

 <?xml version="1.0" encoding="UTF-8"?>
 <tableQueryResult>
 <header>
    <columnName>X</columnName>
    <columnName>Y</columnName>
 </header>
 <tuple>
    <uri>http://foo.com/bar</uri>
    <literal>some text</literal>
 </tuple>
 <error type="QueryEvaluationError">bladibla</error>
 </tableQueryResult>

Author:: Peter van 't Hof, Arjohn Kampman

Constructor Summary
`XmlQueryResultWriter(OutputStream out)` Creates a new XmlQueryResultWriter (with plainXMLLiterals=false).
`XmlQueryResultWriter(OutputStream out, boolean plainXMLLiterals)`
`XmlQueryResultWriter(Writer writer)`
`XmlQueryResultWriter(Writer writer, boolean plainXMLLiterals)`

Method Summary
`void`	`endTableQueryResult()` Indicates the end of a table-like query result.
`void`	`endTuple()` Indicates the end of a tuple/row.
`void`	`error(QueryErrorType errType, String msg)` Reports an error that has occurred during the query evaluation.
`void`	`setPrettyPrint(boolean prettyPrint)` Enables/disables addition of indentation characters and newlines in the XML document.
`void`	`startTableQueryResult()` Indicates the start of a table-like query result.
`void`	`startTableQueryResult(String[] columnHeaders)` Indicates the start of a table-like query result.
`void`	`startTuple()` Indicates the start of a tuple/row.
`void`	`tupleValue(Value value)` Delivers the next value in the current tuple/row.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XmlQueryResultWriter

public XmlQueryResultWriter(OutputStream out)

Creates a new XmlQueryResultWriter (with plainXMLLiterals=false).

XmlQueryResultWriter

public XmlQueryResultWriter(OutputStream out,
                            boolean plainXMLLiterals)

XmlQueryResultWriter

public XmlQueryResultWriter(Writer writer)

XmlQueryResultWriter

public XmlQueryResultWriter(Writer writer,
                            boolean plainXMLLiterals)

Method Detail

setPrettyPrint

public void setPrettyPrint(boolean prettyPrint)

Enables/disables addition of indentation characters and newlines in the XML document. By default, pretty-printing is set to true. If set to false, no indentation and newlines are added to the XML document. This method has to be used before writing starts (that is, before startTableQueryResult() is called).