Package org.basex.core.cmd

Class AlterDB

java.lang.Object

org.basex.core.jobs.Job

org.basex.core.Command

org.basex.core.cmd.ACreate

org.basex.core.cmd.AlterDB

public final class AlterDB
extends ACreate

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

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Field Summary

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

lock

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
AlterDB(String db, String name)	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	addLocks()	Adds the strings (databases, special identifiers) for which locks need to be acquired.
static boolean	alter(String source, String target, StaticOptions sopts)	Renames the specified database.
void	build(CmdBuilder cb)	Builds a string representation from the command.
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

stoppable, supportsProg

Methods inherited from class org.basex.core.Command

addLocks, baseURI, baseURI, close, error, exception, execute, execute, getOption, getOption, info, info, init, maxResults, result, run, run, setInput, setInput, toString, toString, updated, updating

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

AlterDB

public AlterDB(String db,
 String name)

Default constructor.

Parameters:

db - database

name - new name

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

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 ACreate

alter

public static boolean alter(String source,
 String target,
 StaticOptions sopts)

Renames the specified database.

Parameters:

source - name of the existing database

target - new database name

sopts - static options

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 only required by the GUI.

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