A connection (session) with a specific XQuery engine. More...
Public Member Functions | |
void | close () throws XQException |
Closes the connection. | |
void | commit () throws XQException |
Makes all changes made in the current transaction permanent and releases any locks held by the datasource. | |
XQItemType | createAtomicType (int basetype) throws XQException |
Creates a new ZorbaXQItemType object representing an XQuery atomic type. | |
XQItemType | createAtomicType (int basetype, QName qname, URI uri) throws XQException |
Creates a new ZorbaXQItemType object representing an XQuery atomic type. | |
XQItemType | createAttributeType (QName nodename, int basetype) throws XQException |
Creates a new ZorbaXQItemType object representing the XQuery attribute(nodename, basetype) type with the given node name and base type. | |
XQItemType | createAttributeType (QName nodename, int basetype, QName typename, URI schemaURI) throws XQException |
Creates a new ZorbaXQItemType object representing the XQuery attribute(nodename, basetype) type with the given node name and base type. | |
XQItemType | createCommentType () throws XQException |
Creates a new ZorbaXQItemType object representing the XQuery comment() type. | |
XQItemType | createDocumentElementType (XQItemType elementType) throws XQException |
Creates a new ZorbaXQItemType object representing the XQuery document-node(elementType) type containing a single element. | |
XQItemType | createDocumentSchemaElementType (XQItemType elementType) throws XQException |
Creates a new ZorbaXQItemType object representing the XQuery document-node(elementType) type containing a single schema-element(...). | |
XQItemType | createDocumentType () throws XQException |
Creates a new ZorbaXQItemType object representing the XQuery document-node() type. | |
XQItemType | createElementType (QName nodename, int baseType) throws XQException |
Creates a new ZorbaXQItemType object representing the XQuery element(nodename, basetype) type, with the given node name and base type. | |
XQItemType | createElementType (QName nodename, int baseType, QName typename, URI schemaURI, boolean allowNill) throws XQException |
Creates a new ZorbaXQItemType object representing the XQuery element(nodename,basetype,typename,schemaURI, allowNill) type, given the node name, base type, schema type name, schema URI, and nilled check. | |
XQExpression | createExpression () throws XQException |
Creates a new ZorbaXQExpression object that can be used to perform execute immediate operations with XQuery expressions. | |
XQExpression | createExpression (XQStaticContext value) throws XQException |
Creates a new ZorbaXQExpression object that can be used to perform execute immediate operations with XQuery expressions. | |
XQItem | createItem (XQItem value) throws XQException |
Creates a copy of the specified ZorbaXQItem. | |
XQItem | createItemFromAtomicValue (String value, XQItemType type) throws XQException |
Creates an item from a given value. | |
XQItem | createItemFromBoolean (boolean bln, XQItemType type) throws XQException |
XQItem | createItemFromByte (byte b, XQItemType type) throws XQException |
Creates an item from a given value. | |
XQItem | createItemFromDocument (String value, String baseURI, XQItemType type) throws XQException |
Creates an item from the given value. | |
XQItem | createItemFromDocument (Reader value, String baseURI, XQItemType type) throws XQException |
Creates an item from the given value. | |
XQItem | createItemFromDocument (InputStream value, String baseURI, XQItemType type) throws XQException |
Creates an item from the given value. | |
XQItem | createItemFromDocument (XMLStreamReader value, XQItemType type) throws XQException |
Creates an item from the given value. | |
XQItem | createItemFromDocument (Source value, XQItemType type) throws XQException |
Creates an item from the given value. | |
XQItem | createItemFromDouble (double value, XQItemType type) throws XQException |
Creates an item from a given value. | |
XQItem | createItemFromFloat (float value, XQItemType type) throws XQException |
Creates an item from a given value. | |
XQItem | createItemFromInt (int value, XQItemType type) throws XQException |
Creates an item from a given value. | |
XQItem | createItemFromLong (long value, XQItemType type) throws XQException |
Creates an item from a given value. | |
XQItem | createItemFromNode (Node value, XQItemType type) throws XQException |
Creates an item from a given value. | |
XQItem | createItemFromObject (Object value, XQItemType type) throws XQException |
Creates an item from a given value. | |
XQItem | createItemFromShort (short value, XQItemType type) throws XQException |
Creates an item from a given value. | |
XQItem | createItemFromString (String value, XQItemType type) throws XQException |
Creates an item from a given value. | |
XQItemType | createItemType () throws XQException |
Creates a new ZorbaXQItemType object representing the XQuery item type. | |
XQItemType | createNodeType () throws XQException |
Creates a new ZorbaXQItemType object representing the XQuery node() type. | |
XQItemType | createProcessingInstructionType (String piTarget) throws XQException |
Creates a new ZorbaXQItemType object representing the XQuery processing-instruction(piTarget) type. | |
XQItemType | createSchemaAttributeType (QName nodename, int basetype, URI uri) throws XQException |
Creates a new ZorbaXQItemType object representing the XQuery schema-attribute(nodename,basetype,schemaURI) type, with the given node name, base type, and schema URI. | |
XQItemType | createSchemaElementType (QName nodename, int baseType, URI schemaURI) throws XQException |
Creates a new ZorbaXQItemType object representing the XQuery schema-element(nodename,basetype,schemaURI) type, given the node name, base type, and the schema URI. | |
XQSequence | createSequence (XQSequence value) throws XQException |
Creates a copy of the specified ZorbaXQSequence. | |
XQSequence | createSequence (Iterator value) throws XQException |
Creates an ZorbaXQSequence, containing all the items from the iterator. | |
XQSequenceType | createSequenceType (XQItemType item, int occurence) throws XQException |
Creates a new sequence type from an item type and occurence indicator. | |
XQItemType | createTextType () throws XQException |
Creates a new ZorbaXQItemType object representing the XQuery text() type. | |
boolean | getAutoCommit () throws XQException |
Gets the auto-commit attribute of this connection. | |
XQMetaData | getMetaData () throws XQException |
Gets the metadata for this connection. | |
XQStaticContext | getStaticContext () throws XQException |
Gets an ZorbaXQStaticContext representing the default values for all expression properties. | |
ZorbaXQXmlDataManager | getXmlDataManager () |
boolean | isClosed () |
Checks if the connection is closed. | |
XQPreparedExpression | prepareExpression (String value) throws XQException |
Prepares an expression for execution. | |
XQPreparedExpression | prepareExpression (String string, XQStaticContext xqsc) throws XQException |
Prepares an expression for execution. | |
XQPreparedExpression | prepareExpression (Reader reader) throws XQException |
Prepares an expression for execution. | |
XQPreparedExpression | prepareExpression (Reader reader, XQStaticContext xqsc) throws XQException |
Prepares an expression for execution. | |
XQPreparedExpression | prepareExpression (InputStream in) throws XQException |
Prepares an expression for execution. | |
XQPreparedExpression | prepareExpression (InputStream in, XQStaticContext xqsc) throws XQException |
Prepares an expression for execution. | |
void | rollback () throws XQException |
Undoes all changes made in the current transaction and releases any locks held by the datasource. | |
void | setAutoCommit (boolean bln) throws XQException |
void | setStaticContext (XQStaticContext xqsc) throws XQException |
Sets the default values for all expression properties. | |
ZorbaXQConnection () | |
ZorbaXQConnection (Properties aProperties) |
Protected Member Functions | |
Zorba | getZorbaInstance () throws XQException |
A connection (session) with a specific XQuery engine.
Connections are obtained through an ZorbaXQDataSource object.
XQuery expressions are executed and results are returned within the context of a connection. They are either executed through ZorbaXQExpression or ZorbaXQPreparedExpression objects.
ZorbaXQDataSource ds;// obtain the XQuery datasource ... ZorbaXQConnection conn = ds.getConnection();
ZorbaXQPreparedExpression expr = conn.prepareExpression("for $i in ..."); XQResultSequence result = expr.executeQuery(); // - or - ZorbaXQExpression expr = conn.createExpression(); ZorbaXQSequence result = expr.executeQuery("for $i in..");
// The sequence can now be iterated while (result.next()) { String str = result.getItemAsString(); System.out.println(" output "+ str); } result.close(); expr.close(); conn.close(); // close the connection and free all resources..
A connection holds also default values for ZorbaXQExpression and ZorbaXQPreparedExpression properties. An application can override these defaults by passing an ZorbaXQStaticContext object to the setStaticContext() method.
Definition at line 75 of file ZorbaXQConnection.java.
|
inline |
Definition at line 97 of file ZorbaXQConnection.java.
|
inline |
|
inline |
Closes the connection.
Closes the connection. This also closes any ZorbaXQExpression and ZorbaXQPreparedExpression obtained from this connection. Once the connection is closed, no method other than close or the isClosed method may be called on the connection object. Calling close on an ZorbaXQConnection object that is already closed has no effect. Note that an XQJ driver is not required to provide finalizer methods for the connection and other objects. Hence it is strongly recommended that users call this 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.
XQException | - if there is an error during closing the connection. |
Definition at line 156 of file ZorbaXQConnection.java.
References org.zorbaxquery.api.xqj.ZorbaXQXmlDataManager.close().
|
inline |
Makes all changes made in the current transaction permanent and releases any locks held by the datasource.
This method should be used only when auto-commit mode is disabled. Any XQResultSequence, or XQResultItem may be implicitly closed upon commit, if the holdability property of the sequence is set to XQConstants.HOLDTYPE_CLOSE_CURSORS_AT_COMMIT.
XQException | - if the connection is in a closed state or this connection is operating in auto-commit mode |
Definition at line 211 of file ZorbaXQConnection.java.
|
inline |
Creates a new ZorbaXQItemType object representing an XQuery atomic type.
The item kind of the item type will be ZorbaXQItemType.XQITEMKIND_ATOMIC. Example -
basetype | - one of the ZorbaXQItemType.XQBASETYPE_* constants. All basetype constants except the following are valid: ZorbaXQItemType.XQBASETYPE_UNTYPED ZorbaXQItemType.XQBASETYPE_ANYTYPE ZorbaXQItemType.XQBASETYPE_IDREFS ZorbaXQItemType.XQBASETYPE_NMTOKENS ZorbaXQItemType.XQBASETYPE_ENTITIES ZorbaXQItemType.XQBASETYPE_ANYSIMPLETYPE |
XQException | - if (1) an invalid basetype value is passed in, or (2) the underlying object implementing the interface is closed |
Definition at line 1548 of file ZorbaXQConnection.java.
|
inline |
Creates a new ZorbaXQItemType object representing an XQuery atomic type.
The item kind of the item type will be ZorbaXQItemType.XQITEMKIND_ATOMIC. Example -
basetype | - one of the ZorbaXQItemType.XQBASETYPE_* constants. All basetype constants except the following are valid: ZorbaXQItemType.XQBASETYPE_UNTYPED ZorbaXQItemType.XQBASETYPE_ANYTYPE ZorbaXQItemType.XQBASETYPE_IDREFS ZorbaXQItemType.XQBASETYPE_NMTOKENS ZorbaXQItemType.XQBASETYPE_ENTITIES ZorbaXQItemType.XQBASETYPE_ANYSIMPLETYPE |
qname | - the QName of the type. If the QName refers to a predefinied type, it must match the basetype. Can be null |
uri | - the URI to the schema. Can be null. This can only be specified if the typename is also specified |
XQException | - if (1) an invalid basetype value is passed in, or (2) the underlying object implementing the interface is closed |
Definition at line 1579 of file ZorbaXQConnection.java.
|
inline |
Creates a new ZorbaXQItemType object representing the XQuery attribute(nodename, basetype) type with the given node name and base type.
This method can be used to create item type for attributes with a pre-defined schema type.
Example -
nodename | - specifies the name of the node.null indicates a wildcard for the node name |
basetype | - the base type of the attribute. One of the ZorbaXQItemType.XQBASETYPE_* other than ZorbaXQItemType.XQBASETYPE_UNTYPED or ZorbaXQItemType.XQBASETYPE_ANYTYPE |
XQException | - if (1) the underlying object implementing the interface is closed or (2) if the base type is one of: ZorbaXQItemType.XQBASETYPE_UNTYPED or ZorbaXQItemType.XQBASETYPE_ANYTYPE |
Definition at line 1631 of file ZorbaXQConnection.java.
|
inline |
Creates a new ZorbaXQItemType object representing the XQuery attribute(nodename, basetype) type with the given node name and base type.
The type name can reference either pre-defined simple types or user-defined simple types.
Example -
nodename | - specifies the name of the node.null indicates a wildcard for the node name |
basetype | - the base type of the attribute. One of the XQItemTyupe.XQBASETYPE_* constants other than ZorbaXQItemType.XQBASETYPE_UNTYPED or ZorbaXQItemType.XQBASETYPE_ANYTYPE |
typename | - the QName of the type. If the QName refers to a predefinied type, it must match the basetype. Can be null. |
schemaURI | - the URI to the schema. Can be null. This can only be specified if the typename is also specified |
XQException | - if (1) the underlying object implementing the interface is closed, (2) if the base type is one of: ZorbaXQItemType.XQBASETYPE_UNTYPED or ZorbaXQItemType.XQBASETYPE_ANYTYPE, (3) the schema URI is specified and the typename is not specified, (4) the implementation does not support user-defined XML schema types, or (5) if the typename refers to a predefinied type and does not match basetype |
Definition at line 1684 of file ZorbaXQConnection.java.
|
inline |
Creates a new ZorbaXQItemType object representing the XQuery comment() type.
Creates a new ZorbaXQItemType object representing the XQuery comment() type. The ZorbaXQItemType object will have the item kind set to ZorbaXQItemType.XQITEMKIND_COMMENT.
Example -
XQException | - if the underlying object implementing the interface is closed |
Definition at line 1743 of file ZorbaXQConnection.java.
|
inline |
Creates a new ZorbaXQItemType object representing the XQuery document-node(elementType) type containing a single element.
Creates a new ZorbaXQItemType object representing the XQuery document-node(elementType) type containing a single element. The ZorbaXQItemType object will have the item kind set to ZorbaXQItemType.XQITEMKIND_DOCUMENT_ELEMENT and the base type set to the item type of the input elementType.
elementType | - an ZorbaXQItemType object representing an XQuery element() type, cannot be null |
XQException | - if (1) the underlying object implementing the interface is closed or (2) the elementType has an item kind different from ZorbaXQItemType.XQITEMKIND_ELEMENT, (3) the elementType argument is null, or (4) the implementation does not support user-defined XML schema types |
Definition at line 1757 of file ZorbaXQConnection.java.
|
inline |
Creates a new ZorbaXQItemType object representing the XQuery document-node(elementType) type containing a single schema-element(...).
The ZorbaXQItemType object will have the item kind set to ZorbaXQItemType.XQITEMKIND_DOCUMENT_SCHEMA_ELEMENT and the base type set to the item type of the input elementType.
elementType | - an ZorbaXQItemType object representing an XQuery schema-element(...) type, cannot be null |
XQException | - if (1) the underlying object implementing the interface is closed or (2) the elementType has an item kind different from ZorbaXQItemType.XQITEMKIND_SCHEMA_ELEMENT, (3) the elementType argument is null, (4) the implementation does not support user-defined XML schema types |
Definition at line 1775 of file ZorbaXQConnection.java.
|
inline |
Creates a new ZorbaXQItemType object representing the XQuery document-node() type.
The ZorbaXQItemType object will have the item kind set to ZorbaXQItemType.XQITEMKIND_DOCUMENT.
XQException | - if the underlying object implementing the interface is closed |
Definition at line 1791 of file ZorbaXQConnection.java.
|
inline |
Creates a new ZorbaXQItemType object representing the XQuery element(nodename, basetype) type, with the given node name and base type.
This method can be used to create item type for elements with a pre-defined schema type.
Example -
nodename | - specifies the name of the node. null indicates a wildcard for the node name |
baseType | - the base type of the item. One of the ZorbaXQItemType.XQBASETYPE_* constants |
XQException | - if (1) the underlying object implementing the interface is closed |
Definition at line 1831 of file ZorbaXQConnection.java.
Referenced by org.zorbaxquery.api.xqj.ZorbaXQConnection.createItemFromDocument().
|
inline |
Creates a new ZorbaXQItemType object representing the XQuery element(nodename,basetype,typename,schemaURI, allowNill) type, given the node name, base type, schema type name, schema URI, and nilled check.
The type name can reference either pre-defined schema types or user-defined types.
Example -
nodename | - specifies the name of the element. null indicates a wildcard for the node name |
baseType | - the base type of the item. One of the ZorbaXQItemType.XQBASETYPE_* constants |
typename | - the QName of the type. If the QName refers to a predefinied type, it must match the basetype. Can be null |
schemaURI | - the URI to the schema. Can be null. This can only be specified if the typename is also specified |
allowNill | - the nilled property of the element |
XQException | - if (1) schemaURI is specified but the typename is not specified, (2) the underlying object implementing the interface is closed, (3) the implementation does not support user-defined XML schema types, or (4) if the typename refers to a predefinied type and does not match basetype |
Definition at line 1895 of file ZorbaXQConnection.java.
|
inline |
Creates a new ZorbaXQExpression object that can be used to perform execute immediate operations with XQuery expressions.
The properties of the connection's default ZorbaXQStaticContext are copied to the returned ZorbaXQExpression.
XQException | - if the connection is in a closed state |
Definition at line 224 of file ZorbaXQConnection.java.
|
inline |
Creates a new ZorbaXQExpression object that can be used to perform execute immediate operations with XQuery expressions.
The properties of the specified ZorbaXQStaticContext values are copied to the returned ZorbaXQExpression.
value | - ZorbaXQStaticContext containing values of expression properties |
XQException | - if (1) the connection is in a closed state, or (2) the specified argument is null |
Definition at line 245 of file ZorbaXQConnection.java.
|
inline |
Creates a copy of the specified ZorbaXQItem.
This method can be used, for example, to copy an XQResultItem object so that the new item is not dependant on the connection.
value | - the ZorbaXQItem to copy |
XQException | - if (1) the specified item is null, (2) the underlying object implementing the interface is closed, (3) the specified item is closed |
Definition at line 1478 of file ZorbaXQConnection.java.
|
inline |
Creates an item from a given value.
The value is converted into an instance of the specified type according to the casting from xs:string rules outlined in 17.1.1 Casting from xs:string and xs:untypedAtomic, XQuery 1.0 and XPath 2.0 Functions and Operators. If the cast fails an XQException is thrown.
value | - the lexical string value of the type |
type | - the item type |
XQException | - if (1) any of the arguments are null, (2) given type is not an atomic type, (3) the conversion of the value to an XDM instance failed, or (4) the underlying object implementing the interface is closed |
Definition at line 481 of file ZorbaXQConnection.java.
References org.zorbaxquery.api.xqj.ZorbaXQConnection.createItemFromString().
|
inline |
Definition at line 1225 of file ZorbaXQConnection.java.
|
inline |
Creates an item from a given value.
The value is converted into an instance of the specified type according to the rule defined in 14.2 Mapping a Java Data Type to an XQuery Data Type, XQuery API for Java (XQJ) 1.0. If the converstion fails, an XQException will be thrown.
b | - the value to be converted |
type | - the type of the value to be bound to the external variable. The default type of the value is used in case null is specified |
XQException | - (1) the conversion of the value to an XDM instance failed, or (2) the underlying object implementing the interface is closed |
Definition at line 1310 of file ZorbaXQConnection.java.
|
inline |
Creates an item from the given value.
If the value represents a well-formed XML document, it will be parsed and results in a document node. The kind of the input type must be null, XQITEMKIND_DOCUMENT_ELEMENT, or XQITEMKIND_DOCUMENT_SCHEMA_ELEMENT.
The value is converted into an instance of the specified type according to the rules defined in 14.3 Mapping a Java XML document to an XQuery document node, XQuery API for Java (XQJ) 1.0.
If the value is not well formed, or if a kind of the input type other than the values list above is specified, behavior is implementation defined and may raise an exception.
value | - the value to be converted, cannot be null |
baseURI | - an optional base URI, can be null. It can be used, for example, to resolve relative URIs and to include in error messages. |
type | - the type of the value for the created document node. If null is specified, it behaves as if XQDataFactory.createDocumentElementType( XQDataFactory.createElementType(null, ZorbaXQItemType.XQBASETYPE_XS_UNTYPED)) were passed in as the type parameter. That is, the type represents the XQuery sequence type document-node(element(*, xs:untyped)) |
XQException | - if (1) the value argument is null, (2) the conversion of the value to an XDM instance failed, or (3) the underlying object implementing the interface is closed |
Definition at line 666 of file ZorbaXQConnection.java.
References org.zorbaxquery.api.xqj.ZorbaXQConnection.createElementType().
Referenced by org.zorbaxquery.api.xqj.ZorbaXQConnection.createItemFromDocument().
|
inline |
Creates an item from the given value.
If the value represents a well-formed XML document, it will be parsed and results in a document node. The kind of the input type must be null, XQITEMKIND_DOCUMENT_ELEMENT, or XQITEMKIND_DOCUMENT_SCHEMA_ELEMENT.
The value is converted into an instance of the specified type according to the rules defined in 14.3 Mapping a Java XML document to an XQuery document node, XQuery API for Java (XQJ) 1.0.
If the value is not well formed, or if a kind of the input type other than the values list above is specified, behavior is implementation defined and may raise an exception.
value | - the value to be converted, cannot be null |
baseURI | - an optional base URI, can be null. It can be used, for example, to resolve relative URIs and to include in error messages. |
type | - the type of the value for the created document node. If null is specified, it behaves as if XQDataFactory.createDocumentElementType( XQDataFactory.createElementType(null, ZorbaXQItemType.XQBASETYPE_XS_UNTYPED)) were passed in as the type parameter. That is, the type represents the XQuery sequence type document-node(element(*, xs:untyped)) |
XQException | - if (1) the value argument is null, (2) the conversion of the value to an XDM instance failed, or (3) the underlying object implementing the interface is closed |
Definition at line 706 of file ZorbaXQConnection.java.
References org.zorbaxquery.api.xqj.ZorbaXQConnection.createElementType().
|
inline |
Creates an item from the given value.
If the value represents a well-formed XML document, it will be parsed and results in a document node. The kind of the input type must be null, XQITEMKIND_DOCUMENT_ELEMENT, or XQITEMKIND_DOCUMENT_SCHEMA_ELEMENT.
The value is converted into an instance of the specified type according to the rules defined in 14.3 Mapping a Java XML document to an XQuery document node, XQuery API for Java (XQJ) 1.0.
If the value is not well formed, or if a kind of the input type other than the values list above is specified, behavior is implementation defined and may raise an exception.
value | - the value to be converted, cannot be null |
baseURI | - an optional base URI, can be null. It can be used, for example, to resolve relative URIs and to include in error messages. |
type | - the type of the value for the created document node. If null is specified, it behaves as if XQDataFactory.createDocumentElementType( XQDataFactory.createElementType(null, ZorbaXQItemType.XQBASETYPE_XS_UNTYPED)) were passed in as the type parameter. That is, the type represents the XQuery sequence type document-node(element(*, xs:untyped)) |
XQException | - if (1) the value argument is null, (2) the conversion of the value to an XDM instance failed, or (3) the underlying object implementing the interface is closed |
Definition at line 747 of file ZorbaXQConnection.java.
References org.zorbaxquery.api.xqj.ZorbaXQConnection.createElementType().
|
inline |
Creates an item from the given value.
If the value represents a well-formed XML document, it will be parsed and results in a document node. The kind of the input type must be null, XQITEMKIND_DOCUMENT_ELEMENT, or XQITEMKIND_DOCUMENT_SCHEMA_ELEMENT.
The value is converted into an instance of the specified type according to the rules defined in 14.3 Mapping a Java XML document to an XQuery document node, XQuery API for Java (XQJ) 1.0.
If the value is not well formed, or if a kind of the input type other than the values list above is specified, behavior is implementation defined and may raise an exception.
value | - the value to be converted, cannot be null |
type | - the type of the value for the created document node. If null is specified, it behaves as if XQDataFactory.createDocumentElementType( XQDataFactory.createElementType(null, ZorbaXQItemType.XQBASETYPE_XS_UNTYPED)) were passed in as the type parameter. That is, the type represents the XQuery sequence type document-node(element(*, xs:untyped)) |
XQException | - if (1) the value argument is null, (2) the conversion of the value to an XDM instance failed, or (3) the underlying object implementing the interface is closed |
Definition at line 787 of file ZorbaXQConnection.java.
References org.zorbaxquery.api.xqj.ZorbaXQConnection.createItemFromDocument().
|
inline |
Creates an item from the given value.
An XQJ implementation must at least support the following implementations:
If the value represents a well-formed XML document, it will result in a document node. The kind of the input type must be null, XQITEMKIND_DOCUMENT_ELEMENT, or XQITEMKIND_DOCUMENT_SCHEMA_ELEMENT.
The value is converted into an instance of the specified type according to the rules defined in 14.3 Mapping a Java XML document to an XQuery document node, XQuery API for Java (XQJ) 1.0.
If the value is not well formed, or if a kind of the input type other than the values list above is specified, behavior is implementation defined and may raise an exception.
value | - the value to be converted, cannot be null |
type | - the type of the value for the created document node. If null is specified, it behaves as if XQDataFactory.createDocumentElementType( XQDataFactory.createElementType(null, ZorbaXQItemType.XQBASETYPE_XS_UNTYPED)) were passed in as the type parameter. That is, the type represents the XQuery sequence type document-node(element(*, xs:untyped)) |
XQException | - if (1) the value argument is null, (2) the conversion of the value to an XDM instance failed, or (3) the underlying object implementing the interface is closed |
Definition at line 840 of file ZorbaXQConnection.java.
References org.zorbaxquery.api.xqj.ZorbaXQConnection.createItemFromDocument().
|
inline |
Creates an item from a given value.
The value is converted into an instance of the specified type according to the rule defined in 14.2 Mapping a Java Data Type to an XQuery Data Type, XQuery API for Java (XQJ) 1.0. If the converstion fails, an XQException will be thrown.
value | - the value to be converted |
type | - the type of the value to be bound to the external variable. The default type of the value is used in case null is specified |
XQException | - (1) the conversion of the value to an XDM instance failed, or (2) the underlying object implementing the interface is closed |
Definition at line 1328 of file ZorbaXQConnection.java.
|
inline |
Creates an item from a given value.
The value is converted into an instance of the specified type according to the rule defined in 14.2 Mapping a Java Data Type to an XQuery Data Type, XQuery API for Java (XQJ) 1.0. If the converstion fails, an XQException will be thrown.
value | - the value to be converted |
type | - the type of the value to be bound to the external variable. The default type of the value is used in case null is specified |
XQException | - (1) the conversion of the value to an XDM instance failed, or (2) the underlying object implementing the interface is closed |
Definition at line 1356 of file ZorbaXQConnection.java.
|
inline |
Creates an item from a given value.
The value is converted into an instance of the specified type according to the rule defined in 14.2 Mapping a Java Data Type to an XQuery Data Type, XQuery API for Java (XQJ) 1.0. If the converstion fails, an XQException will be thrown.
value | - the value to be converted |
type | - the type of the value to be bound to the external variable. The default type of the value is used in case null is specified |
XQException | - (1) the conversion of the value to an XDM instance failed, or (2) the underlying object implementing the interface is closed |
Definition at line 1384 of file ZorbaXQConnection.java.
|
inline |
Creates an item from a given value.
The value is converted into an instance of the specified type according to the rule defined in 14.2 Mapping a Java Data Type to an XQuery Data Type, XQuery API for Java (XQJ) 1.0. If the converstion fails, an XQException will be thrown.
value | - the value to be converted |
type | - the type of the value to be bound to the external variable. The default type of the value is used in case null is specified |
XQException | - (1) the conversion of the value to an XDM instance failed, or (2) the underlying object implementing the interface is closed |
Definition at line 1409 of file ZorbaXQConnection.java.
|
inline |
Creates an item from a given value.
The value is converted into an instance of the specified type according to the rule defined in 14.2 Mapping a Java Data Type to an XQuery Data Type, XQuery API for Java (XQJ) 1.0. If the converstion fails, an XQException will be thrown.
value | - the value to be converted |
type | - the type of the value to be bound to the external variable. The default type of the value is used in case null is specified |
XQException | - (1) the conversion of the value to an XDM instance failed, or (2) the underlying object implementing the interface is closed |
Definition at line 1435 of file ZorbaXQConnection.java.
References org.zorbaxquery.api.xqj.ZorbaXQConnection.createItemFromString().
|
inline |
Creates an item from a given value.
The value is converted into an instance of the specified type according to the rule defined in 14.2 Mapping a Java Data Type to an XQuery Data Type, XQuery API for Java (XQJ) 1.0. If the converstion fails, an XQException will be thrown.
value | - the value to be converted |
type | - the type of the value to be bound to the external variable. The default type of the value is used in case null is specified |
XQException | - (1) the conversion of the value to an XDM instance failed, or (2) the underlying object implementing the interface is closed |
Definition at line 867 of file ZorbaXQConnection.java.
|
inline |
Creates an item from a given value.
The value is converted into an instance of the specified type according to the rule defined in 14.2 Mapping a Java Data Type to an XQuery Data Type, XQuery API for Java (XQJ) 1.0. If the converstion fails, an XQException will be thrown.
value | - the value to be converted |
type | - the type of the value to be bound to the external variable. The default type of the value is used in case null is specified |
XQException | - (1) the conversion of the value to an XDM instance failed, or (2) the underlying object implementing the interface is closed |
Definition at line 1458 of file ZorbaXQConnection.java.
|
inline |
Creates an item from a given value.
The value is converted into an instance of the specified type, which must represent an xs:string or a type derived by restriction from xs:string. If the specified type is null, it defaults to xs:string. Subsequently the value is converted into an instance of the specified type according to the rule defined in 14.2 Mapping a Java Data Type to an XQuery Data Type, XQuery API for Java (XQJ) 1.0. If the conversion fails, an XQException will be thrown.
value | - the value to be converted, cannot be null |
type | - the type of the value to be bound to the external variable. The default type, xs:string, is used in case null is specified |
XQException | - if (1) the value argument is null, (2) the conversion of the value to an XDM instance failed, or (3) the underlying object implementing the interface is closed |
Definition at line 508 of file ZorbaXQConnection.java.
Referenced by org.zorbaxquery.api.xqj.ZorbaXQConnection.createItemFromAtomicValue(), and org.zorbaxquery.api.xqj.ZorbaXQConnection.createItemFromNode().
|
inline |
Creates a new ZorbaXQItemType object representing the XQuery item type.
The ZorbaXQItemType object will have the item kind set to ZorbaXQItemType.XQITEMKIND_ITEM.
Example -
XQException | - if the underlying object implementing the interface is closed |
Definition at line 1939 of file ZorbaXQConnection.java.
|
inline |
Creates a new ZorbaXQItemType object representing the XQuery node() type.
The ZorbaXQItemType object will have the item kind set to ZorbaXQItemType.XQITEMKIND_NODE.
XQException | - if the underlying object implementing the interface is closed |
Definition at line 1953 of file ZorbaXQConnection.java.
|
inline |
Creates a new ZorbaXQItemType object representing the XQuery processing-instruction(piTarget) type.
The ZorbaXQItemType object will have the item kind set to ZorbaXQItemType.XQITEMKIND_PI. A string literal can be passed to match the PITarget of the processing instruction as described in 2.5.4.2 Matching an Item Type and an Item, XQuery 1.0: An XML Query Language.
Example -
piTarget | - the string literal to match the processing instruction's PITarget. A null string value will match all processing instruction nodes |
XQException | - if the underlying object implementing the interface is closed |
Definition at line 1989 of file ZorbaXQConnection.java.
|
inline |
Creates a new ZorbaXQItemType object representing the XQuery schema-attribute(nodename,basetype,schemaURI) type, with the given node name, base type, and schema URI.
Example -
nodename | - specifies the name of the node |
basetype | - the base type of the attribute. One of the XQItemTyupe.XQBASETYPE_* constants other than ZorbaXQItemType.XQBASETYPE_UNTYPED or ZorbaXQItemType.XQBASETYPE_ANYTYPE |
uri | - the URI to the schema. Can be null |
XQException | - if (1) the node name is null, (2) if the base type is one of: ZorbaXQItemType.XQBASETYPE_UNTYPED or ZorbaXQItemType.XQBASETYPE_ANYTYPE, (3) the underlying object implementing the interface is closed, or (4) the implementation does not support user-defined XML schema types |
Definition at line 1716 of file ZorbaXQConnection.java.
|
inline |
Creates a new ZorbaXQItemType object representing the XQuery schema-element(nodename,basetype,schemaURI) type, given the node name, base type, and the schema URI.
Example -
nodename | - specifies the name of the element |
baseType | - the base type of the item. One of the ZorbaXQItemType.XQBASETYPE_* constants |
schemaURI | - the URI to the schema. Can be null |
XQException | - if (1) the node name is null, (2) the underlying object implementing the interface is closed, or (3) the implementation does not support user-defined XML schema types |
Definition at line 1920 of file ZorbaXQConnection.java.
|
inline |
Creates a copy of the specified ZorbaXQSequence.
Creates a copy of the specified ZorbaXQSequence. The newly created ZorbaXQSequence is scrollable and independent of any underlying ZorbaXQConnection. The new ZorbaXQSequence will contain all items from the specified ZorbaXQSequence starting from its current position. The copy process will implicitly perform next operations on the specified sequence to read the items. All items are consumed, the current position of the cursor is set to point after the last item.
value | - input sequence |
XQException | - if (1) there are errors accessing the items in the specified sequence, (2) the specified sequence is closed, (3) in the case of a forward only sequence, a get or write method has already been invoked on the current item, (4) the s parameter is null, or (5) the underlying object implementing the interface is closed |
Definition at line 1497 of file ZorbaXQConnection.java.
|
inline |
Creates an ZorbaXQSequence, containing all the items from the iterator.
The newly created ZorbaXQSequence is scrollable and independent of any underlying ZorbaXQConnection. If the iterator returns an ZorbaXQItem, it is added to the sequence. If the iterator returns any other object, an item is added to the sequence following the rules from 14.2 Mapping a Java Data Type to an XQuery Data Type, XQuery API for Java (XQJ) 1.0. If the iterator does not return any items, then an empty sequence is created.
value | - input sequence |
XQException | - if (1) there are errors accessing the items in the specified sequence, (2) the specified sequence is closed, (3) in the case of a forward only sequence, a get or write method has already been invoked on the current item, (4) the s parameter is null, or (5) the underlying object implementing the interface is closed |
Definition at line 1521 of file ZorbaXQConnection.java.
|
inline |
Creates a new sequence type from an item type and occurence indicator.
item | - the item type. This parameter must be null if the occurance is ZorbaXQSequenceType.OCC_EMPTY, and cannot be null for any other occurance indicator |
occurence | - The occurence of the item type, must be one of ZorbaXQSequenceType.OCC_ZERO_OR_ONE, ZorbaXQSequenceType.OCC_EXACTLY_ONE, ZorbaXQSequenceType.OCC_ZERO_OR_MORE, ZorbaXQSequenceType.OCC_ONE_OR_MORE, ZorbaXQSequenceType.OCC_EMPTY |
XQException | - if (1) the item is null and the occurance is not ZorbaXQSequenceType.OCC_EMPTY, (2) the item is not null and the occurance is ZorbaXQSequenceType.OCC_EMPTY, (3) the occurence is not one of: ZorbaXQSequenceType.OCC_ZERO_OR_ONE, ZorbaXQSequenceType.OCC_EXACTLY_ONE, ZorbaXQSequenceType.OCC_ZERO_OR_MORE, ZorbaXQSequenceType.OCC_ONE_OR_MORE, ZorbaXQSequenceType.OCC_EMPTY or (4) the underlying object implementing the interface is closed |
Definition at line 2003 of file ZorbaXQConnection.java.
|
inline |
Creates a new ZorbaXQItemType object representing the XQuery text() type.
The ZorbaXQItemType object will have the item kind set to ZorbaXQItemType.XQITEMKIND_TEXT.
XQException | - if the underlying object implementing the interface is closed |
Definition at line 2028 of file ZorbaXQConnection.java.
|
inline |
Gets the auto-commit attribute of this connection.
XQException | - if the connection is in a closed state |
Definition at line 199 of file ZorbaXQConnection.java.
|
inline |
Gets the metadata for this connection.
XQException | - if the connection is in a closed state |
Definition at line 259 of file ZorbaXQConnection.java.
|
inline |
Gets an ZorbaXQStaticContext representing the default values for all expression properties.
In order to modify the defaults, it is not sufficient to modify the values in the returned ZorbaXQStaticContext object; in addition setStaticContext should be called to make those new values effective.
XQException | - if the connection is in a closed state |
Definition at line 439 of file ZorbaXQConnection.java.
|
inline |
Definition at line 180 of file ZorbaXQConnection.java.
|
inlineprotected |
Definition at line 90 of file ZorbaXQConnection.java.
|
inline |
Checks if the connection is closed.
Definition at line 269 of file ZorbaXQConnection.java.
|
inline |
Prepares an expression for execution.
The properties of the connection's default ZorbaXQStaticContext are copied to the returned ZorbaXQPreparedExpression.
value | - the XQuery expression as a String. Cannot be null |
XQException | - if (1) the connection is in a closed state, (2) there are errors preparing the expression, or (3) the xquery parameter is null |
Definition at line 282 of file ZorbaXQConnection.java.
|
inline |
Prepares an expression for execution.
The properties of the connection's default ZorbaXQStaticContext are copied to the returned ZorbaXQPreparedExpression.
string | - the XQuery expression as a String. Cannot be null |
xqsc | - ZorbaXQStaticContext containing values of expression properties. |
XQException | - if (1) the connection is in a closed state, (2) there are errors preparing the expression, or (3) the xquery parameter is null |
Definition at line 309 of file ZorbaXQConnection.java.
|
inline |
Prepares an expression for execution.
The properties of the connection's default ZorbaXQStaticContext are copied to the returned ZorbaXQPreparedExpression.
reader | - the XQuery expression as a Reader. Cannot be null |
XQException | - if (1) the connection is in a closed state, (2) there are errors preparing the expression, or (3) the xquery parameter is null |
Definition at line 332 of file ZorbaXQConnection.java.
|
inline |
Prepares an expression for execution.
The properties of the connection's default ZorbaXQStaticContext are copied to the returned ZorbaXQPreparedExpression.
reader | - the XQuery expression as a Reader. Cannot be null |
xqsc | - ZorbaXQStaticContext containing values of expression properties |
XQException | - if (1) the connection is in a closed state, (2) there are errors preparing the expression, or (3) the xquery parameter is null |
Definition at line 356 of file ZorbaXQConnection.java.
|
inline |
Prepares an expression for execution.
The properties of the connection's default ZorbaXQStaticContext are copied to the returned ZorbaXQPreparedExpression.
in | - the XQuery expression as an InputStream. Cannot be null |
XQException | - if (1) the connection is in a closed state, (2) there are errors preparing the expression, or (3) the xquery parameter is null |
Definition at line 376 of file ZorbaXQConnection.java.
|
inline |
Prepares an expression for execution.
The properties of the connection's default ZorbaXQStaticContext are copied to the returned ZorbaXQPreparedExpression.
in | - the XQuery expression as an InputStream. Cannot be null |
xqsc | - ZorbaXQStaticContext containing values of expression properties |
XQException | - if (1) the connection is in a closed state, (2) there are errors preparing the expression, or (3) the xquery parameter is null |
Definition at line 405 of file ZorbaXQConnection.java.
|
inline |
Undoes all changes made in the current transaction and releases any locks held by the datasource.
This method should be used only when auto-commit mode is disabled.
XQException | - if the connection is in a closed state or this connection is operating in auto-commit mode |
Definition at line 427 of file ZorbaXQConnection.java.
|
inline |
Definition at line 188 of file ZorbaXQConnection.java.
|
inline |
Sets the default values for all expression properties.
The implementation will read out all expression properties from the specified ZorbaXQStaticContext and update its private copy.
xqsc | - ZorbaXQStaticContext containing values of expression properties |
XQException | - if the connection is in a closed state |
Definition at line 462 of file ZorbaXQConnection.java.