org.basex.core.cmd

Class ACreate

java.lang.Object

org.basex.core.Progress

org.basex.core.Command

org.basex.core.cmd.ACreate

Direct Known Subclasses:

Add, AlterDB, CreateDB, CreateIndex, Delete, DropDB, DropIndex, Optimize, OptimizeAll, Rename, Replace, Retrieve, Store

public abstract class ACreate
extends Command

Abstract class for database creation commands.

Author:

BaseX Team 2005-12, BSD License, Christian Gruen

Field Summary

Fields inherited from class org.basex.core.Command

args, context, in, mprop, out, perf, prop

Fields inherited from class org.basex.core.Progress

updating

Method Summary

Methods

Modifier and Type	Method and Description
protected IOContent	cache() Returns cached input if the input is streamed and a data format different than XML has been chosen.
protected static void	create(IndexToken.IndexType index, Data data, ACreate cmd) Builds the specified index.
protected static boolean	drop(IndexToken.IndexType index, Data data) Drops the specified index.
boolean	newData(Context ctx) Closes an open data reference and returns true if this command will change the Context.data reference.
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

build, close, error, execute, execute, getOption, getOption, info, info, result, run, run, setInput, setInput, toString, updated, updating

Methods inherited from class org.basex.core.Progress

abort, checkStop, det, detail, prog, progress, progress, startTimeout, stop, stopTimeout, tit, title

Methods inherited from class java.lang.Object

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

Method Detail

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 required by the progress dialog in the frontend.

Overrides:

newData in class Command

Parameters:

ctx - database context

Returns:

result of check

supportsProg

public final boolean supportsProg()

Description copied from class: Command

Returns true if this command returns a progress value. This method is required by the progress dialog in the frontend.

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 required by the progress dialog in the frontend.

Overrides:

stoppable in class Command

Returns:

result of check

cache

protected IOContent cache()
                   throws java.io.IOException

Returns cached input if the input is streamed and a data format different than XML has been chosen.

Returns:

cached input

Throws:

java.io.IOException - I/O exception

create

protected static void create(IndexToken.IndexType index,
          Data data,
          ACreate cmd)
                      throws java.io.IOException

Builds the specified index.

Parameters:

index - index to be built

data - data reference

cmd - calling command

Throws:

java.io.IOException - I/O exception

drop

protected static boolean drop(IndexToken.IndexType index,
           Data data)

Drops the specified index.

Parameters:

index - index type

data - data reference

Returns:

success of operation