Package net.ontopia.topicmaps.query.core

Interface QueryProcessorIF

All Known Implementing Classes:

QueryProcessor, QueryProcessor

public interface QueryProcessorIF

PUBLIC: This is the interface that must be implemented by tolog query processors. It is used by client applications to execute queries.

Method Summary

Modifier and Type	Method	Description
QueryResultIF	execute(String query)	PUBLIC: Parses and executes the query, returning the results.
QueryResultIF	execute(String query, Map<String,?> arguments)	PUBLIC: Parses and executes the query binding the parameters in the query to the values given in the 'arguments' map, returning the results.
QueryResultIF	execute(String query, Map<String,?> arguments, DeclarationContextIF context)	PUBLIC: Parses and executes the query in the given context binding the parameters in the query to the values given in the 'arguments' map, returning the results.
QueryResultIF	execute(String query, DeclarationContextIF context)	PUBLIC: Parses and executes the query in the given context, returning the results.
void	load(Reader ruleset)	Deprecated. use rule import declaration instead, or contexts
void	load(String ruleset)	Deprecated. use rule import declaration instead, or contexts
ParsedQueryIF	parse(String query)	PUBLIC: Parses the query, returning an object representing the result.
ParsedQueryIF	parse(String query, DeclarationContextIF context)	PUBLIC: Parses the query in the given context, returning an object representing the result.
ParsedModificationStatementIF	parseUpdate(String statement)	PUBLIC: Parses the update statement, returning an object representing the result.
ParsedModificationStatementIF	parseUpdate(String statement, DeclarationContextIF context)	PUBLIC: Parses the update statement in the given context, returning an object representing the result.
int	update(String query)	PUBLIC: Runs the update statement, returning the number of modified objects.
int	update(String query, Map<String,?> arguments)	PUBLIC: Runs the update statement with the given parameters, returning the number of modified objects.
int	update(String query, Map<String,?> arguments, DeclarationContextIF context)	PUBLIC: Runs the update statement in the given declaration context with the given parameters, returning the number of modified objects.
int	update(String query, DeclarationContextIF context)	PUBLIC: Runs the update statement in the given declaration context, returning the number of modified objects.

Method Details

execute

QueryResultIF execute(String query)
               throws InvalidQueryException

PUBLIC: Parses and executes the query, returning the results.

Throws:

InvalidQueryException

execute

QueryResultIF execute(String query,
 DeclarationContextIF context)
               throws InvalidQueryException

PUBLIC: Parses and executes the query in the given context, returning the results.

Throws:

InvalidQueryException

Since:

2.1

execute

QueryResultIF execute(String query,
 Map<String,?> arguments)
               throws InvalidQueryException

PUBLIC: Parses and executes the query binding the parameters in the query to the values given in the 'arguments' map, returning the results.

Throws:

InvalidQueryException

Since:

2.0

execute

QueryResultIF execute(String query,
 Map<String,?> arguments,
 DeclarationContextIF context)
               throws InvalidQueryException

PUBLIC: Parses and executes the query in the given context binding the parameters in the query to the values given in the 'arguments' map, returning the results.

Throws:

InvalidQueryException

Since:

2.1

update

int update(String query)
    throws InvalidQueryException

PUBLIC: Runs the update statement, returning the number of modified objects.

Throws:

InvalidQueryException

Since:

5.1.0

update

int update(String query,
 DeclarationContextIF context)
    throws InvalidQueryException

PUBLIC: Runs the update statement in the given declaration context, returning the number of modified objects.

Throws:

InvalidQueryException

Since:

5.1.0

update

int update(String query,
 Map<String,?> arguments)
    throws InvalidQueryException

PUBLIC: Runs the update statement with the given parameters, returning the number of modified objects.

Throws:

InvalidQueryException

Since:

5.1.0

update

int update(String query,
 Map<String,?> arguments,
 DeclarationContextIF context)
    throws InvalidQueryException

PUBLIC: Runs the update statement in the given declaration context with the given parameters, returning the number of modified objects.

Throws:

InvalidQueryException

Since:

5.1.0

parse

ParsedQueryIF parse(String query)
             throws InvalidQueryException

PUBLIC: Parses the query, returning an object representing the result.

Throws:

InvalidQueryException

parse

ParsedQueryIF parse(String query,
 DeclarationContextIF context)
             throws InvalidQueryException

PUBLIC: Parses the query in the given context, returning an object representing the result.

Throws:

InvalidQueryException

Since:

2.1

parseUpdate

ParsedModificationStatementIF parseUpdate(String statement)
                                   throws InvalidQueryException

PUBLIC: Parses the update statement, returning an object representing the result.

Throws:

InvalidQueryException

Since:

5.1.0

parseUpdate

ParsedModificationStatementIF parseUpdate(String statement,
 DeclarationContextIF context)
                                   throws InvalidQueryException

PUBLIC: Parses the update statement in the given context, returning an object representing the result.

Throws:

InvalidQueryException

Since:

5.1.0

load

void load(String ruleset)
   throws InvalidQueryException

Deprecated.

use rule import declaration instead, or contexts

DEPRECATED: Loads a set of rules into the query processor from a string. The rules will then be available for use in queries throughout the lifetime of the current scope.

Throws:

InvalidQueryException

load

void load(Reader ruleset)
   throws InvalidQueryException,
IOException

Deprecated.

use rule import declaration instead, or contexts

DEPRECATED: Loads a set of rules into the query processor from a reader object. The rules will then be available for use in queries throughout the lifetime of the current scope.

Throws:

InvalidQueryException

IOException

Since:

1.4