Package org.basex.core.cmd

Class AQuery

java.lang.Object

org.basex.core.jobs.Job

org.basex.core.Command

org.basex.core.cmd.AQuery

Direct Known Subclasses:

Find, XQuery

public abstract class AQuery
extends Command

Abstract class for database queries.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Field Summary

Fields

Modifier and Type	Field	Description
protected final HashMap<String,Object>	vars	External variable bindings.

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

Method Summary

Modifier and Type	Method	Description
void	addLocks()	Adds the strings (databases, special identifiers) for which locks need to be acquired.
void	build(CmdBuilder cb)	Builds a string representation from the command.
final String	parameters(Context ctx)	Returns the serialization parameters.
final Value	result()	Returns a cached result set generated by AQuery.
boolean	stoppable()	Returns true if this command can be stopped.
final boolean	updated(Context ctx)	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

addLocks, baseURI, baseURI, close, error, exception, execute, execute, getOption, getOption, info, info, init, maxResults, newData, run, 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

Field Details

vars

protected final HashMap<String,Object> vars

External variable bindings.

Method Details

parameters

public final String parameters(Context ctx)

Returns the serialization parameters.

Parameters:

ctx - context

Returns:

serialization parameters

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

updated

public final boolean updated(Context ctx)

Description copied from class: Command

Checks if the command has updated any data.

Overrides:

updated in class Command

Parameters:

ctx - database context

Returns:

result of check

addLocks

public void addLocks()

Description copied from class: Job

Adds the strings (databases, special identifiers) for which locks need to be acquired.

Overrides:

addLocks in class Job

build

public void build(CmdBuilder 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 only required by the GUI.

Overrides:

stoppable in class Command

Returns:

result of check

result

public final Value result()

Description copied from class: Command

Returns a cached result set generated by AQuery. Can only be called once.

Overrides:

result in class Command

Returns:

result set or null