org.basex.core.cmd

Class XQuery

java.lang.Object

org.basex.core.Progress

org.basex.core.Command

org.basex.core.cmd.XQuery

public final class XQuery
extends Command

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

Author:

BaseX Team 2005-12, BSD License, Christian Gruen

Field Summary

Fields inherited from class org.basex.core.Command

args, context, DATAREF, in, mprop, out, perf, prop, STANDARD

Fields inherited from class org.basex.core.Progress

updating

Constructor Summary

Constructors

Constructor and Description
XQuery(java.lang.String query) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	build(CommandBuilder cb) Builds a string representation from the command.
java.lang.String	pinned(Context ctx) Checks if the database to be updated is opened (pinned) by a process in another JVM.
Result	result() Returns the result set, generated by a query command.
protected boolean	run() Executes the command and serializes the result (internal call).
boolean	stoppable() Returns true if this command can be stopped.
boolean	updated() Checks if the command has updated any data.
boolean	updating(Context ctx) Checks if the command performs updates/write operations.

Methods inherited from class org.basex.core.Command

close, error, execute, execute, getOption, getOption, info, info, newData, run, setInput, setInput, supportsProg, toString

Methods inherited from class org.basex.core.Progress

abort, checkStop, det, detail, prog, progress, progress, startTimeout, stop, stopTimeout, tit, title

Methods inherited from class java.lang.Object

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

Constructor Detail

XQuery

public XQuery(java.lang.String query)

Default constructor.

Parameters:

query - query to evaluate

Method Detail

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

updating

public boolean updating(Context ctx)

Description copied from class: Command

Checks if the command performs updates/write operations.

Overrides:

updating in class Command

Parameters:

ctx - database context

Returns:

result of check

pinned

public java.lang.String pinned(Context ctx)

Description copied from class: Command

Checks if the database to be updated is opened (pinned) by a process in another JVM.

Overrides:

pinned in class Command

Parameters:

ctx - database context

Returns:

name of pinned database

updated

public boolean updated()

Description copied from class: Command

Checks if the command has updated any data. If this method is called before command execution, it always returns true.

Overrides:

updated in class Command

Returns:

result of check

result

public final Result result()

Description copied from class: Command

Returns the result set, generated by a query command. Will only yield results if Prop.CACHEQUERY is set, and can only be called once.

Overrides:

result in class Command

Returns:

result set

build

public void build(CommandBuilder cb)

Description copied from class: Command

Builds a string representation from the command. This string must be correctly built, as commands are sent to the server as strings.

Overrides:

build in class Command

Parameters:

cb - command builder

stoppable

public boolean stoppable()

Description copied from class: Command

Returns true if this command can be stopped. This method is required by the progress dialog in the frontend.

Overrides:

stoppable in class Command

Returns:

result of check