Package org.basex.core.cmd

Class Add

java.lang.Object

org.basex.core.jobs.Job

org.basex.core.Command

org.basex.core.cmd.ACreate

org.basex.core.cmd.Add

public final class Add
extends ACreate

Evaluates the 'add' command and adds a document to a collection. Note that the constructors of this class have changed with Version 7.0: the target path and file name have been merged and are now specified as first argument.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Field Summary

Fields inherited from class org.basex.core.cmd.ACreate

lock

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
Add(String path)	Constructor, specifying a target path.
Add(String path, String input)	Constructor, specifying a target path and an input.

Method Summary

Modifier and Type	Method	Description
void	build(CmdBuilder cb)	Builds a string representation from the command.
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.

Methods inherited from class org.basex.core.cmd.ACreate

addLocks, newData, stoppable, supportsProg

Methods inherited from class org.basex.core.Command

addLocks, baseURI, baseURI, 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, 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

Add

public Add(String path)

Constructor, specifying a target path. The input needs to be set via Command.setInput(InputStream).

Parameters:

path - target path, optionally terminated by a new file name

Add

public Add(String path,
 String input)

Constructor, specifying a target path and an input.

Parameters:

path - target path, optionally terminated by a new file name If null, the name of the input will be set as path.

input - input file or 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

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

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

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