Package org.basex.api.client

Class ClientQuery

java.lang.Object

org.basex.api.client.Query

org.basex.api.client.ClientQuery

All Implemented Interfaces:

Closeable, AutoCloseable

public class ClientQuery
extends Query

This class defines all methods for iteratively evaluating queries with the client/server architecture. All sent data is received by the ClientListener and interpreted by the ServerQuery.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Field Summary

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

cache, out

Method Summary

Modifier and Type	Method	Description
void	bind(String name, Object value, String type)	Binds a value with an optional type to an external variable.
void	cache(boolean full)	Caches the query result.
void	close()
void	context(Object value, String type)	Binds a value with an optional type to an external variable.
String	execute()	Returns the complete result of the query.
String	info()	Returns query info.
String	options()	Returns the serialization options.
boolean	updating()	Returns true if the query may perform updates.

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

bind, context, more, next, type

Methods inherited from class java.lang.Object

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

Method Details

info

public String info()
            throws IOException

Description copied from class: Query

Returns query info.

Specified by:

info in class Query

Returns:

query info

Throws:

IOException - I/O exception

options

public String options()
               throws IOException

Description copied from class: Query

Returns the serialization options.

Specified by:

options in class Query

Returns:

serialization options

Throws:

IOException - I/O exception

updating

public boolean updating()
                 throws IOException

Description copied from class: Query

Returns true if the query may perform updates.

Specified by:

updating in class Query

Returns:

updating flag

Throws:

IOException - I/O exception

bind

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

Description copied from class: Query

Binds a value with an optional type to an external variable.

Specified by:

bind in class Query

Parameters:

name - name of variable

value - value to be bound

type - value type (may be null)

Throws:

IOException - I/O exception

context

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

Description copied from class: Query

Binds a value with an optional type to an external variable.

Specified by:

context in class Query

Parameters:

value - value to be bound

type - value type (may be null)

Throws:

IOException - I/O exception

execute

public String execute()
               throws IOException

Description copied from class: Query

Returns the complete result of the query.

Specified by:

execute in class Query

Returns:

item string or null

Throws:

IOException - I/O exception

close

public void close()
           throws IOException

Throws:

IOException

cache

public void cache(boolean full)
           throws IOException

Description copied from class: Query

Caches the query result.

Specified by:

cache in class Query

Parameters:

full - retrieve full type information

Throws:

IOException - I/O exception