Package org.basex.api.client

Class LocalSession

java.lang.Object

org.basex.api.client.Session

org.basex.api.client.LocalSession

All Implemented Interfaces:

Closeable, AutoCloseable

public class LocalSession
extends Session

This class offers methods to locally execute database commands.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Field Summary

Fields inherited from class org.basex.api.client.Session

info, out

Constructor Summary

Constructors

Constructor	Description
LocalSession(Context context)	Default constructor.
LocalSession(Context context, OutputStream output)	Constructor, specifying an output stream.
LocalSession(Context context, String username, String password)	Constructor, specifying login data.
LocalSession(Context context, String username, String password, OutputStream output)	Constructor, specifying login data and an output stream.

Method Summary

Modifier and Type	Method	Description
void	add(String path, InputStream input)	Adds a document to the opened database.
void	close()
Context	context()	Returns the associated database context.
void	create(String name, InputStream input)	Creates a database.
protected void	execute(String command, OutputStream output)	Executes a command and prints the result to the specified output stream.
protected void	execute(Command command, OutputStream output)	Executes a command and prints the result to the specified output stream.
LocalQuery	query(String query)	Returns a query object for the specified query string.
void	replace(String path, InputStream input)	Replaces a document in an open database.
void	store(String path, InputStream input)	Stores raw data in an open database.

Methods inherited from class org.basex.api.client.Session

execute, execute, getOutputStream, info, setOutputStream

Methods inherited from class java.lang.Object

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

Constructor Details

LocalSession

public LocalSession(Context context)

Default constructor.

Parameters:

context - context

LocalSession

public LocalSession(Context context,
 OutputStream output)

Constructor, specifying an output stream.

Parameters:

context - context

output - client output; if set to null, results will be returned as strings

LocalSession

public LocalSession(Context context,
 String username,
 String password)
             throws LoginException

Constructor, specifying login data.

Parameters:

context - context

username - user name

password - password (plain text)

Throws:

LoginException - login exception

LocalSession

public LocalSession(Context context,
 String username,
 String password,
 OutputStream output)
             throws LoginException

Constructor, specifying login data and an output stream.

Parameters:

context - context

username - user name

password - password (plain text)

output - client output; if set to null, results will be returned as strings

Throws:

LoginException - login exception

Method Details

create

public void create(String name,
 InputStream input)
            throws BaseXException

Description copied from class: Session

Creates a database.

Specified by:

create in class Session

Parameters:

name - name of database

input - xml input

Throws:

BaseXException

add

public void add(String path,
 InputStream input)
         throws BaseXException

Description copied from class: Session

Adds a document to the opened database.

Specified by:

add in class Session

Parameters:

path - target path

input - xml input

Throws:

BaseXException

replace

public void replace(String path,
 InputStream input)
             throws BaseXException

Description copied from class: Session

Replaces a document in an open database.

Specified by:

replace in class Session

Parameters:

path - document(s) to replace

input - new content

Throws:

BaseXException

store

public void store(String path,
 InputStream input)
           throws BaseXException

Description copied from class: Session

Stores raw data in an open database.

Specified by:

store in class Session

Parameters:

path - target path

input - binary input

Throws:

BaseXException

query

public LocalQuery query(String query)

Description copied from class: Session

Returns a query object for the specified query string.

Specified by:

query in class Session

Parameters:

query - query string

Returns:

query

close

public void close()

execute

protected void execute(String command,
 OutputStream output)
                throws BaseXException

Description copied from class: Session

Executes a command and prints the result to the specified output stream.

Specified by:

execute in class Session

Parameters:

command - command to be parsed

output - output stream

Throws:

BaseXException

execute

protected void execute(Command command,
 OutputStream output)
                throws BaseXException

Description copied from class: Session

Executes a command and prints the result to the specified output stream.

Specified by:

execute in class Session

Parameters:

command - command to be executed

output - output stream

Throws:

BaseXException

context

public Context context()

Returns the associated database context. Called from the XQJ driver.

Returns:

database context