oracle.xml.xquery

Interface OXQItemAccessor

All Known Subinterfaces:

OXQItem, OXQSequence

public interface OXQItemAccessor

Extensions to javax.xml.xquery.XQItemAccessor.

Use method OXQView.getItemAccessor(XQItemAccessor) to access the extensions. For example:

 OXQDataSource ds = new OXQDataSource();
 XQConnection con = ds.getConnection();
 XQItem item = con.createItemFromDocument(...); // XQItem extends XQItemAccessor
 OXQItemAccessor oitem = OXQView.getItemAccessor(item);
 ...
 

Since:

12.1

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttributeValue() Returns the value of the item, if the item is an attribute node.
java.io.InputStream	getItemAsInputStream(java.util.Properties props) Reads the current item as an InputStream object, as described in Section 12 Serialization, XQuery API for Java (XQJ) 1.0.
int	getItemKind() This is a convenience method that is equivalent to getItemType().getItemKind().
javax.xml.namespace.QName	getNodeName() Returns the node name for this item, if the item is an element or an attribute node.
java.lang.String	getTextValue() Returns the value of the item, if the item is an text node.
XQItemAccessor	getXQView() Returns the XQItemAccessor instance corresponding to this instance.

Method Detail

getXQView

XQItemAccessor getXQView()

Returns the XQItemAccessor instance corresponding to this instance.

Returns:

the XQItemAccessor instance

getItemAsInputStream

java.io.InputStream getItemAsInputStream(java.util.Properties props)
                                  throws XQException

Reads the current item as an InputStream object, as described in Section 12 Serialization, XQuery API for Java (XQJ) 1.0. The serialization process might fail, in which case an exception is thrown.

While the stream is being read, the application must not do any other concurrent operations on the underlying XQItem or XQSequence instance. If the underlying sequence is repositioned or the state of the underlying item or sequence is changed, the behavior of the stream is undefined.

Parameters:

props - specifies the serialization parameters, null is considered equivalent to an empty Properties object

Returns:

the input stream

Throws:

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

getNodeName

javax.xml.namespace.QName getNodeName()
                               throws XQException

Returns the node name for this item, if the item is an element or an attribute node.

Returns:

the node name for this element or attribute node or null for all other kinds of items.

Throws:

XQException - if (1) there are errors accessing the current item, (2) if the underlying sequence or item is in a closed state

getAttributeValue

java.lang.String getAttributeValue()
                            throws XQException

Returns the value of the item, if the item is an attribute node.

Returns:

the value of an attribute node or null for all other kinds of items.

Throws:

XQException - if (1) there are errors accessing the current item, (2) if the underlying sequence or item is in a closed state

getTextValue

java.lang.String getTextValue()
                       throws XQException

Returns the value of the item, if the item is an text node.

Returns:

the value of a text node or null for all other kinds of items.

Throws:

XQException - if (1) there are errors accessing the current item, (2) if the underlying sequence or item is in a closed state

getItemKind

int getItemKind()
         throws XQException

This is a convenience method that is equivalent to getItemType().getItemKind().

Returns:

kind of this item.

Throws:

XQException - if (1) there are errors accessing the current item, (2) if the underlying sequence or item is in a closed state

See Also:

XQItemAccessor.getItemType(), XQItemType.getItemKind()