Package org.basex.core.cmd

Class Check

java.lang.Object

org.basex.core.jobs.Job

org.basex.core.Command

org.basex.core.cmd.Check

public final class Check
extends Command

Evaluates the 'check' command: opens an existing database or creates a new one.

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
Check(String input)	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.
protected boolean	run()	Executes the command and serializes the result (internal call).
boolean	stoppable()	Returns true if this command can be stopped.
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, 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

Check

public Check(String input)

Default constructor.

Parameters:

input - input (name of database, file path, XML string)

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

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

stoppable

public boolean stoppable()

Description copied from class: Command

Returns true if this command can be stopped. This method is only required by the GUI.

Overrides:

stoppable in class Command

Returns:

result of check

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

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