Package org.basex.core.cmd

Class Restore

java.lang.Object

org.basex.core.jobs.Job

org.basex.core.Command

org.basex.core.cmd.Restore

public final class Restore
extends Command

Evaluates the 'restore' command and restores a backup 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
Restore(String arg)	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	addLocks()	Adds the strings (databases, special identifiers) for which locks need to be acquired.
boolean	newData(Context ctx)	Closes an open data reference and returns true if this command will change the Context.data() reference.
static void	restore(String db, String backup, StaticOptions sopts, Restore cmd)	Restores the specified database.
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, 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, progressInfo, 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

Restore

public Restore(String arg)

Default constructor.

Parameters:

arg - optional argument

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.

restore

public static void restore(String db,
 String backup,
 StaticOptions sopts,
 Restore cmd)
                    throws IOException

Restores the specified database.

Parameters:

db - name of database

backup - name of backup

sopts - static options

cmd - calling command instance

Throws:

IOException - I/O exception

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

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 Command

Parameters:

ctx - database context

Returns:

result of check

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