|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.query.QueryResult
public class QueryResult
This utility class takes the result sequence produced by a query, and wraps it as an XML document. The class is never instantiated.
Field Summary | |
---|---|
static String |
RESULT_NS
|
Method Summary | |
---|---|
static void |
rewriteToDisk(NodeInfo doc,
Properties outputProperties,
boolean backup,
PrintStream log)
Write an updated document back to disk, using the original URI from which it was read |
static void |
sendWrappedSequence(SequenceIterator iterator,
Receiver destination)
Take a sequence supplied in the form of an iterator and generate a wrapped represention of the items in the sequence, the wrapped representation being a sequence of events sent to a supplied Receiver, in which each item is wrapped in a containing element that identifies its type |
static String |
serialize(NodeInfo nodeInfo)
Convenience method to serialize a node using default serialization options, placing the result in a string. |
static void |
serialize(NodeInfo node,
Result destination,
Properties outputProperties)
Serialize a document containing wrapped query results (or any other document, in fact) as XML. |
static void |
serialize(NodeInfo node,
Result destination,
Properties outputProperties,
Configuration config)
Deprecated. since 8.9; use serialize(NodeInfo, Result, Properties) instead. |
static void |
serializeSequence(SequenceIterator iterator,
Configuration config,
OutputStream destination,
Properties outputProps)
Serialize an arbitrary sequence, without any special wrapping. |
static void |
serializeSequence(SequenceIterator iterator,
Configuration config,
Result result,
Properties outputProperties)
Serialize a sequence to a given result |
static void |
serializeSequence(SequenceIterator iterator,
Configuration config,
Writer writer,
Properties outputProps)
Serialize an arbitrary sequence, without any special wrapping. |
static DocumentInfo |
wrap(SequenceIterator iterator,
Configuration config)
Take the results of a query (or any other SequenceIterator) and create an XML document containing copies of all items in the sequence, each item wrapped in a containing element that identifies its type |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static String RESULT_NS
Method Detail |
---|
public static String serialize(NodeInfo nodeInfo) throws XPathException
nodeInfo
- the node to be serialized. This must not be an attribute or namespace node.
XPathException
- if a serialization error occurspublic static DocumentInfo wrap(SequenceIterator iterator, Configuration config) throws XPathException
iterator
- The values to be wrappedconfig
- The Saxon configuration used to evaluate the query
XPathException
- if any failure occurspublic static void sendWrappedSequence(SequenceIterator iterator, Receiver destination) throws XPathException
iterator
- the input sequencedestination
- the Receiver to accept the wrapped output
XPathException
- if a failure occurs processing the input iteratorpublic static void serialize(NodeInfo node, Result destination, Properties outputProperties, Configuration config) throws XPathException
serialize(NodeInfo, Result, Properties)
instead.
node
- The document or element to be serializeddestination
- The Result object to contain the serialized formoutputProperties
- Serialization options, as defined in JAXP. The requested properties are
not validated.config
- The Configuration. This argument is ignored
XPathException
- If serialization failspublic static void serialize(NodeInfo node, Result destination, Properties outputProperties) throws XPathException
node
- The document or element to be serializeddestination
- The Result object to contain the serialized formoutputProperties
- Serialization options as defined in JAXP. The requested properties are
not validated.
XPathException
- If serialization failspublic static void serializeSequence(SequenceIterator iterator, Configuration config, OutputStream destination, Properties outputProps) throws XPathException
iterator
- the sequence to be serializedconfig
- the configuration (gives access to information such as the NamePool)destination
- the output stream to which the output is to be writtenoutputProps
- a set of serialization properties as defined in JAXP. The requested properties are
not validated.
XPathException
- if any failure occurspublic static void serializeSequence(SequenceIterator iterator, Configuration config, Writer writer, Properties outputProps) throws XPathException
iterator
- the sequence to be serializedconfig
- the configuration (gives access to information such as the NamePool)writer
- the writer to which the output is to be writtenoutputProps
- a set of serialization properties as defined in JAXP. The requested properties are
not validated.
XPathException
- if any failure occurspublic static void serializeSequence(SequenceIterator iterator, Configuration config, Result result, Properties outputProperties) throws XPathException
iterator
- the sequence to be serializedconfig
- the Saxon Configurationresult
- the destination to receive the outputoutputProperties
- the serialization properties to be used. The requested properties are
not validated.
XPathException
- if any failure occurspublic static void rewriteToDisk(NodeInfo doc, Properties outputProperties, boolean backup, PrintStream log) throws XPathException
doc
- an updated document. Must be a document node, or a parentless element, or an
element that has a document node as its parent. The document will be written to the URI
found in the systemId property of this node.outputProperties
- serialization propertiesbackup
- true if the old document at that location is to be copied to a backup filelog
- destination for progress messages; if null, no progress messages are written
XPathException
- if the document has no known URI, if the URI is not a writable location,
or if a serialization error occurs.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |