de.fraunhofer.ipsi.ipsixq.api.impl
Class XQAbstractResultItem

java.lang.Object
  extended by de.fraunhofer.ipsi.ipsixq.api.impl.XQAbstractResultItem
All Implemented Interfaces:
XQItem, XQItemAccessor, XQResultItem
Direct Known Subclasses:
XQResultItemImpl

public class XQAbstractResultItem
extends java.lang.Object
implements XQResultItem

Author:
Michael Stark

Constructor Summary
XQAbstractResultItem()
           
 
Method Summary
 void clearWarnings()
          Clears the list of warnings associated with this result item.
 void close()
          Close the item and release all the resources associated with this item.
 java.util.Calendar getCalendar()
          Gets a calendar value.
 XQConnection getConnection()
          Gets the XQuery Connection associated with this result item.
 double getDouble()
          Gets a double value.
 int getInt()
          Gets an integer value.
 XQItemType getItemType()
          Gets the type of the the item.
 java.lang.String getLexicalValue()
          Gets the lexical string representation of the item.
 long getLong()
          Gets a long value.
 org.w3c.dom.Node getNode()
          Gets the item as a DOM node (if the current item is known to be a node).
 java.net.URI getNodeUri()
          Gets the URI associated with the content of this item.
 java.lang.Object getObject()
          Returns a generic java object corresponding to the XQuery type.
 java.lang.Object getObject(XQCommonHandler hdlr)
          Returns a java object corresponding to the XQuery type using the XQCommonhandler passed in.
 java.lang.String getString()
          Gets a string value.
 XQWarning getWarnings()
          Gets the first warning in the list of warnings associated with this result item.
 javax.xml.stream.XMLStreamReader getXMLStreamReader()
          Gets the current item as an XMLStreamReader object.
 boolean instanceOf(XQItemType type)
          Checks if the item is an instance of the given type (exact or subset of given type).
 boolean isClosed()
          Checks if the item is closed.
 void writeSAX(org.xml.sax.ContentHandler saxhdlr)
          Writes the current item to the SAX stream.
 void writeXMLStream(javax.xml.stream.XMLStreamWriter writer)
          Writes the current item to the XMLStreamWriter stream.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XQAbstractResultItem

public XQAbstractResultItem()
Method Detail

clearWarnings

public void clearWarnings()
Description copied from interface: XQResultItem
Clears the list of warnings associated with this result item.

Specified by:
clearWarnings in interface XQResultItem

getConnection

public XQConnection getConnection()
                           throws XQException
Description copied from interface: XQResultItem
Gets the XQuery Connection associated with this result item.

Specified by:
getConnection in interface XQResultItem
Throws:
XQException

getWarnings

public XQWarning getWarnings()
                      throws XQException
Description copied from interface: XQResultItem
Gets the first warning in the list of warnings associated with this result item.

Specified by:
getWarnings in interface XQResultItem
Throws:
XQException

close

public void close()
           throws XQException
Description copied from interface: XQItem
Close the item and release all the resources associated with this item.

Specified by:
close in interface XQItem
Throws:
XQException

isClosed

public boolean isClosed()
Description copied from interface: XQItem
Checks if the item is closed.

Specified by:
isClosed in interface XQItem

getCalendar

public java.util.Calendar getCalendar()
                               throws XQException
Description copied from interface: XQItemAccessor
Gets a calendar value.

Specified by:
getCalendar in interface XQItemAccessor
Throws:
XQException

getDouble

public double getDouble()
                 throws XQException
Description copied from interface: XQItemAccessor
Gets a double value.

Specified by:
getDouble in interface XQItemAccessor
Throws:
XQException

getInt

public int getInt()
           throws XQException
Description copied from interface: XQItemAccessor
Gets an integer value.

Specified by:
getInt in interface XQItemAccessor
Throws:
XQException

getItemType

public XQItemType getItemType()
                       throws XQException
Description copied from interface: XQItemAccessor
Gets the type of the the item.

Specified by:
getItemType in interface XQItemAccessor
Throws:
XQException

getLexicalValue

public java.lang.String getLexicalValue()
                                 throws XQException
Description copied from interface: XQItemAccessor
Gets the lexical string representation of the item.

Specified by:
getLexicalValue in interface XQItemAccessor
Throws:
XQException

getLong

public long getLong()
             throws XQException
Description copied from interface: XQItemAccessor
Gets a long value.

Specified by:
getLong in interface XQItemAccessor
Throws:
XQException

getNode

public org.w3c.dom.Node getNode()
                         throws XQException
Description copied from interface: XQItemAccessor
Gets the item as a DOM node (if the current item is known to be a node).

Specified by:
getNode in interface XQItemAccessor
Throws:
XQException

getNodeUri

public java.net.URI getNodeUri()
                        throws XQException
Description copied from interface: XQItemAccessor
Gets the URI associated with the content of this item.

Specified by:
getNodeUri in interface XQItemAccessor
Throws:
XQException

getObject

public java.lang.Object getObject()
                           throws XQException
Description copied from interface: XQItemAccessor
Returns a generic java object corresponding to the XQuery type.

Specified by:
getObject in interface XQItemAccessor
Throws:
XQException

getObject

public java.lang.Object getObject(XQCommonHandler hdlr)
                           throws XQException
Description copied from interface: XQItemAccessor
Returns a java object corresponding to the XQuery type using the XQCommonhandler passed in.

Specified by:
getObject in interface XQItemAccessor
Throws:
XQException

getString

public java.lang.String getString()
                           throws XQException
Description copied from interface: XQItemAccessor
Gets a string value.

Specified by:
getString in interface XQItemAccessor
Throws:
XQException

getXMLStreamReader

public javax.xml.stream.XMLStreamReader getXMLStreamReader()
                                                    throws XQException
Description copied from interface: XQItemAccessor
Gets the current item as an XMLStreamReader object.

Specified by:
getXMLStreamReader in interface XQItemAccessor
Throws:
XQException

instanceOf

public boolean instanceOf(XQItemType type)
                   throws XQException
Description copied from interface: XQItemAccessor
Checks if the item is an instance of the given type (exact or subset of given type).

Specified by:
instanceOf in interface XQItemAccessor
Throws:
XQException

writeSAX

public void writeSAX(org.xml.sax.ContentHandler saxhdlr)
              throws XQException
Description copied from interface: XQItemAccessor
Writes the current item to the SAX stream.

Specified by:
writeSAX in interface XQItemAccessor
Throws:
XQException

writeXMLStream

public void writeXMLStream(javax.xml.stream.XMLStreamWriter writer)
                    throws XQException
Description copied from interface: XQItemAccessor
Writes the current item to the XMLStreamWriter stream.

Specified by:
writeXMLStream in interface XQItemAccessor
Throws:
XQException