OXQConnection

All Superinterfaces:: OXQDataFactory

public interface OXQConnection
extends OXQDataFactory

Extensions to javax.xml.xquery.XQConnection.

Use method OXQView.getConnection(XQConnection) to access these extensions. For example:

 OXQDataSource ds = new OXQDataSource();
 XQConnection con = ds.getConnection();
 OXQConnection ocon = OXQView.getConnection(con);
 ...

Since:: 12.1

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`SCOPE_CONNECTION` Identifies components associated with the connection instance
`static int`	`SCOPE_EXPRESSION` Identifies components associated with the expression instance

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`XQItem`	`convertXQueryToXQueryX(OXQEntity query)` Converts XQuery to XQueryX.
`void`	`convertXQueryXToXQuery(OXQEntity query, java.io.OutputStream out, java.lang.String outEncoding)` Converts XQueryX to XQuery.
`XQPreparedExpression`	`copyExpression(XQPreparedExpression prepExpr)` Returns a copy of an `XQPreparedExpression` instance.
`OXQAnnotation`	`createAnnotation(javax.xml.namespace.QName name, XQSequence value)` Creates an annotation.
`<T extends OXQEntityResolverFactory> T`	`createEntityResolverFactory(java.lang.Class<T> factoryType)` Returns a factory for creating instances of OXQEntityResolver.
`OXQOptions`	`createOptions()` Creates an empty instance of `OXQOptions`.
`OXQSerializationParameters`	`createSerializationParameters()` Creates an instance of `OXQSerializationParameters`.
`OXQEntityLoader`	`getEntityLoader(int scope)` Returns an OXQEntityLoader instance that controls the schema/module loading process.
`OXQEntityResolver`	`getEntityResolver()` Gets the entity resolver.
`XQStaticContext`	`getModuleStaticContext()` Gets an `XQStaticContext` instance representing the default values for all properties of library modules loaded by this connection.
`XQConnection`	`getXQView()` Returns the `XQConnection` instance corresponding to this instance.
`XQPreparedExpression`	`prepareExpression(OXQEntity xquery)` Prepares an expression for execution.
`XQPreparedExpression`	`prepareExpression(OXQEntity xquery, XQStaticContext properties)` Prepares an expression for execution.
`void`	`setEntityResolver(OXQEntityResolver entityResolver)` Assigns a new entity resolver to the connection, replacing the existing one.
`void`	`setModuleStaticContext(XQStaticContext properties)` Sets the default values for all properties of library modules loaded by this connection.

Methods inherited from interface oracle.xml.xquery.OXQDataFactory
createItemFromBigDecimal, createItemFromBigInteger, createItemFromBinary, createItemFromCalendar, createItemFromDocument, createItemFromDuration, createItemFromQName, createSequence, createSequenceFromDocument, createSequenceFromDocument, createSequenceFromDocument, createSequenceFromDocument, createSequenceTypeFromJavaType

- Field Detail
  - SCOPE_CONNECTION
```
static final int SCOPE_CONNECTION
```
    Identifies components associated with the connection instance
    
    See Also:
    
    getEntityLoader(int), Constant Field Values
  - SCOPE_EXPRESSION
```
static final int SCOPE_EXPRESSION
```
    Identifies components associated with the expression instance
    
    See Also:
    
    getEntityLoader(int), Constant Field Values
- Method Detail
  - getXQView
```
XQConnection getXQView()
```
    Returns the XQConnection instance corresponding to this instance.
    
    Specified by:
    
    getXQView in interface OXQDataFactory
    
    Returns:
    
    the connection
  - prepareExpression
```
XQPreparedExpression prepareExpression(OXQEntity xquery)
                                throws XQException
```
    Prepares an expression for execution.
    The properties of the connection's default XQStaticContext instance are copied to the returned expression.
    
    Parameters:
    
    xquery - the XQuery expression as an OXQEntity. The permitted entity data is the same as what is permitted for MODULE entities except that collections are not allowed. Cannot be null.
    
    Returns:
    
    the prepared XQuery expression
    
    Throws:
    
    XQException - if (1) the connection is in a closed state, (2) there are errors preparing the expression, or (3) the xquery parameter is null
  - prepareExpression
```
XQPreparedExpression prepareExpression(OXQEntity xquery,
                                       XQStaticContext properties)
                                throws XQException
```
    Prepares an expression for execution.
    The properties of the specified XQStaticContext instance are copied to the returned expression.
    
    Parameters:
    
    xquery - the XQuery expression as an OXQEntity. The permitted entity data is the same as what is permitted for MODULE entities except that collections are not allowed. Cannot be null.
    
    properties - XQStaticContext containing values of expression properties.
    
    Returns:
    
    the prepared XQuery expression
    
    Throws:
    
    XQException - if (1) the connection is in a closed state, or (2) the specified argument is null
  - copyExpression
```
XQPreparedExpression copyExpression(XQPreparedExpression prepExpr)
                             throws XQException
```
    Returns a copy of an XQPreparedExpression instance. Users can create an initial prepared expression using the XQConnection interface, and then make multiple copies using this method. The copying is done without plan recompilation, and each copy can then be executed concurrently in a separate thread. The copies do not support all the methods of OXQPreparedExpression. The copies are primarily intended for binding variables and execution.
    
    Parameters:
    
    prepExpr - The input prepared expression
    
    Returns:
    
    a new copy of the input prepared expression
    
    Throws:
    
    XQException - if (1) the input prepared expression is closed, (2) the input prepared expression has already been executed or has bound variables (3) the input prepared expression was generated by some other XQJ implementation (4) the input prepared expression was created with a different connection (5) the input prepared expression cannot be copied or (6) there was an internal engine error while copying the input prepared expression
  - getModuleStaticContext
```
XQStaticContext getModuleStaticContext()
                                throws XQException
```
    Gets an XQStaticContext instance representing the default values for all properties of library modules loaded by this connection. In order to modify the defaults, it is not sufficient to modify the values in the returned XQStaticContext instance; in addition method setModuleStaticContext(XQStaticContext) should be called to make the new values effective.
    
    Returns:
    
    a XQStaticContext instance representing the default values for all properties of library modules
    
    Throws:
    
    XQException - if the connection is in a closed state
  - setModuleStaticContext
```
void setModuleStaticContext(XQStaticContext properties)
                     throws XQException
```
    Sets the default values for all properties of library modules loaded by this connection. The implementation will read out all properties from the specified XQStaticContext instance and update its private copy. The OXQEntityResolver implementation can override these defaults by providing OXQStaticContext instance along with the returned library module content. See OXQEntity.PROPERTY_MODULE_STATIC_CONTEXT for more information.
    
    Parameters:
    
    properties - a XQStaticContext instance containing values of library module properties
    
    Throws:
    
    XQException - if the connection is in a closed state
  - createEntityResolverFactory
```
<T extends OXQEntityResolverFactory> T createEntityResolverFactory(java.lang.Class<T> factoryType)
                                                            throws XQException
```
    Returns a factory for creating instances of OXQEntityResolver.
    
    Parameters:
    
    factoryType - The OXQEntityResolverFactory implementation class to construct
    
    Returns:
    
    factory object
    
    Throws:
    
    XQException - if (1) the connection is in a closed state, (2) factory cannot be create for given factoryType
    
    See Also:
    
    OXQEntityResolverFactory
  - setEntityResolver
```
void setEntityResolver(OXQEntityResolver entityResolver)
                throws XQException
```
    Assigns a new entity resolver to the connection, replacing the existing one.
    
    Parameters:
    
    entityResolver - the entity resolver
    
    Throws:
    
    XQException - if the connection is in a closed state
  - getEntityResolver
```
OXQEntityResolver getEntityResolver()
                             throws XQException
```
    Gets the entity resolver.
    
    Returns:
    
    the entity resolver
    
    Throws:
    
    XQException - if the connection is in a closed state
  - getEntityLoader
```
OXQEntityLoader getEntityLoader(int scope)
                         throws XQException
```
    Returns an OXQEntityLoader instance that controls the schema/module loading process.
    The following entity loader instances are provided by each XQConnection:
    1. Connection-scoped - always available
    2. Expression-scoped - only available in OXQDataSource.IMPORT_SHARING mode
    See OXQEntityLoader documentation for more information.
    Parameters:
    
    scope - SCOPE_CONNECTION or SCOPE_EXPRESSION
    
    Returns:
    
    the entity loader
    
    Throws:
    
    XQException - if the connection is in a closed state
  - convertXQueryToXQueryX
```
XQItem convertXQueryToXQueryX(OXQEntity query)
                       throws XQException
```
    Converts XQuery to XQueryX.
    
    Parameters:
    
    query - an OXQEntity instance representing the query
    
    Returns:
    
    the XQueryX as an XQItem instance.
    
    Throws:
    
    XQException - if (1) the connection is closed, (2) a java IO exception was thrown while reading the query (attached as cause), or (3) the conversion failed
    
    See Also:
    
    OXQEntity.MEDIA_TYPE_XQUERY, OXQEntityKind.MODULE
  - convertXQueryXToXQuery
```
void convertXQueryXToXQuery(OXQEntity query,
                            java.io.OutputStream out,
                            java.lang.String outEncoding)
                     throws XQException
```
    Converts XQueryX to XQuery.
    
    Parameters:
    
    query - an OXQEntity instance representing the query in XQueryX
    
    out - the output stream to which the resulting XQuery is written
    
    outEncoding - a query encoding (UTF-8 if null)
    
    Throws:
    
    XQException - if (1) the connection is closed, (2) a java IO exception was thrown while reading the query (attached as cause), or (3) the conversion failed
    
    See Also:
    
    OXQEntity.MEDIA_TYPE_XQUERYX, OXQEntityKind.MODULE
  - createSerializationParameters
```
OXQSerializationParameters createSerializationParameters()
                                                  throws XQException
```
    Creates an instance of OXQSerializationParameters.
    
    Returns:
    
    the serialization parameters
    
    Throws:
    
    XQException - if the connection is in a closed state
  - createOptions
```
OXQOptions createOptions()
                  throws XQException
```
    Creates an empty instance of OXQOptions.
    
    Returns:
    
    the options
    
    Throws:
    
    XQException - if the connection is in a closed state
  - createAnnotation
```
OXQAnnotation createAnnotation(javax.xml.namespace.QName name,
                               XQSequence value)
                        throws XQException
```
    Creates an annotation.
    
    Parameters:
    
    name - the annotation name. Cannot be null
    
    value - the annotation value. Passing null will set the value to the empty sequence
    
    Returns:
    
    the annotation
    
    Throws:
    
    XQException - if (1) the connection is closed, (2) the name parameter is null, or (3) consuming the value sequence raises an error
    
    See Also:
    
    OXQStaticContext.declareFunction(QName, javax.xml.xquery.XQSequenceType[], javax.xml.xquery.XQSequenceType, OXQOptions, OXQAnnotation[])

Interface OXQConnection

Field Summary

Method Summary

Methods inherited from interface oracle.xml.xquery.OXQDataFactory

Field Detail

SCOPE_CONNECTION

SCOPE_EXPRESSION

Method Detail

getXQView

prepareExpression

prepareExpression

copyExpression

getModuleStaticContext

setModuleStaticContext

createEntityResolverFactory

setEntityResolver

getEntityResolver

getEntityLoader

convertXQueryToXQueryX

convertXQueryXToXQuery

createSerializationParameters

createOptions

createAnnotation