org.basex.core.cmd
Class Execute

java.lang.Object
  extended by org.basex.core.Proc
      extended by org.basex.core.Command
          extended by org.basex.core.cmd.Execute
Direct Known Subclasses:
Run

public class Execute
extends Command

Evaluates the 'execute' command and runs a command script. This command can be used to run multiple commands as a single transaction.

Author:
BaseX Team 2005-12, BSD License, Christian Gruen

Field Summary
protected  java.lang.String error
          Error message.
protected  java.util.ArrayList<Command> list
          Commands to execute.
 
Fields inherited from class org.basex.core.Command
args, context, in, mprop, out, perf, prop
 
Fields inherited from class org.basex.core.Proc
listen, updating
 
Constructor Summary
Execute(java.lang.String input)
          Default constructor.
 
Method Summary
 void build(CmdBuilder cb)
          Builds a string representation from the command.
 void databases(LockResult lr)
          Adds the names of the databases that may be touched by the process.
protected  boolean init(Context ctx)
          Initializes the specified input.
protected  boolean init(java.lang.String input, Context ctx)
          Initializes the specified input.
 boolean newData(Context ctx)
          Closes an open data reference and returns true if this command will change the Context.data reference.
protected  boolean run()
          Executes the command and serializes the result (internal call).
 boolean updating(Context ctx)
          Checks if the command performs updates/write operations.
 
Methods inherited from class org.basex.core.Command
close, databases, error, execute, execute, getOption, getOption, info, info, result, run, run, setInput, setInput, stoppable, supportsProg, toString, updated
 
Methods inherited from class org.basex.core.Proc
abort, checkStop, det, detail, listen, proc, prog, progress, registered, registered, startTimeout, stop, stopTimeout, tit, title
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

list

protected final java.util.ArrayList<Command> list
Commands to execute.


error

protected java.lang.String error
Error message.

Constructor Detail

Execute

public Execute(java.lang.String input)
Default constructor.

Parameters:
input - user input
Method Detail

newData

public boolean newData(Context ctx)
Description copied from class: Command
Closes an open data reference and returns true if this command will change the Context.data reference. This method is required by the progress dialog in the frontend.

Overrides:
newData in class Command
Parameters:
ctx - database context
Returns:
result of check

databases

public void databases(LockResult lr)
Description copied from class: Proc
Adds the names of the databases that may be touched by the process.

Overrides:
databases in class Proc
Parameters:
lr - Container for lock result to pass around

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

init

protected boolean init(Context ctx)
Initializes the specified input.

Parameters:
ctx - database context
Returns:
success flag

init

protected final boolean init(java.lang.String input,
                             Context ctx)
Initializes the specified input.

Parameters:
input - command input
ctx - database context
Returns:
success flag

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