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
 QueryResultIF execute(java.lang.String query)
          PUBLIC: Parses and executes the query, returning the results.
 QueryResultIF execute(java.lang.String query, DeclarationContextIF context)
          PUBLIC: Parses and executes the query in the given context, returning the results.
 QueryResultIF execute(java.lang.String query, java.util.Map<java.lang.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(java.lang.String query, java.util.Map<java.lang.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.
 void load(java.io.Reader ruleset)
          Deprecated. use rule import declaration instead, or contexts
 void load(java.lang.String ruleset)
          Deprecated. use rule import declaration instead, or contexts
 ParsedQueryIF parse(java.lang.String query)
          PUBLIC: Parses the query, returning an object representing the result.
 ParsedQueryIF parse(java.lang.String query, DeclarationContextIF context)
          PUBLIC: Parses the query in the given context, returning an object representing the result.
 ParsedModificationStatementIF parseUpdate(java.lang.String statement)
          PUBLIC: Parses the update statement, returning an object representing the result.
 ParsedModificationStatementIF parseUpdate(java.lang.String statement, DeclarationContextIF context)
          PUBLIC: Parses the update statement in the given context, returning an object representing the result.
 int update(java.lang.String query)
          PUBLIC: Runs the update statement, returning the number of modified objects.
 int update(java.lang.String query, DeclarationContextIF context)
          PUBLIC: Runs the update statement in the given declaration context, returning the number of modified objects.
 int update(java.lang.String query, java.util.Map<java.lang.String,?> arguments)
          PUBLIC: Runs the update statement with the given parameters, returning the number of modified objects.
 int update(java.lang.String query, java.util.Map<java.lang.String,?> arguments, DeclarationContextIF context)
          PUBLIC: Runs the update statement in the given declaration context with the given parameters, returning the number of modified objects.
 

Method Detail

execute

QueryResultIF execute(java.lang.String query)
                      throws InvalidQueryException
PUBLIC: Parses and executes the query, returning the results.

Throws:
InvalidQueryException

execute

QueryResultIF execute(java.lang.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(java.lang.String query,
                      java.util.Map<java.lang.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(java.lang.String query,
                      java.util.Map<java.lang.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(java.lang.String query)
           throws InvalidQueryException
PUBLIC: Runs the update statement, returning the number of modified objects.

Throws:
InvalidQueryException
Since:
5.1.0

update

int update(java.lang.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(java.lang.String query,
           java.util.Map<java.lang.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(java.lang.String query,
           java.util.Map<java.lang.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(java.lang.String query)
                    throws InvalidQueryException
PUBLIC: Parses the query, returning an object representing the result.

Throws:
InvalidQueryException

parse

ParsedQueryIF parse(java.lang.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(java.lang.String statement)
                                          throws InvalidQueryException
PUBLIC: Parses the update statement, returning an object representing the result.

Throws:
InvalidQueryException
Since:
5.1.0

parseUpdate

ParsedModificationStatementIF parseUpdate(java.lang.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(java.lang.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(java.io.Reader ruleset)
          throws InvalidQueryException,
                 java.io.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
java.io.IOException
Since:
1.4


Copyright © 2000-2012 Ontopia.