net.ontopia.topicmaps.query.core

Interface ParsedQueryIF

All Superinterfaces:

ParsedStatementIF

All Known Implementing Classes:

ParsedQuery, ParsedQuery

public interface ParsedQueryIF
extends ParsedStatementIF

PUBLIC: Used to represent parsed queries.

Method Summary

Modifier and Type	Method and Description
QueryResultIF	execute() PUBLIC: Executes the query, returning the query result.
QueryResultIF	execute(Map<String,?> arguments) PUBLIC: Executes the query binding the parameters in the query to the values given in the 'arguments' map, returning the query result.
Collection<String>	getAllVariables() PUBLIC: Returns all the variables used in the query, in no particular order.
Collection<String>	getCountedVariables() PUBLIC: Returns the variables that are counted in the select clause of the query.
List<String>	getOrderBy() PUBLIC: Returns the variables listed in the order by clause in the order they are given there.
List<String>	getSelectedVariables() PUBLIC: Returns the variables in the select clause of the query, in the order given there.
boolean	isOrderedAscending(String name) PUBLIC: Returns true if the named variable is to be sorted in ascending order.

Method Detail

getSelectedVariables

List<String> getSelectedVariables()

PUBLIC: Returns the variables in the select clause of the query, in the order given there. If there is no select clause all the variables used in the query are returned, in no particular order.

Returns:

An immutable List of String objects.

getCountedVariables

Collection<String> getCountedVariables()

PUBLIC: Returns the variables that are counted in the select clause of the query. They are returned in no particular order. If there are no counted variables, or if there is no select clause an empty collection is returned.

Returns:

An immutable Collection of String objects.

getAllVariables

Collection<String> getAllVariables()

PUBLIC: Returns all the variables used in the query, in no particular order.

Returns:

An immutable Collection of String objects.

getOrderBy

List<String> getOrderBy()

PUBLIC: Returns the variables listed in the order by clause in the order they are given there. In order to see which ones are ascending and which descending, use the isOrderedAscending method.

Returns:

An immutable List of String objects.

isOrderedAscending

boolean isOrderedAscending(String name)

PUBLIC: Returns true if the named variable is to be sorted in ascending order.

execute

QueryResultIF execute()
               throws InvalidQueryException

PUBLIC: Executes the query, returning the query result. Query results are not cached, so results are up to date.

Throws:

InvalidQueryException

execute

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

PUBLIC: Executes the query binding the parameters in the query to the values given in the 'arguments' map, returning the query result. Query results are not cached, so results are up to date.

Throws:

InvalidQueryException

Since:

2.0