org.basex.examples.api

Class BaseXClient.Query

java.lang.Object

org.basex.examples.api.BaseXClient.Query

Enclosing class:

BaseXClient

public class BaseXClient.Query
extends Object

Inner class for iterative query execution.

Method Summary

Modifier and Type	Method and Description
void	bind(String name, String value) Binds a value to an external variable.
void	bind(String name, String value, String type) Binds a value with the specified type to an external variable.
void	close() Closes the query.
void	context(String value) Binds a value to the context item.
void	context(String value, String type) Binds a value with the specified type to the context item.
String	execute() Returns the whole result of the query.
String	info() Returns query info in a string.
boolean	more() Checks for the next item.
String	next() Returns the next item.
String	options() Returns serialization parameters in a string.

Methods inherited from class java.lang.Object

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

Method Detail

bind

public void bind(String name,
                 String value)
          throws IOException

Binds a value to an external variable.

Parameters:

name - name of variable

value - value

Throws:

IOException - I/O exception

bind

public void bind(String name,
                 String value,
                 String type)
          throws IOException

Binds a value with the specified type to an external variable.

Parameters:

name - name of variable

value - value

type - type (can be an empty string)

Throws:

IOException - I/O exception

context

public void context(String value)
             throws IOException

Binds a value to the context item.

Parameters:

value - value

Throws:

IOException - I/O exception

context

public void context(String value,
                    String type)
             throws IOException

Binds a value with the specified type to the context item.

Parameters:

value - value

type - type (can be an empty string)

Throws:

IOException - I/O exception

more

public boolean more()
             throws IOException

Checks for the next item.

Returns:

result of check

Throws:

IOException - I/O exception

next

public String next()
            throws IOException

Returns the next item.

Returns:

item string

Throws:

IOException - I/O Exception

execute

public String execute()
               throws IOException

Returns the whole result of the query.

Returns:

query result

Throws:

IOException - I/O Exception

info

public String info()
            throws IOException

Returns query info in a string.

Returns:

query info

Throws:

IOException - I/O exception

options

public String options()
               throws IOException

Returns serialization parameters in a string.

Returns:

query info

Throws:

IOException - I/O exception

close

public void close()
           throws IOException

Closes the query.

Throws:

IOException - I/O exception