com.xqj2
Interface XQConnection2

All Superinterfaces:
XQConnection, XQDataFactory

public interface XQConnection2
extends XQConnection


Method Summary
<T> T
createModuleProxy(String namespaceUri, String moduleUri, Class<T> clazz)
          Creates a Module Proxy, a Java Facade of an XQuery Library Module.
<T> T
createModuleProxy(String namespaceUri, String moduleUri, Class<T> clazz, XQStaticContext properties)
          Creates a Module Proxy, a Java Facade of an XQuery Library Module.
 void insertItem(String uri, XQItem item, XQInsertOptions options)
          Inserts an item into the XML DataSource with a given URI.
 
Methods inherited from interface javax.xml.xquery.XQConnection
close, commit, createExpression, createExpression, getAutoCommit, getMetaData, getStaticContext, isClosed, prepareExpression, prepareExpression, prepareExpression, prepareExpression, prepareExpression, prepareExpression, rollback, setAutoCommit, setStaticContext
 
Methods inherited from interface javax.xml.xquery.XQDataFactory
createAtomicType, createAtomicType, createAttributeType, createAttributeType, createCommentType, createDocumentElementType, createDocumentSchemaElementType, createDocumentType, createElementType, createElementType, createItem, createItemFromAtomicValue, createItemFromBoolean, createItemFromByte, createItemFromDocument, createItemFromDocument, createItemFromDocument, createItemFromDocument, createItemFromDocument, createItemFromDouble, createItemFromFloat, createItemFromInt, createItemFromLong, createItemFromNode, createItemFromObject, createItemFromShort, createItemFromString, createItemType, createNodeType, createProcessingInstructionType, createSchemaAttributeType, createSchemaElementType, createSequence, createSequence, createSequenceType, createTextType
 

Method Detail

createModuleProxy

<T> T createModuleProxy(String namespaceUri,
                        String moduleUri,
                        Class<T> clazz)
                    throws XQException
Creates a Module Proxy, a Java Facade of an XQuery Library Module. Invoking methods on the returned instance will manifest in the implementation calling XQuery functions contained within the specified XQuery Library Module. Java method parameters are mapped to XQuery function parameters according to the mapping rules outlined in the XQJ2 specification. The XDM result of calling the XQuery function will be mapped into the Java interface's expected return type for that method, if possible.

Parameters:
namespaceUri - the Namespace URI of the XQuery Library Module, required parameter.
moduleUri - the URI of the XQuery Library Module, null is permitted.
clazz - a regular Java interface class, acting as the Facade for the XQuery Library Module.
Returns:
an instance of the interface class supplied in the clazz parameter.
Throws:
XQException

createModuleProxy

<T> T createModuleProxy(String namespaceUri,
                        String moduleUri,
                        Class<T> clazz,
                        XQStaticContext properties)
                    throws XQException
Creates a Module Proxy, a Java Facade of an XQuery Library Module. Invoking methods on the returned instance will manifest in the implementation calling XQuery functions contained within the specified XQuery Library Module. Java method parameters are mapped to XQuery function parameters according to the mapping rules outlined in the XQJ2 specification. The XDM result of calling the XQuery function will be mapped into the Java interface's expected return type for that method, if possible.

Parameters:
namespaceUri - the Namespace URI of the XQuery Library Module, required parameter.
moduleUri - the URI of the XQuery Library Module, null is permitted.
clazz - a regular Java interface class, acting as the Facade for the XQuery Library Module.
properties - the static context properties, which the XQuery Module Proxy should run against.
Returns:
an instance of the interface class supplied in the clazz parameter.
Throws:
XQException

insertItem

void insertItem(String uri,
                XQItem item,
                XQInsertOptions options)
                throws XQException
Inserts an item into the XML DataSource with a given URI. The item must be a document node. This method pays respect to the state of the auto-commit attribute. If auto-commit is set to false, an item or items will only be committed once the commit method has been invoked.

Parameters:
uri - The absolute URI of the item. Can not be null.
item - The item to insert. It must be a document node. Can not be null.
options - Hints to the implementation of how to ingest the item. Can be null.
Throws:
XQException - if (1) the specified uri or item is null, (2) the item is not a document node, (3) the underlying object implementing the interface is closed, (4) the specified item is closed, or (5) an implementation issue occurred whilst inserting the item.