org.wandora.query2

Class QueryRunner

java.lang.Object

org.wandora.query2.QueryRunner

public class QueryRunner
extends java.lang.Object

This is a utility class to help with running queries read from a query script in a String. The CatchException versions are mostly meant for Velocity where catching exceptions is impossible in the template code. Instead you can just check for an exception in the result after the method finishes.

Author:

olli

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryRunner.QueryResult

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.script.ScriptEngine	scriptEngine
protected java.lang.String	scriptEngineName
protected static ScriptManager	scriptManager

Constructor Summary

Constructors

Constructor and Description
QueryRunner() Initialize the runner with the default scripting engine.
QueryRunner(java.lang.String scriptEngineName) Initialize the runner with the specified scripting engine.

Method Summary

Modifier and Type	Method and Description
java.util.ArrayList<ResultRow>	runQuery(Directive directive, java.util.Collection<Topic> contextTopics)
java.util.ArrayList<ResultRow>	runQuery(Directive directive, Topic contextTopic)
java.util.ArrayList<ResultRow>	runQuery(java.lang.String query, java.util.Collection<Topic> contextTopics)
java.util.ArrayList<ResultRow>	runQuery(java.lang.String query, Topic contextTopic)
QueryRunner.QueryResult	runQueryCatchException(Directive directive, java.util.Collection<Topic> contextTopics)
QueryRunner.QueryResult	runQueryCatchException(Directive directive, Topic contextTopic)
QueryRunner.QueryResult	runQueryCatchException(java.lang.String query, java.util.Collection<Topic> contextTopics)
QueryRunner.QueryResult	runQueryCatchException(java.lang.String query, Topic contextTopic)

Methods inherited from class java.lang.Object

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

Field Detail

scriptEngineName

protected java.lang.String scriptEngineName

scriptManager

protected static ScriptManager scriptManager

scriptEngine

protected javax.script.ScriptEngine scriptEngine

Constructor Detail

QueryRunner

public QueryRunner(java.lang.String scriptEngineName)

Initialize the runner with the specified scripting engine. Give the string "none" as scripting engine name to not initialize any engine. In this case, you may only use the runQuery methods that take a directive directly instead of a query script.

Parameters:

scriptEngineName -

QueryRunner

public QueryRunner()

Initialize the runner with the default scripting engine.

Method Detail

runQuery

public java.util.ArrayList<ResultRow> runQuery(java.lang.String query,
                                               Topic contextTopic)
                                        throws javax.script.ScriptException,
                                               QueryException

Throws:

javax.script.ScriptException

QueryException

runQueryCatchException

public QueryRunner.QueryResult runQueryCatchException(java.lang.String query,
                                                      Topic contextTopic)

runQuery

public java.util.ArrayList<ResultRow> runQuery(Directive directive,
                                               Topic contextTopic)
                                        throws QueryException

Throws:

QueryException

runQueryCatchException

public QueryRunner.QueryResult runQueryCatchException(Directive directive,
                                                      Topic contextTopic)

runQuery

public java.util.ArrayList<ResultRow> runQuery(java.lang.String query,
                                               java.util.Collection<Topic> contextTopics)
                                        throws javax.script.ScriptException,
                                               QueryException

Throws:

javax.script.ScriptException

QueryException

runQueryCatchException

public QueryRunner.QueryResult runQueryCatchException(java.lang.String query,
                                                      java.util.Collection<Topic> contextTopics)

runQuery

public java.util.ArrayList<ResultRow> runQuery(Directive directive,
                                               java.util.Collection<Topic> contextTopics)
                                        throws QueryException

Throws:

QueryException

runQueryCatchException

public QueryRunner.QueryResult runQueryCatchException(Directive directive,
                                                      java.util.Collection<Topic> contextTopics)