Package org.basex.core.cmd

Class InfoIndex

java.lang.Object

org.basex.core.jobs.Job

org.basex.core.Command

org.basex.core.cmd.InfoIndex

public final class InfoIndex
extends Command

Evaluates the 'info index' command and returns information on the indexes of the currently opened 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
InfoIndex()	Default constructor.
InfoIndex(Object type)	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	addLocks()	Adds the strings (databases, special identifiers) for which locks need to be acquired.
void	build(CmdBuilder cb)	Builds a string representation from the command.
protected boolean	run()	Executes the command and serializes the result (internal call).

Methods inherited from class org.basex.core.Command

addLocks, baseURI, baseURI, close, error, exception, execute, execute, getOption, getOption, info, info, init, maxResults, newData, result, run, run, setInput, setInput, stoppable, supportsProg, 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

InfoIndex

public InfoIndex()

Default constructor.

InfoIndex

public InfoIndex(Object type)

Default constructor.

Parameters:

type - optional index type, defined in Commands.CmdIndexInfo

Method Details

run

protected boolean run()
               throws IOException

Description copied from class: Command

Executes the command and serializes the result (internal call).

Specified by:

run in class Command

Returns:

success of operation

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

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