Qizx/open API

net.axyana.qizxopen.xquery
Class XQResultSequence

java.lang.Object
  extended bynet.axyana.qizxopen.xquery.XQResultSequence
All Implemented Interfaces:
java.io.Serializable, XQItem

public class XQResultSequence
extends java.lang.Object
implements XQItem

Represents the result of the evaluation of a query, which is a sequence of Items (XQItem).

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface net.axyana.qizxopen.xquery.XQItem
INCOMPARABLE
 
Constructor Summary
XQResultSequence(int remotePipe, net.axyana.qizxopen.xquery.impl.XQueryExpressionCx expr)
           
XQResultSequence(XQValue localValue)
           
 
Method Summary
 void beforeFirst()
           
 void close()
           
 int compareTo(XQItem that, EvalContext context)
          Compares two items.
 boolean deepEqual(XQItem item, java.text.Collator collator)
          Deep equality of two items.
 void exportNode(XMLEventHandler handler)
          Retrieves the current node item into an external format.
 boolean getBoolean()
          Gets the item as a boolean value.
 java.math.BigDecimal getDecimal()
          Gets the item as a decimal value.
 double getDouble()
          Gets the item as a double value.
 net.axyana.qizxopen.util.time.Duration getDuration()
          Gets the item as a Duration value.
 float getFloat()
          Gets the item as a float value.
 long getInteger()
          Gets the item as a integer value.
 XQItem getItem()
           
 net.axyana.qizxopen.util.time.DateTimeBase getMoment()
          Gets the item as a Duration value.
 XQNode getNode()
          Gets the item as a Node value.
 java.lang.String getString()
          Gets the item as a String value.
 XQItemType getType()
          Returns the type description.
 boolean isNode()
          Tests whether the item is a Node.
 boolean next()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XQResultSequence

public XQResultSequence(XQValue localValue)

XQResultSequence

public XQResultSequence(int remotePipe,
                        net.axyana.qizxopen.xquery.impl.XQueryExpressionCx expr)
Method Detail

beforeFirst

public void beforeFirst()
                 throws XQueryException
Throws:
XQueryException

next

public boolean next()
             throws XQueryException
Throws:
XQueryException

getItem

public XQItem getItem()
               throws XQEvalException
Throws:
XQEvalException

exportNode

public void exportNode(XMLEventHandler handler)
                throws XQueryException
Retrieves the current node item into an external format.

Parameters:
handler - any object implementing the XMLEventHandler, typically XMLSerializer, DOMEventBuilder...
Throws:
XQueryException

close

public void close()
           throws XQueryException
Throws:
XQueryException

getType

public XQItemType getType()
                   throws XQEvalException
Description copied from interface: XQItem
Returns the type description.

Specified by:
getType in interface XQItem
Throws:
XQEvalException

getBoolean

public boolean getBoolean()
                   throws XQEvalException
Description copied from interface: XQItem
Gets the item as a boolean value.

Specified by:
getBoolean in interface XQItem
Throws:
XQEvalException

getFloat

public float getFloat()
               throws XQEvalException
Description copied from interface: XQItem
Gets the item as a float value.

Specified by:
getFloat in interface XQItem
Throws:
XQEvalException

getDouble

public double getDouble()
                 throws XQEvalException
Description copied from interface: XQItem
Gets the item as a double value.

Specified by:
getDouble in interface XQItem
Throws:
XQEvalException

getInteger

public long getInteger()
                throws XQEvalException
Description copied from interface: XQItem
Gets the item as a integer value.

Specified by:
getInteger in interface XQItem
Throws:
XQEvalException

getDecimal

public java.math.BigDecimal getDecimal()
                                throws XQEvalException
Description copied from interface: XQItem
Gets the item as a decimal value.

Specified by:
getDecimal in interface XQItem
Throws:
XQEvalException

getString

public java.lang.String getString()
                           throws XQEvalException
Description copied from interface: XQItem
Gets the item as a String value.

Specified by:
getString in interface XQItem
Throws:
XQEvalException

getDuration

public net.axyana.qizxopen.util.time.Duration getDuration()
                                                   throws XQEvalException
Description copied from interface: XQItem
Gets the item as a Duration value.

Specified by:
getDuration in interface XQItem
Throws:
XQEvalException

getMoment

public net.axyana.qizxopen.util.time.DateTimeBase getMoment()
                                                     throws XQEvalException
Description copied from interface: XQItem
Gets the item as a Duration value.

Specified by:
getMoment in interface XQItem
Throws:
XQEvalException

getNode

public XQNode getNode()
               throws XQEvalException
Description copied from interface: XQItem
Gets the item as a Node value.

Specified by:
getNode in interface XQItem
Throws:
XQEvalException

isNode

public boolean isNode()
Description copied from interface: XQItem
Tests whether the item is a Node.

Specified by:
isNode in interface XQItem

compareTo

public int compareTo(XQItem that,
                     EvalContext context)
              throws XQEvalException
Description copied from interface: XQItem
Compares two items.

Specified by:
compareTo in interface XQItem
Returns:
0 if items are equal; -1 if this < that; 1 if this > that; INCOMPARABLE if no order is defined, or items are of different nature (no exception raised).
Throws:
XQEvalException

deepEqual

public boolean deepEqual(XQItem item,
                         java.text.Collator collator)
                  throws XQEvalException
Description copied from interface: XQItem
Deep equality of two items.

Specified by:
deepEqual in interface XQItem
Throws:
XQEvalException

© 2005 Axyana Software