org.basex.core.cmd
Class AlterDB

java.lang.Object
  extended by org.basex.core.Proc
      extended by org.basex.core.Command
          extended by org.basex.core.cmd.ACreate
              extended by org.basex.core.cmd.AlterDB

public final class AlterDB
extends ACreate

Evaluates the 'alter database' command and renames a database.

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

Field Summary
 
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
AlterDB(java.lang.String db, java.lang.String name)
          Default constructor.
 
Method Summary
static boolean alter(java.lang.String source, java.lang.String target, Context ctx)
          Renames the specified database.
 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.
 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).
 
Methods inherited from class org.basex.core.cmd.ACreate
create, drop, sourceToIO, stoppable, supportsProg
 
Methods inherited from class org.basex.core.Command
close, databases, error, execute, execute, getOption, getOption, info, info, result, run, run, setInput, setInput, toString, updated, updating
 
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
 

Constructor Detail

AlterDB

public AlterDB(java.lang.String db,
               java.lang.String name)
Default constructor.

Parameters:
db - database
name - new name
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

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 ACreate
Parameters:
lr - Container for lock result to pass around

alter

public static boolean alter(java.lang.String source,
                            java.lang.String target,
                            Context ctx)
Renames the specified database.

Parameters:
source - name of the existing database
target - new database name
ctx - database context
Returns:
success flag

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 ACreate
Parameters:
ctx - database context
Returns:
result of check

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