net.ontopia.topicmaps.query.impl.basic
Class ParsedQuery

java.lang.Object
  net.ontopia.topicmaps.query.impl.basic.ParsedQuery

All Implemented Interfaces:

ParsedQueryIF, ParsedStatementIF

public class ParsedQuery
extends java.lang.Object
implements ParsedQueryIF

INTERNAL: Class used to represent parsed queries. The class wraps a query executer and a tolog query intance (as generated by the parser). The actual query execution is delegated to the query processor.

Field Summary

protected QueryProcessor	processor
protected TologQuery	query

Constructor Summary

ParsedQuery(QueryProcessor processor, TologQuery query)

Method Summary

QueryResultIF	execute() PUBLIC: Executes the query, returning the query result.
QueryResultIF	execute(java.util.Map<java.lang.String,?> arguments) PUBLIC: Executes the query binding the parameters in the query to the values given in the 'arguments' map, returning the query result.
java.util.Collection<java.lang.String>	getAllVariables() PUBLIC: Returns all the variables used in the query, in no particular order.
java.util.List	getClauses()
java.util.Collection<java.lang.String>	getCountedVariables() PUBLIC: Returns the variables that are counted in the select clause of the query.
java.util.List<java.lang.String>	getOrderBy() PUBLIC: Returns the variables listed in the order by clause in the order they are given there.
java.util.List<java.lang.String>	getSelectedVariables() PUBLIC: Returns the variables in the select clause of the query, in the order given there.
protected java.util.List<java.lang.String>	getVariables(java.util.Collection<Variable> varnames)
java.lang.Object[]	getVariableTypes(java.lang.String varname)
boolean	isOrderedAscending(java.lang.String name) PUBLIC: Returns true if the named variable is to be sorted in ascending order.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

query

protected TologQuery query

processor

protected QueryProcessor processor

Constructor Detail

ParsedQuery

public ParsedQuery(QueryProcessor processor,
                   TologQuery query)

Method Detail

getClauses

public java.util.List getClauses()

getSelectedVariables

public java.util.List<java.lang.String> getSelectedVariables()

Description copied from interface: ParsedQueryIF

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.

Specified by:

getSelectedVariables in interface ParsedQueryIF

Returns:

An immutable List of String objects.

getAllVariables

public java.util.Collection<java.lang.String> getAllVariables()

Description copied from interface: ParsedQueryIF

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

Specified by:

getAllVariables in interface ParsedQueryIF

Returns:

An immutable Collection of String objects.

getCountedVariables

public java.util.Collection<java.lang.String> getCountedVariables()

Description copied from interface: ParsedQueryIF

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.

Specified by:

getCountedVariables in interface ParsedQueryIF

Returns:

An immutable Collection of String objects.

getOrderBy

public java.util.List<java.lang.String> getOrderBy()

Description copied from interface: ParsedQueryIF

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.

Specified by:

getOrderBy in interface ParsedQueryIF

Returns:

An immutable List of String objects.

isOrderedAscending

public boolean isOrderedAscending(java.lang.String name)

Description copied from interface: ParsedQueryIF

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

Specified by:

isOrderedAscending in interface ParsedQueryIF

execute

public QueryResultIF execute()
                      throws InvalidQueryException

Description copied from interface: ParsedQueryIF

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

Specified by:

execute in interface ParsedQueryIF

Throws:

InvalidQueryException

execute

public QueryResultIF execute(java.util.Map<java.lang.String,?> arguments)
                      throws InvalidQueryException

Description copied from interface: ParsedQueryIF

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.

Specified by:

execute in interface ParsedQueryIF

Throws:

InvalidQueryException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getVariables

protected java.util.List<java.lang.String> getVariables(java.util.Collection<Variable> varnames)

getVariableTypes

public java.lang.Object[] getVariableTypes(java.lang.String varname)