|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectnet.sf.saxon.xqj.Closable
net.sf.saxon.xqj.SaxonXQItem
public class SaxonXQItem
This Saxon class is used to implement both the XQItem and XQResultItem interfaces in XQJ. Where the item is not a real XQResultItem, getConnection() will return null.
| Constructor Summary | |
|---|---|
SaxonXQItem(Item item,
SaxonXQDataFactory factory)
|
|
| Method Summary | |
|---|---|
String |
getAtomicValue()
Gets the current item as a Java String. |
boolean |
getBoolean()
Gets the current item as a boolean. |
byte |
getByte()
Gets the current item as a byte. |
XQConnection |
getConnection()
Gets the XQuery connection associated with this result item |
double |
getDouble()
Gets the current item as a double. |
float |
getFloat()
Gets the current item as a float. |
int |
getInt()
Gets the current item as an int. |
XMLStreamReader |
getItemAsStream()
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. |
String |
getItemAsString(Properties props)
Serializes the current item according to the XSLT 2.0 and XQuery 1.0 serialization. |
XQItemType |
getItemType()
Gets the type of the item. |
long |
getLong()
Gets the current item as a long. |
Node |
getNode()
Gets the item as a DOM node. |
URI |
getNodeUri()
Returns the URI for this item. |
Object |
getObject()
Gets the current item as an Object. |
Item |
getSaxonItem()
Get the current item, in the form of a Saxon Item object. |
short |
getShort()
Gets the current item as a short. |
boolean |
instanceOf(XQItemType 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. |
protected static void |
validateSerializationProperties(Properties props,
Configuration config)
|
void |
writeItem(OutputStream os,
Properties props)
Serializes the current item to a Writer according to
XSLT 2.0 and XQuery 1.0 serialization. |
void |
writeItem(Writer ow,
Properties props)
Serializes the current item to a Writer according to
XSLT 2.0 and XQuery 1.0 serialization. |
void |
writeItemToResult(Result result)
Writes the current item to a Result. |
void |
writeItemToSAX(ContentHandler saxHandler)
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. |
| Methods inherited from class net.sf.saxon.xqj.Closable |
|---|
close, isClosed, setClosableContainer |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface javax.xml.xquery.XQItem |
|---|
close, isClosed |
| Constructor Detail |
|---|
public SaxonXQItem(Item item,
SaxonXQDataFactory factory)
| Method Detail |
|---|
public Item getSaxonItem()
SaxonXQItemAccessorNodeInfo or AtomicValue.
getSaxonItem in interface SaxonXQItemAccessor
public XQConnection getConnection()
throws XQException
XQResultItem
getConnection in interface XQResultItemXQException - if the result item is in a closed state
public String getAtomicValue()
throws XQException
XQItemAccessorString. 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.
getAtomicValue in interface XQItemAccessorXQException - 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
public boolean getBoolean()
throws XQException
XQItemAccessorboolean.
The current item must be an atomic value of type xs:boolean
or a subtype.
getBoolean in interface XQItemAccessorboolean representing the current item
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
public byte getByte()
throws XQException
XQItemAccessorbyte.
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.
getByte in interface XQItemAccessorbyte representing the current item
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
public double getDouble()
throws XQException
XQItemAccessordouble.
The current item must be an atomic value of type xs:double
or a subtype.
getDouble in interface XQItemAccessordouble representing the current item
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
public float getFloat()
throws XQException
XQItemAccessorfloat.
The current item must be an atomic value of type xs:float
or a subtype.
getFloat in interface XQItemAccessorfloat representing the current item
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
public int getInt()
throws XQException
XQItemAccessorint.
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.
getInt in interface XQItemAccessorint representing the current item
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
public XMLStreamReader getItemAsStream()
throws XQException
XQItemAccessorXMLStreamReader 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.
getItemAsStream in interface XQItemAccessorXMLStreamReader
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
public String getItemAsString(Properties props)
throws XQException
XQItemAccessor
getItemAsString in interface XQItemAccessorprops - 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
protected static void validateSerializationProperties(Properties props,
Configuration config)
throws XQException
XQException
public XQItemType getItemType()
throws XQException
XQItemAccessor
getItemType in interface XQItemAccessorXQException - if (1) there are errors accessing the type of the item,
or (2) the underlying sequence or item is in a closed state
public long getLong()
throws XQException
XQItemAccessorlong.
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.
getLong in interface XQItemAccessorlong representing the current item
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
public Node getNode()
throws XQException
XQItemAccessor
getNode in interface XQItemAccessorXQException - 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
public URI getNodeUri()
throws XQException
XQItemAccessorfn: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.
getNodeUri in interface XQItemAccessorXQException - 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
public Object getObject()
throws XQException
XQItemAccessorObject.
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.
getObject in interface XQItemAccessorXQException - 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
public short getShort()
throws XQException
XQItemAccessorshort.
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.
getShort in interface XQItemAccessorshort representing the current item
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
public boolean instanceOf(XQItemType type)
throws XQException
XQItemAccessor
...
XQItemType strType = conn.createAtomicType(XQItemType.XQBASETYPE_STRING);
XQItemType nodeType = conn.createNodeType();
XQSequence result = preparedExpr.executeQuery();
while (result.next())
{
// Generic check for node..
if (result.instanceOf(nodeType))
org.w3.dom.Node node = result.getNode();
else if (result.instanceOf(strType))
String str = result.getAtomicValue();
}
XQItemAccessor or the input
XQItemType is not a built-in type, then this method is
allowed to raise exception if it can NOT determine the instanceOf
relationship due to the lack of the access of
the XML schema that defines the user defined schema types if the
XQMetaData.isUserDefinedXMLSchemaTypeSupported() method
returns false.
XQItemAccessor is an instance of the input
XQItemType. Note even if
isUserDefinedXMLSchemaTypeSupported() returns false,
an XQJ implementation may still be able to determine the instanceOf
relationship for certain cases involving user defined schema type.
For example, if the type of an XQItemAccessor is of
mySchema:hatSize sequence type and the input parameter
XQItemType is of item() sequence type,
the return value for instanceOf relationship should always be true
even though the XQJ implementation does not know the precise type
information of mySchema:hatSize type defined in XML
schema 'mySchema'.
instanceOf in interface XQItemAccessortype - item type to match
true if this item matches
the input item type as defined in
2.5.4.2 Matching an Item Type and an Item,
XQuery 1.0: An XML Query Language,
and false if it does not
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
public void writeItem(OutputStream os,
Properties props)
throws XQException
XQItemAccessorWriter 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.
writeItem in interface XQItemAccessoros - the output stream into which the current item is
to be serializedprops - 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
public void writeItem(Writer ow,
Properties props)
throws XQException
XQItemAccessorWriter 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.
Writer, make sure the writer's encoding
matches the encoding parameter if specified as a property or the default
encoding.
writeItem in interface XQItemAccessorow - the writer object into which the current item is to be
serializedprops - 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 ow parameter is null
public void writeItemToResult(Result result)
throws XQException
XQItemAccessorResult. First the item is
normalized as described in
XSLT 2.0 and XQuery 1.0 serialization. Subsequently it is
serialized to the Result object.XQException is thrown.
An XQJ implementation must at least support the following implementations:
javax.xml.transform.dom.DOMResultjavax.xml.transform.sax.SAXResultjavax.xml.transform.stream.StreamResult
writeItemToResult in interface XQItemAccessorresult - 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
public void writeItemToSAX(ContentHandler saxHandler)
throws XQException
XQItemAccessorXQException 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.
writeItemToSAX in interface XQItemAccessorsaxHandler - 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
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||