org.basex.server

Class LocalSession

java.lang.Object

org.basex.server.Session

org.basex.server.LocalSession

public class LocalSession
extends Session

This class offers methods to locally execute database commands.

Author:

BaseX Team 2005-12, BSD License, Christian Gruen

Field Summary

Fields

Modifier and Type	Field and Description
protected Context	ctx Database context.

Fields inherited from class org.basex.server.Session

out

Constructor Summary

Constructors

Constructor and Description
LocalSession(Context context) Default constructor.
LocalSession(Context context, java.io.OutputStream output) Constructor, specifying an output stream.
LocalSession(Context context, java.lang.String user, java.lang.String pass) Constructor, specifying login data.
LocalSession(Context context, java.lang.String user, java.lang.String pass, java.io.OutputStream output) Constructor, specifying login data and an output stream.

Method Summary

Methods

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

Methods inherited from class org.basex.server.Session

execute, execute, info, setOutputStream

Methods inherited from class java.lang.Object

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

Field Detail

ctx

protected final Context ctx

Database context.

Constructor Detail

LocalSession

public LocalSession(Context context)

Default constructor.

Parameters:

context - context

LocalSession

public LocalSession(Context context,
            java.lang.String user,
            java.lang.String pass)
             throws LoginException

Constructor, specifying login data.

Parameters:

context - context

user - user name

pass - password

Throws:

LoginException - login exception

LocalSession

public LocalSession(Context context,
            java.lang.String user,
            java.lang.String pass,
            java.io.OutputStream output)
             throws LoginException

Constructor, specifying login data and an output stream.

Parameters:

context - context

user - user name

pass - password

output - output stream

Throws:

LoginException - login exception

LocalSession

public LocalSession(Context context,
            java.io.OutputStream output)

Constructor, specifying an output stream.

Parameters:

context - context

output - output stream

Method Detail

create

public void create(java.lang.String name,
          java.io.InputStream input)
            throws java.io.IOException

Description copied from class: Session

Creates a database.

Specified by:

create in class Session

Parameters:

name - name of database

input - xml input

Throws:

java.io.IOException - I/O exception

add

public void add(java.lang.String path,
       java.io.InputStream input)
         throws java.io.IOException

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:

java.io.IOException - I/O exception

replace

public void replace(java.lang.String path,
           java.io.InputStream input)
             throws java.io.IOException

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:

java.io.IOException - I/O exception

store

public void store(java.lang.String path,
         java.io.InputStream input)
           throws java.io.IOException

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:

java.io.IOException - I/O exception

query

public LocalQuery query(java.lang.String query)
                 throws BaseXException

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

Throws:

BaseXException

close

public void close()

Description copied from class: Session

Closes the session.

Specified by:

close in class Session

execute

protected void execute(java.lang.String str,
           java.io.OutputStream os)
                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:

str - command to be parsed

os - output stream

Throws:

BaseXException

execute

protected void execute(Command cmd,
           java.io.OutputStream os)
                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:

cmd - command to be executed

os - output stream

Throws:

BaseXException