QueryContext

java.lang.Object
- org.basex.core.Progress
- - org.basex.query.QueryContext

```
public final class QueryContext
extends Progress
```
This class provides query-specific methods and properties.

Author:

BaseX Team 2005-12, BSD License, Christian Gruen

Field Summary

Fields
Modifier and Type	Field and Description
`Context`	`context` Database context.
`Expr`	`ctxItem` Initial context value.
`Dat`	`date` Current Date.
`java.util.HashMap<java.lang.String,java.lang.String>`	`dbOptions` Query options (are valid during query execution).
`Dtm`	`dtm` Current DateTime.
`byte`	`ftoknum` Full-text token counter (needed for highlighting of full-text results).
`FTPosData`	`ftpos` Full-text position data (needed for highlighting of full-text results).
`FTLexer`	`fttoken` Current full-text token.
`UserFuncs`	`funcs` Functions.
`java.util.HashMap<java.lang.String,java.lang.Object>`	`globalOpt` Global options (will be set after query execution).
`boolean`	`grouping` Compilation flag: GFLWOR clause performs grouping.
`JarLoader`	`jars` JAR modules.
`java.util.HashMap<QueryModule,java.util.ArrayList<java.lang.reflect.Method>>`	`javaModules` Java modules.
`boolean`	`leaf` Compilation flag: current node has leaves.
`int`	`maxCalls` Maximum number of successive tail calls.
`long`	`pos` Current context position.
`QueryResources`	`resource` Query resources.
`Expr`	`root` Root expression of the query.
`StaticContext`	`sc` Static context of an expression.
`long`	`size` Current context size.
`java.util.HashMap<java.lang.String,IO>`	`stop` Cached stop word files.
`int`	`tailCalls` Number of successive tail calls.
`java.util.HashMap<java.lang.String,IO>`	`thes` Cached thesaurus files.
`Tim`	`time` Current Time.
`Updates`	`updates` Pending updates.
`Value`	`value` Current context value.
`int`	`varIDs` Counter for variable IDs.
`VarContext`	`vars` Variables.
`boolean`	`xquery3` XQuery version flag.

Fields inherited from class org.basex.core.Progress
updating

Constructor Summary

Constructors
Constructor and Description

QueryContext(Context ctx)
Constructor.

Constructors
Constructor and Description
`QueryContext(Context ctx)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`compile()` Compiles and optimizes the expression.
`void`	`compInfo(java.lang.String string, java.lang.Object... ext)` Adds some optimization info.
`Data`	`data()` Returns the current data reference of the context value, or `null`.
`java.lang.String`	`det()` Returns short information on this process.
`void`	`evalInfo(byte[] string)` Adds some evaluation info.
`FTOpt`	`ftOpt()` Returns the current full-text options.
`void`	`ftOpt(FTOpt opt)` Sets full-text options.
`java.lang.String`	`info()` Returns info on query compilation and evaluation.
`Iter`	`iter()` Returns a result iterator.
`Iter`	`iter(Expr e)` Evaluates the specified expression and returns an iterator.
`JDBCConnections`	`jdbc()` Returns JDBC connections.
`void`	`module(java.lang.String qu)` Parses the specified module.
`void`	`parse(java.lang.String qu)` Parses the specified query.
`double`	`prog()` Returns a progress value (0 - 1).
`SerializerProp`	`serParams(boolean optional)` Returns the serialization parameters used for and specified by this query.
`java.lang.String`	`tit()` Returns short information on this process.
`Var`	`uniqueVar(InputInfo ii, SeqType type)` Creates a variable with a unique, non-clashing variable name.
`boolean`	`updating()` Returns `true` if the query may perform updates.
`void`	`updating(boolean up)` Sets the updating flag.
`Value`	`value()` Returns the result value.
`Value`	`value(Expr expr)` Evaluates the specified expression and returns an iterator.

Methods inherited from class org.basex.core.Progress
abort, checkStop, detail, progress, progress, startTimeout, stop, stopTimeout, title

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - sc
```
public StaticContext sc
```
    Static context of an expression.
  - vars
```
public final VarContext vars
```
    Variables.
  - funcs
```
public final UserFuncs funcs
```
    Functions.
  - resource
```
public final QueryResources resource
```
    Query resources.
  - context
```
public final Context context
```
    Database context.
  - xquery3
```
public boolean xquery3
```
    XQuery version flag.
  - stop
```
public java.util.HashMap<java.lang.String,IO> stop
```
    Cached stop word files.
  - thes
```
public java.util.HashMap<java.lang.String,IO> thes
```
    Cached thesaurus files.
  - dbOptions
```
public final java.util.HashMap<java.lang.String,java.lang.String> dbOptions
```
    Query options (are valid during query execution).
  - globalOpt
```
public final java.util.HashMap<java.lang.String,java.lang.Object> globalOpt
```
    Global options (will be set after query execution).
  - root
```
public Expr root
```
    Root expression of the query.
  - value
```
public Value value
```
    Current context value.
  - pos
```
public long pos
```
    Current context position.
  - size
```
public long size
```
    Current context size.
  - fttoken
```
public FTLexer fttoken
```
    Current full-text token.
  - date
```
public Dat date
```
    Current Date.
  - dtm
```
public Dtm dtm
```
    Current DateTime.
  - time
```
public Tim time
```
    Current Time.
  - ftpos
```
public FTPosData ftpos
```
    Full-text position data (needed for highlighting of full-text results).
  - ftoknum
```
public byte ftoknum
```
    Full-text token counter (needed for highlighting of full-text results).
  - updates
```
public Updates updates
```
    Pending updates.
  - leaf
```
public boolean leaf
```
    Compilation flag: current node has leaves.
  - grouping
```
public boolean grouping
```
    Compilation flag: GFLWOR clause performs grouping.
  - tailCalls
```
public int tailCalls
```
    Number of successive tail calls.
  - maxCalls
```
public final int maxCalls
```
    Maximum number of successive tail calls.
  - varIDs
```
public int varIDs
```
    Counter for variable IDs.
  - ctxItem
```
public Expr ctxItem
```
    Initial context value.
  - javaModules
```
public final java.util.HashMap<QueryModule,java.util.ArrayList<java.lang.reflect.Method>> javaModules
```
    Java modules.
  - jars
```
public JarLoader jars
```
    JAR modules.
- Constructor Detail
  - QueryContext
```
public QueryContext(Context ctx)
```
    Constructor.
    
    Parameters:
    ctx - database context
- Method Detail
  - parse
```
public void parse(java.lang.String qu)
           throws QueryException
```
    Parses the specified query.
    
    Parameters:
    qu - input query
    
    Throws:
    
    QueryException - query exception
  - module
```
public void module(java.lang.String qu)
            throws QueryException
```
    Parses the specified module.
    
    Parameters:
    qu - input query
    
    Throws:
    
    QueryException - query exception
  - compile
```
public void compile()
             throws QueryException
```
    Compiles and optimizes the expression.
    
    Throws:
    
    QueryException - query exception
  - iter
```
public Iter iter()
          throws QueryException
```
    Returns a result iterator.
    
    Returns:
    result iterator
    
    Throws:
    
    QueryException - query exception
  - value
```
public Value value()
            throws QueryException
```
    Returns the result value.
    
    Returns:
    result value
    
    Throws:
    
    QueryException - query exception
  - iter
```
public Iter iter(Expr e)
          throws QueryException
```
    Evaluates the specified expression and returns an iterator.
    
    Parameters:
    e - expression to be evaluated
    
    Returns:
    iterator
    
    Throws:
    
    QueryException - query exception
  - value
```
public Value value(Expr expr)
            throws QueryException
```
    Evaluates the specified expression and returns an iterator.
    
    Parameters:
    expr - expression to be evaluated
    
    Returns:
    iterator
    
    Throws:
    
    QueryException - query exception
  - data
```
public Data data()
```
    Returns the current data reference of the context value, or null.
    
    Returns:
    data reference
  - uniqueVar
```
public Var uniqueVar(InputInfo ii,
            SeqType type)
```
    Creates a variable with a unique, non-clashing variable name.
    
    Parameters:
    ii - input info
    type - type
    
    Returns:
    variable
  - compInfo
```
public void compInfo(java.lang.String string,
            java.lang.Object... ext)
```
    Adds some optimization info.
    
    Parameters:
    string - evaluation info
    ext - text text extensions
  - evalInfo
```
public void evalInfo(byte[] string)
```
    Adds some evaluation info.
    
    Parameters:
    string - evaluation info
  - info
```
public java.lang.String info()
```
    Returns info on query compilation and evaluation.
    
    Returns:
    query info
  - jdbc
```
public JDBCConnections jdbc()
```
    Returns JDBC connections.
    
    Returns:
    jdbc connections
  - serParams
```
public SerializerProp serParams(boolean optional)
                         throws SerializerException
```
    Returns the serialization parameters used for and specified by this query.
    
    Parameters:
    optional - if true, a null reference is returned if no parameters have been specified
    
    Returns:
    serialization parameters
    
    Throws:
    
    SerializerException - serializer exception
  - ftOpt
```
public FTOpt ftOpt()
```
    Returns the current full-text options. Creates a new instance if called first.
    
    Returns:
    full-text options
  - ftOpt
```
public void ftOpt(FTOpt opt)
```
    Sets full-text options.
    
    Parameters:
    opt - full-text options
  - updating
```
public boolean updating()
```
    Returns true if the query may perform updates.
    
    Returns:
    updating flag
  - updating
```
public void updating(boolean up)
```
    Sets the updating flag.
    
    Parameters:
    up - updating flag
  - tit
```
public java.lang.String tit()
```
    Description copied from class: Progress
    
    Returns short information on this process. Can be overwritten to give more detailed information.
    
    Overrides:
    
    tit in class Progress
    
    Returns:
    header information
  - det
```
public java.lang.String det()
```
    Description copied from class: Progress
    
    Returns short information on this process.
    
    Overrides:
    
    det in class Progress
    
    Returns:
    header information
  - prog
```
public double prog()
```
    Description copied from class: Progress
    
    Returns a progress value (0 - 1). Can be overwritten to give more detailed information.
    
    Overrides:
    
    prog in class Progress
    
    Returns:
    header information

Class QueryContext

Field Summary

Fields inherited from class org.basex.core.Progress

Constructor Summary

Method Summary

Methods inherited from class org.basex.core.Progress

Methods inherited from class java.lang.Object

Field Detail

sc

vars

funcs

resource

context

xquery3

stop

thes

dbOptions

globalOpt

root

value

pos

size

fttoken

date

dtm

time

ftpos

ftoknum

updates

leaf

grouping

tailCalls

maxCalls

varIDs

ctxItem

javaModules

jars

Constructor Detail

QueryContext

Method Detail

parse

module

compile

iter

value

iter

value

data

uniqueVar

compInfo

evalInfo

info

jdbc

serParams

ftOpt

ftOpt

updating

updating

tit

det

prog