Package org.basex.core.cmd

Class Copy

java.lang.Object

org.basex.core.jobs.Job

org.basex.core.Command

org.basex.core.cmd.Copy

public final class Copy
extends Command

Evaluates the 'copy' command and creates a copy of a database.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Field Summary

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
Copy(String db, String newdb)	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 void	copy(String source, String target, StaticOptions sopts, Copy cmd)	Copies the specified database.
double	progressInfo()	Returns a progress value (0 - 1).
protected boolean	run()	Executes the command and serializes the result (internal call).
String	shortInfo()	Returns short progress information.
boolean	supportsProg()	Returns true if this command returns a progress value.

Methods inherited from class org.basex.core.Command

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

Methods inherited from class org.basex.core.jobs.Job

active, checkStop, detailedInfo, jc, memory, popJob, pushJob, register, state, stop, stopped, timeout, unregister

Methods inherited from class java.lang.Object

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

Constructor Details

Copy

public Copy(String db,
 String newdb)

Default constructor.

Parameters:

db - db name

newdb - new db 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

copy

public static void copy(String source,
 String target,
 StaticOptions sopts,
 Copy cmd)
                 throws IOException

Copies the specified database.

Parameters:

source - name of the database

target - new database name

sopts - static options

cmd - calling command (can be null)

Throws:

IOException - I/O exception

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

shortInfo

public String shortInfo()

Description copied from class: Job

Returns short progress information. Can be overwritten to give more specific feedback.

Overrides:

shortInfo in class Job

Returns:

header information

supportsProg

public boolean supportsProg()

Description copied from class: Command

Returns true if this command returns a progress value. This method is only required by the GUI.

Overrides:

supportsProg in class Command

Returns:

result of check

progressInfo

public double progressInfo()

Description copied from class: Job

Returns a progress value (0 - 1). Can be overwritten to give more specific feedback.

Overrides:

progressInfo in class Job

Returns:

header information