OXQStaticContext

public interface OXQStaticContext

Extensions to javax.xml.xquery.XQStaticContext.

Use method OXQView.getStaticContext(XQStaticContext) to access these extensions. For example:

 OXQDataSource ds = new OXQDataSource();
 XQConnection con = ds.getConnection();
 XQStaticContext ctx = con.getStaticContext();
 OXQStaticContext octx = OXQView.getStaticContext(ctx);
 ...

Since:: 12.1
See Also:: XQStaticContext

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`declareFunction(javax.xml.namespace.QName name, XQSequenceType[] parameterTypes, XQSequenceType returnType, OXQOptions options)` Declares an external function.
`void`	`declareFunction(javax.xml.namespace.QName name, XQSequenceType[] parameterTypes, XQSequenceType returnType, OXQOptions options, OXQAnnotation[] annotations)` Declares an external function.
`void`	`declareImport(OXQEntityKind entityKind, java.lang.String namespace, java.lang.String... locations)` Declares that a schema or module should be imported.
`void`	`declareVariable(javax.xml.namespace.QName name, XQSequenceType type)` Declares an external variable.
`int`	`getBindingTypeCheckMode()` Gets the type checking mode for external variable bindings.
`OXQEntityResolver`	`getEntityResolver()` Gets the `OXQEntityResolver` instance to be used during query processing.
`OXQFunctionMetaData[]`	`getFunctions()` Gets the definitions of all external functions declared in this context.
`java.lang.String[]`	`getImportLocations(OXQEntityKind entityKind, java.lang.String namespace)` Gets the locations of a schema or module import.
`java.lang.String[]`	`getImportNamespaces(OXQEntityKind entityKind)` Gets the target namespaces of all schema or module imports currently declared.
`java.lang.String`	`getModuleURI()` Gets the module URI, if set in the static context, else the empty string.
`int`	`getProcessingMode()` Gets the processing mode.
`OXQSerializationParameters`	`getSerializationParameters()` Gets an `OXQSerializationParameters` instance representing the the values for all serialization parameters.
`javax.xml.namespace.QName[]`	`getVariableNames()` Gets the names of all external variables declared in this context.
`XQSequenceType`	`getVariableType(javax.xml.namespace.QName name)` Gets the type of an external variable declared in this context.
`XQStaticContext`	`getXQView()` Returns the `XQStaticContext` instance corresponding to this instance.
`void`	`setBindingTypeCheckMode(int mode)` Sets the type checking mode for external variable bindings.
`void`	`setEntityResolver(OXQEntityResolver resolver)` Sets an `OXQEntityResolver` instance to be used during query processing.
`void`	`setModuleURI(java.lang.String moduleUri)` Sets the module URI in the static context.
`void`	`setProcessingMode(int mode)` Sets the processing mode.
`void`	`setSerializationParameters(OXQSerializationParameters params)` Sets the serialization parameters for this static context.
`void`	`undeclareFunction(javax.xml.namespace.QName name, int parameterCount)` Undeclares a previously declared external function.
`void`	`undeclareVariable(javax.xml.namespace.QName name)` Undeclares a previously declared external variable.

- Method Detail
  - getXQView
```
XQStaticContext getXQView()
```
    Returns the XQStaticContext instance corresponding to this instance.
    
    Returns:
    
    the static context
  - getBindingTypeCheckMode
```
int getBindingTypeCheckMode()
```
    Gets the type checking mode for external variable bindings.
    
    Returns:
    
    the type checking mode, either OXQConstants.BINDING_TYPE_CHECK_MODE_PRIME or OXQConstants.BINDING_TYPE_CHECK_MODE_FULL
  - setBindingTypeCheckMode
```
void setBindingTypeCheckMode(int mode)
                      throws XQException
```
    Sets the type checking mode for external variable bindings. When set to OXQConstants.BINDING_TYPE_CHECK_MODE_PRIME, the XQuery processor assumes that the number of items bound to an external variable matches the type quantifier specified in the variable declaration and does not attempt to verify this assumption. By default, the processor will verify the type quantifier which can block streaming evaluation in some cases.
    
    For example, consider the following query:
    declare variable $arg as element(); $arg[1]
    
    Consider what happens if we bind (<a/>, <b/>) to this variable (a sequence of two elements). The binding mode is BINDING_TYPE_CHECK_MODE_FULL, this will result in a runtime error because "as element()" indicates there should be exactly 1 element bound to the variable. On the other hand, the binding mode is BINDING_TYPE_CHECK_MODE_PRIME, the XQuery processor will only ensure that the binding is an element but will not attempt to verify that there is exactly one element. The default value is OXQConstants.BINDING_TYPE_CHECK_MODE_FULL.
    
    Note, the relaxed type checking behavior used in mode BINDING_TYPE_CHECK_MODE_PRIME does not conform to the XQuery 1.0 standard.
    
    Parameters:
    
    mode - the type checking mode. Must be either OXQConstants.BINDING_TYPE_CHECK_MODE_PRIME or OXQConstants.BINDING_TYPE_CHECK_MODE_FULL
    
    Throws:
    
    XQException - the specified mode is different from OXQConstants.BINDING_TYPE_CHECK_MODE_PRIME or OXQConstants.BINDING_TYPE_CHECK_MODE_FULL
    
    See Also:
    
    getBindingTypeCheckMode()
  - getProcessingMode
```
int getProcessingMode()
```
    Gets the processing mode. In some cases, it may be useful to validate and analyze a query without any need to execute it. In such cases, the processing mode can be set to OXQConstants.PROCESSING_STATIC_ANALYSIS_ONLY to disable query optimization and plan generation. When in this mode, queries may not be executed. When the processing mode is OXQConstants.PROCESSING_FULL, queries may be prepared and executed. The default value is OXQConstants.PROCESSING_FULL.
    
    Returns:
    
    the processing mode. Must be either OXQConstants.PROCESSING_STATIC_ANALYSIS_ONLY or OXQConstants.PROCESSING_FULL
  - setProcessingMode
```
void setProcessingMode(int mode)
                throws XQException
```
    Sets the processing mode.
    
    Parameters:
    
    mode - the processing mode. Must be either OXQConstants.PROCESSING_STATIC_ANALYSIS_ONLY or OXQConstants.PROCESSING_FULL
    
    Throws:
    
    XQException - the specified mode is different from OXQConstants.PROCESSING_STATIC_ANALYSIS_ONLY or OXQConstants.PROCESSING_FULL
    
    See Also:
    
    getProcessingMode()
  - getModuleURI
```
java.lang.String getModuleURI()
```
    Gets the module URI, if set in the static context, else the empty string.
    
    Returns:
    
    the module URI, if set, else the empty string. Cannot be null
    
    See Also:
    
    setModuleURI(String)
  - setModuleURI
```
void setModuleURI(java.lang.String moduleUri)
           throws XQException
```
    Sets the module URI in the static context. If moduleUri is the empty string then the module URI setting will be cleared. The module URI will be used in error messages related to the main module. For example, by default a type error message in the main module might look something like the following:
    line 10, column 11: XPTY0004: Invalid static type ...
    If the module URI is set to "file:/myquery.xq", the error message would instead look something like:
    file:/myquery.xq, line 10, column 11: XPTY0004: Invalid static type ...
    
    Parameters:
    
    moduleUri - the new moduleUri, or the empty string to make it undefined. Cannot be null
    
    Throws:
    
    XQException - if a null module uri is specified, or given uri is not absolute
  - getEntityResolver
```
OXQEntityResolver getEntityResolver()
```
    Gets the OXQEntityResolver instance to be used during query processing.
    
    Returns:
    
    the entity resolver instance
  - setEntityResolver
```
void setEntityResolver(OXQEntityResolver resolver)
```
    Sets an OXQEntityResolver instance to be used during query processing.
    
    Parameters:
    
    resolver - the entity resolver to use
    
    See Also:
    
    OXQConnection.createEntityResolverFactory(Class), OXQEntityResolverFactory
  - declareImport
```
void declareImport(OXQEntityKind entityKind,
                   java.lang.String namespace,
                   java.lang.String... locations)
            throws XQException
```
    Declares that a schema or module should be imported.
    
    Parameters:
    
    entityKind - must be either OXQEntityKind.MODULE or OXQEntityKind.SCHEMA
    
    namespace - the target namespace of the schema or module
    
    locations - the location hints
    
    Throws:
    
    XQException - if namespace is null, or if any element of locations is null, or if entityKind is not OXQEntityKind.MODULE or OXQEntityKind.SCHEMA
    
    See Also:
    
    getImportLocations(OXQEntityKind, String), getImportNamespaces(OXQEntityKind), XQuery Schema Import Feature, XQuery Module Import
  - getImportNamespaces
```
java.lang.String[] getImportNamespaces(OXQEntityKind entityKind)
                                throws XQException
```
    Gets the target namespaces of all schema or module imports currently declared.
    
    Parameters:
    
    entityKind - must be either OXQEntityKind.MODULE or OXQEntityKind.SCHEMA
    
    Returns:
    
    an array of the target namespaces. Cannot be null
    
    Throws:
    
    XQException - if entityKind is not OXQEntityKind.MODULE or OXQEntityKind.SCHEMA
    
    See Also:
    
    declareImport(OXQEntityKind,String,String...), getImportLocations(OXQEntityKind,String)
  - getImportLocations
```
java.lang.String[] getImportLocations(OXQEntityKind entityKind,
                                      java.lang.String namespace)
                               throws XQException
```
    Gets the locations of a schema or module import.
    
    Parameters:
    
    entityKind - must be either OXQEntityKind.MODULE or OXQEntityKind.SCHEMA
    
    namespace - the target namespace of the schema to get the location hints for
    
    Returns:
    
    an array of the schema locations. Cannot be null
    
    Throws:
    
    XQException - if namespace is null or unknown or if entityKind is not OXQEntityKind.MODULE or OXQEntityKind.SCHEMA
    
    See Also:
    
    declareImport(OXQEntityKind,String,String...), getImportNamespaces(OXQEntityKind)
  - declareVariable
```
void declareVariable(javax.xml.namespace.QName name,
                     XQSequenceType type)
              throws XQException
```
    Declares an external variable.
    
    Parameters:
    
    name - variable name. Cannot be null
    
    type - variable type. If null is specified then defaults to item()*
    
    Throws:
    
    XQException - if name is null
  - getVariableNames
```
javax.xml.namespace.QName[] getVariableNames()
```
    Gets the names of all external variables declared in this context.
    
    Returns:
    
    an array of the variable names. Cannot be null
  - getVariableType
```
XQSequenceType getVariableType(javax.xml.namespace.QName name)
                        throws XQException
```
    Gets the type of an external variable declared in this context.
    
    Parameters:
    
    name - The name of the variable. Cannot be null
    
    Returns:
    
    type of the variable. Cannot be null
    
    Throws:
    
    XQException - if variable name is null or unknown
  - undeclareVariable
```
void undeclareVariable(javax.xml.namespace.QName name)
                throws XQException
```
    Undeclares a previously declared external variable.
    
    Parameters:
    
    name - variable name. Cannot be null
    
    Throws:
    
    XQException - if name is null, or the variable is unknown
  - declareFunction
```
void declareFunction(javax.xml.namespace.QName name,
                     XQSequenceType[] parameterTypes,
                     XQSequenceType returnType,
                     OXQOptions options)
              throws XQException
```
    Declares an external function.
    
    Parameters:
    
    name - function name. Cannot be null
    
    parameterTypes - types of parameters. Cannot be null
    
    returnType - output type. If null is specified then defaults to item()*
    
    options - additional options. May be null
    
    Throws:
    
    XQException - if function name is null or any of parameter types is null
    
    See Also:
    
    OXQConnection.createOptions()
  - declareFunction
```
void declareFunction(javax.xml.namespace.QName name,
                     XQSequenceType[] parameterTypes,
                     XQSequenceType returnType,
                     OXQOptions options,
                     OXQAnnotation[] annotations)
              throws XQException
```
    Declares an external function.
    
    Parameters:
    
    name - function name. Cannot be null
    
    parameterTypes - types of parameters. Cannot be null
    
    returnType - output type. If null is specified then defaults to item()*
    
    options - additional options. May be null
    
    annotations - function annotations. May be null
    
    Throws:
    
    XQException - if function name is null or any of parameter types is null
    
    See Also:
    
    OXQConnection.createOptions(), OXQConnection.createAnnotation(QName, javax.xml.xquery.XQSequence), OXQFunctionMetaData
  - getFunctions
```
OXQFunctionMetaData[] getFunctions()
```
    Gets the definitions of all external functions declared in this context.
    
    Returns:
    
    an array containing function definitions. Cannot be null
  - undeclareFunction
```
void undeclareFunction(javax.xml.namespace.QName name,
                       int parameterCount)
                throws XQException
```
    Undeclares a previously declared external function.
    
    Parameters:
    
    name - function name. Cannot be null
    
    parameterCount - number of parameters
    
    Throws:
    
    XQException - if name is null, or the function is unknown
  - getSerializationParameters
```
OXQSerializationParameters getSerializationParameters()
```
    Gets an OXQSerializationParameters instance representing the the values for all serialization parameters. The returned instance is a copy so setSerializationParameters(OXQSerializationParameters) must be used to change the serialization parameters of this static context.
    
    Returns:
    
    the serialization parameters
  - setSerializationParameters
```
void setSerializationParameters(OXQSerializationParameters params)
                         throws XQException
```
    Sets the serialization parameters for this static context.
    
    Parameters:
    
    params - the serialization parameters. May not be null
    
    Throws:
    
    XQException - if params is null

Interface OXQStaticContext

Method Summary

Method Detail

getXQView

getBindingTypeCheckMode

setBindingTypeCheckMode

getProcessingMode

setProcessingMode

getModuleURI

setModuleURI

getEntityResolver

setEntityResolver

declareImport

getImportNamespaces

getImportLocations

declareVariable

getVariableNames

getVariableType

undeclareVariable

declareFunction

declareFunction

getFunctions

undeclareFunction

getSerializationParameters

setSerializationParameters