This class represents a sequence of items obtained as a result of evaluation XQuery expressions. More...
Public Member Functions | |
boolean | absolute (int i) throws XQException |
Moves the XQSequence's position to the given item number in this object. | |
void | afterLast () throws XQException |
Move to the position after the last item. | |
void | beforeFirst () throws XQException |
Moves to the position before the first item. | |
void | close () throws XQException |
Closes the sequence and frees all resources associated with this sequence. | |
int | count () throws XQException |
Returns a number indicating the number of items in the sequence. | |
boolean | first () throws XQException |
Moves to the first item in the sequence. | |
String | getAtomicValue () throws XQException |
Gets the current item as a Java String. | |
boolean | getBoolean () throws XQException |
Gets the current item as a boolean. | |
byte | getByte () throws XQException |
Gets the current item as a byte. | |
XQConnection | getConnection () throws XQException |
Gets the XQuery connection associated with this result sequence. | |
double | getDouble () throws XQException |
Gets the current item as a double. | |
float | getFloat () throws XQException |
Gets the current item as a float. | |
int | getInt () throws XQException |
Gets the current item as an int. | |
XQItem | getItem () throws XQException |
Get the current item as an immutable XQItem object. | |
XMLStreamReader | getItemAsStream () throws XQException |
Read the current item as an XMLStreamReader object. | |
String | getItemAsString (Properties prprts) throws XQException |
Serializes the current item according to the XSLT 2.0 and XQuery 1.0 serialization. | |
XQItemType | getItemType () throws XQException |
Gets the type of the item. | |
long | getLong () throws XQException |
Gets the current item as a long. | |
Node | getNode () throws XQException |
Gets the item as a DOM node. | |
URI | getNodeUri () throws XQException |
Returns the URI for this item. | |
Object | getObject () throws XQException |
Gets the current item as an Object. | |
int | getPosition () throws XQException |
Gets the current cursor position. | |
XMLStreamReader | getSequenceAsStream () throws XQException |
Read the entire sequence starting from the current position as an XMLStreamReader object. | |
String | getSequenceAsString (Properties prprts) throws XQException |
Serializes the sequence starting from the current position to a String. | |
short | getShort () throws XQException |
Gets the current item as a short. | |
ZorbaXQStaticCollectionManager | getStaticCollectionManager () throws XQException |
Returns a StaticCollectionManager. | |
boolean | instanceOf (XQItemType xqit) throws XQException |
Checks if the item "matches" an item type. | |
boolean | isAfterLast () throws XQException |
Checks if the current position is after the last item in the sequence. | |
boolean | isBeforeFirst () throws XQException |
Checks if the current position before the first item in the sequence. | |
boolean | isClosed () |
Checks if the sequence is closed. | |
boolean | isFirst () throws XQException |
Checks if the current position at the first item in the sequence. | |
boolean | isLast () throws XQException |
Checks if the current position at the last item in the sequence. | |
boolean | isOnItem () throws XQException |
Check if the sequence is positioned on an item or not. | |
boolean | isScrollable () throws XQException |
Checks if the sequence is scrollable. | |
boolean | last () throws XQException |
Moves to the last item in the sequence. | |
boolean | next () throws XQException |
Moves to the next item in the sequence. | |
boolean | previous () throws XQException |
Moves to the previous item in the sequence. | |
boolean | relative (int i) throws XQException |
Moves the cursor a relative number of items. | |
void | writeItem (OutputStream out, Properties prprts) throws XQException |
Serializes the current item to a Writer. | |
void | writeItem (Writer writer, Properties prprts) throws XQException |
Serializes the current item to a Writer. | |
void | writeItemToResult (Result result) throws XQException |
Writes the current item to a Result. | |
void | writeItemToSAX (ContentHandler ch) throws XQException |
Writes the current item to a SAX handler. | |
void | writeSequence (OutputStream out, Properties prprts) throws XQException |
Serializes the sequence starting from the current position to an OutputStream. | |
void | writeSequence (Writer writer, Properties prprts) throws XQException |
Serializes the sequence starting from the current position to a Writer. | |
void | writeSequenceToResult (Result result) throws XQException |
Writes the entire sequence starting from the current position to a Result. | |
void | writeSequenceToSAX (ContentHandler ch) throws XQException |
Writes the entire sequence starting from the current position to a SAX handler. | |
ZorbaXQResultSequence (XQConnection conn, org.zorbaxquery.api.XQuery query, boolean prepared) |
This class represents a sequence of items obtained as a result of evaluation XQuery expressions.
The result sequence is tied to the XQconnection object on which the expression was evaluated.
This sequence can be obtained by performing an executeQuery on the expression object. It represents a cursor-like class. The ZorbaXQResultSequence object is dependent on the connection and the expression from which it was created and is only valid for the duration of those objects. Thus, if any one of those objects is closed, this ZorbaXQResultSequence object will be implicitly closed and it can no longer be used. Similarly re-executing the expression also implicitly closes the associated result sequences. An XQJ driver is not required to provide finalizer methods for the connection and other objects. Hence it is strongly recommended that users call close method explicitly to free any resources. It is also recommended that they do so under a final block to ensure that the object is closed even when there are exceptions. Not closing this object implicitly or explicitly might result in serious memory leaks. When the ZorbaXQResultSequence is closed any ZorbaXQResultItem objects obtained from it are also implicitly closed. Example - @code {.java} XQPreparedExpression expr = conn.prepareExpression("for $i .."); ZorbaXQResultSequence result = expr.executeQuery(); // create the ItemTypes for string and integer XQItemType strType = conn.createAtomicType(XQItemType.XQBASETYPE_STRING); XQItemType intType = conn.createAtomicType(XQItemType.XQBASETYPE_INT); // posititioned before the first item while (result.next()) { XQItemType type = result.getItemType(); // If string, then get the string value out if (type.equals(strType)) String str = result.getAtomicValue(); else if (type.equals(intType)) // if it is an integer.. int intval = result.getInt(); ... } result.close(); // explicitly close the result sequence \endcode
Definition at line 76 of file ZorbaXQResultSequence.java.
|
inline |
Definition at line 92 of file ZorbaXQResultSequence.java.
|
inline |
Moves the XQSequence's position to the given item number in this object.
If the item number is positive, the XQSequence moves to the given item number with respect to the beginning of the XQSequence. The first item is item 1, the second is item 2, and so on.
If the given item number is negative, the XQSequence positions itself on an absolute item position with respect to the end of the sequence.
For example, calling the method absolute(-1) positions the XQSequence on the last item; calling the method absolute(-2) moves the XQSequence to the next-to-last item, and so on. absolute(0) will position the sequence before the first item.
An attempt to position the sequence beyond the first/last item set leaves the current position to be before the first item or after the last item.
Calling this method on an empty sequence will return false.
i | - the item position to jump to |
XQException | - if (1) the sequence is forward only, or (2) the sequence is in a closed state |
Definition at line 129 of file ZorbaXQResultSequence.java.
|
inline |
Move to the position after the last item.
XQException | - if (1) the sequence is forward only, or (2) the sequence is in a closed state |
Definition at line 139 of file ZorbaXQResultSequence.java.
|
inline |
Moves to the position before the first item.
XQException | - if (1) the sequence is forward only, or (2) the sequence is in a closed state |
Definition at line 149 of file ZorbaXQResultSequence.java.
|
inline |
Closes the sequence and frees all resources associated with this sequence.
Closing an XQSequence object also implicitly closes all XQItem objects obtained from it. All methods other than the isClosed or close method will raise exceptions when invoked after closing the sequence. Calling close on an XQSequence object that is already closed has no effect.
XQException | - if there are errors during closing of the sequence |
Definition at line 161 of file ZorbaXQResultSequence.java.
References org.zorbaxquery.api.xqj.ZorbaXQStaticCollectionManager.close().
|
inline |
Returns a number indicating the number of items in the sequence.
XQException | - if (1) the sequence is forward-only, or (2) the sequence is closed |
Definition at line 198 of file ZorbaXQResultSequence.java.
|
inline |
Moves to the first item in the sequence.
The method returns true, if it was able to move to the first item in the sequence false, otherwise. Calling this method on an empty sequence will return false.
XQException | - if (1) the sequence is forward only, or (2) the sequence is in a closed state |
Definition at line 249 of file ZorbaXQResultSequence.java.
|
inline |
Gets the current item as a Java String.
The current item must be an atomic value. This function casts the current item to an xs:string value according to the casting rules defined in 17.1.2 Casting to xs:string and xs:untypedAtomic, XQuery 1.0 and XPath 2.0 Functions and Operators, and then returns the value as a Java String.
XQException | - if (1) there are errors accessing the item's value, (2) the item is not an atomic value, (3) there is an error when casting the item to a string representation, (4) the underlying sequence or item is in a closed state, or (5) in the case of forward only sequences, a get or write method was already invoked on the current item |
Definition at line 629 of file ZorbaXQResultSequence.java.
References org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getItem().
|
inline |
Gets the current item as a boolean.
The current item must be an atomic value of type xs:boolean or a subtype.
XQException | - if (1) the conversion of the current item to a boolean fails, (2) if there are errors accessing the current item, (3) if the underlying sequence or item is in a closed state, or (4) in the case of forward only sequences, a get or write method was already invoked on the current item |
Definition at line 545 of file ZorbaXQResultSequence.java.
References org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getItem().
|
inline |
Gets the current item as a byte.
The current item must be an atomic value of type xs:decimal or a subtype, and its value must be in the value space of byte.
XQException | - if (1) the conversion of the current item to a byte fails, (2) if there are errors accessing the current item, (3) if the underlying sequence or item is in a closed state, or (4) in the case of forward only sequences, a get or write method was already invoked on the current item |
Definition at line 559 of file ZorbaXQResultSequence.java.
References org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getItem().
|
inline |
Gets the XQuery connection associated with this result sequence.
XQException | - if the result sequence is in a closed state |
Definition at line 106 of file ZorbaXQResultSequence.java.
|
inline |
Gets the current item as a double.
The current item must be an atomic value of type xs:double or a subtype.
XQException | - if (1) the conversion of the current item to a double fails, (2) if there are errors accessing the current item, (3) if the underlying sequence or item is in a closed state, or (4) in the case of forward only sequences, a get or write method was already invoked on the current item |
Definition at line 573 of file ZorbaXQResultSequence.java.
References org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getItem().
|
inline |
Gets the current item as a float.
The current item must be an atomic value of type xs:float or a subtype.
XQException | - if (1) the conversion of the current item to a float fails, (2) if there are errors accessing the current item, (3) if the underlying sequence or item is in a closed state, or (4) in the case of forward only sequences, a get or write method was already invoked on the current item |
Definition at line 587 of file ZorbaXQResultSequence.java.
References org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getItem().
|
inline |
Gets the current item as an int.
The current item must be an atomic value of type xs:decimal or a subtype, and its value must be in the value space of int.
XQException | - if (1) the conversion of the current item to a int fails, (2) if there are errors accessing the current item, (3) if the underlying sequence or item is in a closed state, or (4) in the case of forward only sequences, a get or write method was already invoked on the current item |
Definition at line 601 of file ZorbaXQResultSequence.java.
References org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getItem().
|
inline |
Get the current item as an immutable XQItem object.
In case of an ZorbaXQResultSequence, the item is an ZorbaXQResultItem. In the case of forward only sequences, this method or any other get or write method may only be called once on the curent item.
The XQItem object is dependent on the sequence from which it was created and is only valid for the duration of XQSequence lifetime. Thus, the XQSequence is closed, this XQItem object will be implicitly closed and it can no longer be used.
XQException | - if (1) there are errors retrieving the item, or (2) in the case of a forward only sequence, a get or write method has already been invoked on the current item. |
Definition at line 264 of file ZorbaXQResultSequence.java.
Referenced by org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getAtomicValue(), org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getBoolean(), org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getByte(), org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getDouble(), org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getFloat(), org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getInt(), org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getItemAsStream(), org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getItemAsString(), org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getLong(), org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getNode(), org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getObject(), org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getShort(), org.zorbaxquery.api.xqj.ZorbaXQResultSequence.writeItem(), org.zorbaxquery.api.xqj.ZorbaXQResultSequence.writeItemToResult(), org.zorbaxquery.api.xqj.ZorbaXQResultSequence.writeItemToSAX(), org.zorbaxquery.api.xqj.ZorbaXQResultSequence.writeSequence(), org.zorbaxquery.api.xqj.ZorbaXQResultSequence.writeSequenceToResult(), and org.zorbaxquery.api.xqj.ZorbaXQResultSequence.writeSequenceToSAX().
|
inline |
Read the current item as an XMLStreamReader object.
Read the current item as an XMLStreamReader object, as described in Section 12.1 Serializing an XDM instance into a StAX event stream (XMLStreamReader), XQuery API for Java (XQJ) 1.0. Note that the serialization process might fail, in which case a XQException is thrown. While the stream is being read, the application MUST NOT do any other concurrent operations on the underlying item or sequence. The operation on the stream is undefined if the underlying sequence is repositioned or the state of the underlying item or sequence is changed by concurrent operations.
XQException | - if (1) there are errors accessing the current item or the underlying sequence, (2) the underlying sequence or item is in a closed state, (3) in the case of a forward only sequence, a get or write method has already been invoked on the current item, or (4) in case of an error during serialization of the current item into a StAX event stream as defined in Section 12.1 Serializing an XDM instance into a StAX event stream (XMLStreamReader), XQuery API for Java (XQJ) 1.0 |
Definition at line 700 of file ZorbaXQResultSequence.java.
References org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getItem().
|
inline |
Serializes the current item according to the XSLT 2.0 and XQuery 1.0 serialization.
Serialization parameters, which influence how serialization is performed, can be specified. Refer to the XSLT 2.0 and XQuery 1.0 serialization and Section 12 Serialization, XQuery API for Java (XQJ) 1.0 for more information.
prprts | - specifies the serialization parameters, null is considered equivalent to an empty Properties object |
XQException | - if (1) there are errors accessing the current item or the underlying sequence, (2) the underlying sequence or item is in a closed state, (3) in the case of a forward only sequence, a get or write method has already been invoked on the current item, or (4) if there are errors during serialization |
Definition at line 715 of file ZorbaXQResultSequence.java.
References org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getItem().
|
inline |
Gets the type of the item.
On a forward only sequence this method can be called independent of any other get or write method. It will not raise an error if such method has been called already, nor will it affect subsequent invocations of any other get or write method.
XQException | - if (1) there are errors accessing the type of the item, or (2) the underlying sequence or item is in a closed state |
Definition at line 615 of file ZorbaXQResultSequence.java.
|
inline |
Gets the current item as a long.
The current item must be an atomic value of type xs:decimal or a subtype, and its value must be in the value space of long.
XQException | - if (1) the conversion of the current item to a long fails, (2) if there are errors accessing the current item, (3) if the underlying sequence or item is in a closed state, or (4) in the case of forward only sequences, a get or write method was already invoked on the current item |
Definition at line 643 of file ZorbaXQResultSequence.java.
References org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getItem().
|
inline |
Gets the item as a DOM node.
The current item must be a node. The type of the returned DOM node is governed by Table 7 - XQuery Node Types and Corresponding Java Object Types XQuery API for Java (XQJ) 1.0 The instance of the returned node is implementation dependent. The node may be a reference or a copy of the internal state of the item. It is advisable to make a copy of the node if the application plans to modify it.
XQException | - if (1) if there are errors accessing the current item, (2) the current item is not a node, (3) if the underlying sequence or item is in a closed state, or (4) in the case of forward only sequences, a get or write method was already invoked on the current item |
Definition at line 657 of file ZorbaXQResultSequence.java.
References org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getItem().
|
inline |
Returns the URI for this item.
If the item is a document node, then this method returns the absolute URI of the resource from which the document node was constructed. If the document URI is not available, then the empty string is returned. If the document URI is available, the returned value is the same as if fn:document-uri were evaluated on this document node. If the item is of a node kind other than document node, then the returned URI is implementation-defined. On a forward only sequence this method can be called independent of any other get or write method. It will not raise an error if such method has been called already, nor will it affect subsequent invocations of any other get or write method on the current item.
XQException | - if (1) if there are errors accessing the current item, (2) the current item is not a node, (3) if the underlying sequence or item is in a closed state |
Definition at line 672 of file ZorbaXQResultSequence.java.
|
inline |
Gets the current item as an Object.
The data type of the returned object will be the Java Object type as specified in 14.4 Mapping an XQuery Atomic Value to a Java Object Type and 14.5 Mapping an XQuery Node to a Java Object Type, XQuery API for Java (XQJ) 1.0.
XQException | - if (1) if there are errors accessing the current item, (2) if the underlying sequence or item is in a closed state, or (3) in the case of forward only sequences, a get or write method was already invoked on the current item |
Definition at line 686 of file ZorbaXQResultSequence.java.
References org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getItem().
|
inline |
Gets the current cursor position.
0 indicates that the position is before the first item and count() + 1 indicates position after the last item. A specific position indicates that the cursor is positioned on the item at that position. Use the isOnItem method to verify if the cursor is positioned on the item.
Calling this method on an empty sequence will return 0.
XQException | - if (1) the sequence is forward-only, or (2) the sequence is closed |
Definition at line 212 of file ZorbaXQResultSequence.java.
|
inline |
Read the entire sequence starting from the current position as an XMLStreamReader object.
Read the entire sequence starting from the current position as an XMLStreamReader object, as described in Section 12.1 Serializing an XDM instance into a StAX event stream (XMLStreamReader), XQuery API for Java (XQJ) 1.0. Note that the serialization process might fail, in which case a XQException is thrown. While the stream is being read, the application MUST NOT do any other concurrent operations on the sequence. The operation on the stream is undefined if the underlying sequence position or state is changed by concurrent operations. After all items are written to the stream, the current position of the cursor is set to point after the last item. Also, in the case of forward only sequences, this method may only be called if the current item has not yet been read through any of the get or write methods.
XQException | - if (1) there are errors accessing any of the items in the sequence, (2) the sequence is in a closed state, (3) in the case of a forward only sequence, a get or write method has already been invoked on the current item, or (4) in case of an error during serialization of the sequence into a StAX event stream as defined in Section 12.1 Serializing an XDM instance into a StAX event stream (XMLStreamReader), XQuery API for Java (XQJ) 1.0 |
Definition at line 282 of file ZorbaXQResultSequence.java.
References org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getSequenceAsString().
|
inline |
Serializes the sequence starting from the current position to a String.
Serializes the sequence starting from the current position to a String according to the XSLT 2.0 and XQuery 1.0 serialization. Serialization parameters, which influence how serialization is performed, can be specified. Refer to the XSLT 2.0 and XQuery 1.0 serialization and Section 12 Serialization, XQuery API for Java (XQJ) 1.0 for more information. Reading the sequence during the serialization process performs implicit next operations to read the items. After all items are written to the stream, the current position of the cursor is set to point after the last item. Also, in the case of forward only sequences, this method may only be called if the current item has not yet been read through any of the get or write methods.
prprts | - specifies the serialization parameters, null is considered equivalent to an empty Properties object |
XQException | - if (1) there are errors accessing the items in the sequence, (2) there are errors during serialization, (3) the sequence is in a closed state, or (4) in the case of a forward only sequence, a get or write method has already been invoked on the current item |
Definition at line 307 of file ZorbaXQResultSequence.java.
Referenced by org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getSequenceAsStream().
|
inline |
Gets the current item as a short.
The current item must be an atomic value of type xs:decimal or a subtype, and its value must be in the value space of short.
XQException | - if (1) the conversion of the current item to a short fails, (2) if there are errors accessing the current item, (3) if the underlying sequence or item is in a closed state, or (4) in the case of forward only sequences, a get or write method was already invoked on the current item |
Definition at line 728 of file ZorbaXQResultSequence.java.
References org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getItem().
|
inline |
Returns a StaticCollectionManager.
Returns a CollectionManager responsible for all collections which are statically declared in the static context of this query (main module) or any transitively imported library module. The collection manager provides a set of functions for managing collections and their contents.
XQException | - if the object is closed |
Definition at line 842 of file ZorbaXQResultSequence.java.
|
inline |
Checks if the item "matches" an item type.
Checks if the item "matches" an item type, as defined in 2.5.4.2 Matching an Item Type and an Item, XQuery 1.0: An XML Query Language. You can use this method to first check the type of the result before calling the specific get methods.
Example -
xqit | - item type to match |
XQException | - if (1) there are errors accessing the item's type, (2) if the underlying sequence or item is in a closed state, (3) if the implementation is unable to determine the schema definition of a user defined schema type, or (4) the type parameter is null |
Definition at line 762 of file ZorbaXQResultSequence.java.
|
inline |
Checks if the current position is after the last item in the sequence.
Calling this method on an empty sequence will return false.
XQException | - if (1) the sequence is forward only, or (2) the sequence is in a closed state |
Definition at line 345 of file ZorbaXQResultSequence.java.
|
inline |
Checks if the current position before the first item in the sequence.
Calling this method on an empty sequence will return false.
XQException | - if (1) the sequence is forward only, or (2) the sequence is in a closed state |
Definition at line 358 of file ZorbaXQResultSequence.java.
|
inline |
Checks if the sequence is closed.
Definition at line 188 of file ZorbaXQResultSequence.java.
|
inline |
Checks if the current position at the first item in the sequence.
Calling this method on an empty sequence will return false.
XQException | - if (1) the sequence is forward only, or (2) the sequence is in a closed state |
Definition at line 371 of file ZorbaXQResultSequence.java.
|
inline |
Checks if the current position at the last item in the sequence.
Calling this method on an empty sequence will return false.
XQException | - if (1) the sequence is forward only, or (2) the sequence is in a closed state |
Definition at line 384 of file ZorbaXQResultSequence.java.
|
inline |
Check if the sequence is positioned on an item or not.
Calling this method on an empty sequence will return false.
XQException | - if the sequence is in a closed state |
Definition at line 225 of file ZorbaXQResultSequence.java.
Referenced by org.zorbaxquery.api.xqj.ZorbaXQResultSequence.writeSequence(), org.zorbaxquery.api.xqj.ZorbaXQResultSequence.writeSequenceToResult(), and org.zorbaxquery.api.xqj.ZorbaXQResultSequence.writeSequenceToSAX().
|
inline |
Checks if the sequence is scrollable.
XQException | - if the sequence is in a closed state |
Definition at line 236 of file ZorbaXQResultSequence.java.
|
inline |
Moves to the last item in the sequence.
This method returns true, if it was able to move to the last item in the sequence false, otherwise. Calling this method on an empty sequence will return false.
XQException | - if (1) the sequence is forward only, or (2) the sequence is in a closed state |
Definition at line 397 of file ZorbaXQResultSequence.java.
|
inline |
Moves to the next item in the sequence.
Calling this method on an empty sequence will return false.
XQException | - if the sequence is in a closed state |
Definition at line 410 of file ZorbaXQResultSequence.java.
Referenced by org.zorbaxquery.api.xqj.ZorbaXQResultSequence.writeSequence(), org.zorbaxquery.api.xqj.ZorbaXQResultSequence.writeSequenceToResult(), and org.zorbaxquery.api.xqj.ZorbaXQResultSequence.writeSequenceToSAX().
|
inline |
Moves to the previous item in the sequence.
Calling this method on an empty sequence will return false.
XQException | - if (1) the sequence is forward only, or (2) the sequence is in a closed state. |
Definition at line 431 of file ZorbaXQResultSequence.java.
|
inline |
Moves the cursor a relative number of items.
Moves the cursor a relative number of items, either positive or negative. Attempting to move beyond the first/last item in the sequence positions the sequence before/after the the first/last item. Calling relative(0) is valid, but does not change the cursor position. Note: Calling the method relative(1) is identical to calling the method next and calling the method relative(-1) is identical to calling the method previous(). Calling this method on an empty sequence will return false.
i | - the item position to jump to |
XQException | - if (1) the sequence is forward only, or (2) the sequence is in a closed state. |
Definition at line 446 of file ZorbaXQResultSequence.java.
|
inline |
Serializes the current item to a Writer.
Serializes the current item to a Writer according to XSLT 2.0 and XQuery 1.0 serialization. Serialization parameters, which influence how serialization is performed, can be specified. Refer to the XSLT 2.0 and XQuery 1.0 serialization and Section 12 Serialization, XQuery API for Java (XQJ) 1.0 for more information.
out | - the output stream into which the current item is to be serialized |
prprts | - specifies the serialization parameters, null is considered equivalent to an empty Properties object |
XQException | - if (1) there are errors accessing the current item or the underlying sequence, (2) the underlying sequence or item is in a closed state, (3) in the case of a forward only sequence, a get or write method has already been invoked on the current item, (4) if there are errors during serialization, or (5) the os parameter is null |
Definition at line 778 of file ZorbaXQResultSequence.java.
References org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getItem().
|
inline |
Serializes the current item to a Writer.
Serializes the current item to a Writer according to XSLT 2.0 and XQuery 1.0 serialization. Serialization parameters, which influence how serialization is performed, can be specified. Refer to the XSLT 2.0 and XQuery 1.0 serialization and Section 12 Serialization, XQuery API for Java (XQJ) 1.0 for more information.
Warning: When outputting to a Writer, make sure the writer's encoding matches the encoding parameter if specified as a property or the default encoding.
writer | - the output stream into which the current item is to be serialized |
prprts | - specifies the serialization parameters, null is considered equivalent to an empty Properties object |
XQException | - if (1) there are errors accessing the current item or the underlying sequence, (2) the underlying sequence or item is in a closed state, (3) in the case of a forward only sequence, a get or write method has already been invoked on the current item, (4) if there are errors during serialization, or (5) the os parameter is null |
Definition at line 795 of file ZorbaXQResultSequence.java.
References org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getItem().
|
inline |
Writes the current item to a Result.
First the item is normalized as described in XSLT 2.0 and XQuery 1.0 serialization. Subsequently it is serialized to the Result object. Note that the normalization process can fail, in which case an XQException is thrown. An XQJ implementation must at least support the following implementations:
result | - the result object into which the item is to be serialized |
XQException | - if (1) there are errors accessing the current item or the underlying sequence, (2) the underlying sequence or item is in a closed state, (3) in the case of a forward only sequence, a get or write method has already been invoked on the current item, (4) in case of an error while serializing the current item into the Result object, or (5) the result parameter is null |
Definition at line 828 of file ZorbaXQResultSequence.java.
References org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getItem().
|
inline |
Writes the current item to a SAX handler.
Writes the current item to a SAX handler, as described in in Section 12.2 Serializing an XDM instance into a SAX event stream, XQuery API for Java (XQJ) 1.0. Note that the serialization process might fail, in which case a XQException is thrown. The specified org.xml.sax.ContentHandler can optionally implement the org.xml.sax.LexicalHandler interface. An implementation must check if the specified ContentHandler implements LexicalHandler. If the handler is a LexicalHandler comment nodes are reported, otherwise they will be silently ignored.
ch | - the SAX content handler, optionally a lexical handler |
XQException | - if (1) there are errors accessing the current item or the underlying sequence, (2) the underlying sequence or item is in a closed state, (3) in the case of a forward only sequence, a get or write method has already been invoked on the current item, (4) in case of an error while serializing the XDM instance into a SAX event stream, or (5) the saxhdlr parameter is null |
Definition at line 810 of file ZorbaXQResultSequence.java.
References org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getItem().
|
inline |
Serializes the sequence starting from the current position to an OutputStream.
Serializes the sequence starting from the current position to an OutputStream according to the XSLT 2.0 and XQuery 1.0 serialization. Serialization parameters, which influence how serialization is performed, can be specified. Refer to the XSLT 2.0 and XQuery 1.0 serialization and Section 12 Serialization, XQuery API for Java (XQJ) 1.0 for more information. Reading the sequence during the serialization process performs implicit next operations to read the items. After all items are written to the stream, the current position of the cursor is set to point after the last item. Also, in the case of forward only sequences, this method may only be called if the current item has not yet been read through any of the get or write methods.
out | - the output stream into which the sequence is to be serialized |
prprts | - specifies the serialization parameters, null is considered equivalent to an empty Properties object |
XQException | - if (1) there are errors accessing the items in the sequence, (2) there are errors during serialization, (3) the sequence is in a closed state, (4) in the case of a forward only sequence, a get or write method has already been invoked on the current item, or (5) the os parameter is null |
Definition at line 460 of file ZorbaXQResultSequence.java.
References org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getItem(), org.zorbaxquery.api.xqj.ZorbaXQResultSequence.isOnItem(), and org.zorbaxquery.api.xqj.ZorbaXQResultSequence.next().
|
inline |
Serializes the sequence starting from the current position to a Writer.
Serializes the sequence starting from the current position to a Writer according to the XSLT 2.0 and XQuery 1.0 serialization. Serialization parameters, which influence how serialization is performed, can be specified. Refer to the XSLT 2.0 and XQuery 1.0 serialization and Section 12 Serialization, XQuery API for Java (XQJ) 1.0 for more information.
Warning: When outputting to a Writer, make sure the writer's encoding matches the encoding parameter if specified as a property or the default encoding.
Reading the sequence during the serialization process performs implicit next operations to read the items. After all items are written to the stream, the current position of the cursor is set to point after the last item. Also, in the case of forward only sequences, this method may only be called if the current item has not yet been read through any of the get or write methods.
writer | - the writer object into which the sequence is to be serialized |
prprts | - specifies the serialization parameters, null is considered equivalent to an empty Properties object |
XQException | - if (1) there are errors accessing the items in the sequence, (2) there are errors during serialization, (3) the sequence is in a closed state, (4) in the case of a forward only sequence, a get or write method has already been invoked on the current item, or (5) the ow parameter is null |
Definition at line 484 of file ZorbaXQResultSequence.java.
References org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getItem(), org.zorbaxquery.api.xqj.ZorbaXQResultSequence.isOnItem(), and org.zorbaxquery.api.xqj.ZorbaXQResultSequence.next().
|
inline |
Writes the entire sequence starting from the current position to a Result.
First the sequence is normalized as described in XSLT 2.0 and XQuery 1.0 serialization. Subsequently it is serialized to the Result object. Note that the normalization process can fail, in which case an XQException is thrown. An XQJ implementation must at least support the following implementations:
result | - the result object into which the sequence is to be serialized |
XQException | - if (1) there are errors accessing any of the items in the sequence, (2) the sequence is in a closed state, (3) in the case of a forward only sequence, a get or write method has already been invoked on the current item, (4) in case of an error while serializing the sequence into the Result object, or (5) the result parameter is null |
Definition at line 526 of file ZorbaXQResultSequence.java.
References org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getItem(), org.zorbaxquery.api.xqj.ZorbaXQResultSequence.isOnItem(), and org.zorbaxquery.api.xqj.ZorbaXQResultSequence.next().
|
inline |
Writes the entire sequence starting from the current position to a SAX handler.
Writes the entire sequence starting from the current position to a SAX handler, as described in Section 12.2 Serializing an XDM instance into a SAX event stream, XQuery API for Java (XQJ) 1.0. Note that the serialization process might fail, in which case a XQException is thrown. After all items are written to the stream, the current position of the cursor is set to point after the last item. Also, in the case of forward only sequences, this method may only be called if the current item has not yet been read through any of the get or write methods. The specified org.xml.sax.ContentHandler can optionally implement the org.xml.sax.LexicalHandler interface. An implementation must check if the specified ContentHandler implements LexicalHandler. If the handler is a LexicalHandler comment nodes are reported, otherwise they will be silently ignored.
ch | - the SAX content handler, optionally a lexical handler |
XQException | - if (1) there are errors accessing any of the items in the sequence, (2) the sequence is in a closed state, (3) in the case of a forward only sequence, a get or write method has already been invoked on the current item, (4) in case of an error during serializing the XDM instance into a SAX event stream, or (5) the saxhdlr parameter is null |
Definition at line 503 of file ZorbaXQResultSequence.java.
References org.zorbaxquery.api.xqj.ZorbaXQResultSequence.getItem(), org.zorbaxquery.api.xqj.ZorbaXQResultSequence.isOnItem(), and org.zorbaxquery.api.xqj.ZorbaXQResultSequence.next().