Package org.basex.core.cmd

Class XQuery

java.lang.Object

org.basex.core.jobs.Job

org.basex.core.Command

org.basex.core.cmd.AQuery

org.basex.core.cmd.XQuery

public final class XQuery
extends AQuery

Evaluates the 'xquery' command and processes an XQuery request.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Field Summary

Fields inherited from class org.basex.core.cmd.AQuery

vars

Fields inherited from class org.basex.core.Command

args, context, exception, in, maxResults, openDB, options, out, soptions, uri

Fields inherited from class org.basex.core.jobs.Job

state, updating

Constructor Summary

Constructors

Constructor	Description
XQuery(String query)	Default constructor.

Method Summary

Modifier and Type	Method	Description
XQuery	bind(String name, String value)	Binds a variable.
XQuery	bind(String name, String value, String type)	Binds a variable.
XQuery	bind(String name, Value value)	Binds a variable.
protected boolean	run()	Executes the command and serializes the result (internal call).

Methods inherited from class org.basex.core.cmd.AQuery

addLocks, build, parameters, result, stoppable, updated, updating

Methods inherited from class org.basex.core.Command

addLocks, baseURI, baseURI, close, error, exception, execute, execute, getOption, getOption, info, info, init, maxResults, newData, run, run, setInput, setInput, supportsProg, toString, toString

Methods inherited from class org.basex.core.jobs.Job

active, checkStop, detailedInfo, jc, memory, popJob, progressInfo, pushJob, register, shortInfo, state, stop, stopped, timeout, unregister

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

XQuery

public XQuery(String query)

Default constructor.

Parameters:

query - query to evaluate

Method Details

run

protected boolean run()

Description copied from class: Command

Executes the command and serializes the result (internal call).

Specified by:

run in class Command

Returns:

success of operation

bind

public XQuery bind(String name,
 Value value)

Binds a variable.

Parameters:

name - name of variable (if null, value will be bound as context value)

value - XQuery value to be bound

Returns:

self reference

bind

public XQuery bind(String name,
 String value)

Binds a variable.

Parameters:

name - name of variable (if null, value will be bound as context value)

value - value to be bound (XQuery value; any other value will be converted to a string)

Returns:

self reference

bind

public XQuery bind(String name,
 String value,
 String type)

Binds a variable.

Parameters:

name - name of variable (if null, value will be bound as context value)

value - value to be bound

type - type

Returns:

self reference