Package ca.phon.query.script

Class QueryScriptContext

java.lang.Object

ca.phon.script.PhonScriptContext

ca.phon.query.script.QueryScriptContext

public class QueryScriptContext
extends PhonScriptContext

Field Summary

Fields inherited from class ca.phon.script.PhonScriptContext

SCRIPT_EXPORTS

Constructor Summary

Constructors

Constructor	Description
QueryScriptContext(QueryScript script)

Method Summary

Modifier and Type	Method	Description
void	callBeginSearch(org.mozilla.javascript.Scriptable scope, Session session)	Call the begin_search function
void	callEndSearch(org.mozilla.javascript.Scriptable scope, Session session)	Call the end_search function
Object	callQueryFunction(org.mozilla.javascript.Scriptable scope, QueryScript.QueryFunction function, Object... args)	Call the specified QueryFunction with the given arguments
void	callQueryRecord(org.mozilla.javascript.Scriptable scope, Integer recordIndex, Record record)	Call the query_record function.
boolean	hasBeginSearch(org.mozilla.javascript.Scriptable scope)	Does the script define a begin_search function
boolean	hasEndSearch(org.mozilla.javascript.Scriptable scope)	Does the script define a end_search function
boolean	hasQueryFunction(org.mozilla.javascript.Scriptable scope, QueryScript.QueryFunction function)	Does the script define the given QueryScript.QueryFunction
boolean	hasQueryRecord(org.mozilla.javascript.Scriptable scope)	Does the script define a query_record = function(session, record) function

Methods inherited from class ca.phon.script.PhonScriptContext

callFunction, createBasicScope, createImporterScope, enter, eval, exec, exit, getCompiledScript, getContextFactory, getEvaluatedScope, getEvaluatedScope, getPhonScript, getScriptParameters, getStdErr, getStdOut, getWrapFactory, hasFunction, installParams, redirectStdErr, redirectStdOut, resetEvaulatedScope

Methods inherited from class java.lang.Object

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

Constructor Details

QueryScriptContext

public QueryScriptContext(QueryScript script)

Method Details

hasQueryRecord

public boolean hasQueryRecord(org.mozilla.javascript.Scriptable scope)

Does the script define a query_record = function(session, record) function

Returns:

true if a query_record function was found, false otherwise

callQueryRecord

public void callQueryRecord(org.mozilla.javascript.Scriptable scope,
 Integer recordIndex,
 Record record)
                     throws PhonScriptException

Call the query_record function.

Parameters:

record -

Throws:

PhonScriptException

hasBeginSearch

public boolean hasBeginSearch(org.mozilla.javascript.Scriptable scope)

Does the script define a begin_search function

Returns:

true if a begin_search function was found, false otherwise

callBeginSearch

public void callBeginSearch(org.mozilla.javascript.Scriptable scope,
 Session session)
                     throws PhonScriptException

Call the begin_search function

Parameters:

session -

Throws:

PhonScriptException

hasEndSearch

public boolean hasEndSearch(org.mozilla.javascript.Scriptable scope)

Does the script define a end_search function

Returns:

true if a end_search function was found, false otherwise

callEndSearch

public void callEndSearch(org.mozilla.javascript.Scriptable scope,
 Session session)
                   throws PhonScriptException

Call the end_search function

Parameters:

session -

Throws:

PhonScriptException

hasQueryFunction

public boolean hasQueryFunction(org.mozilla.javascript.Scriptable scope,
 QueryScript.QueryFunction function)

Does the script define the given QueryScript.QueryFunction

Parameters:

function -

Returns:

true if the specified function is defined in the script, false otherwise

callQueryFunction

public Object callQueryFunction(org.mozilla.javascript.Scriptable scope,
 QueryScript.QueryFunction function,
 Object... args)
                         throws PhonScriptException

Call the specified QueryFunction with the given arguments

Parameters:

function -

args -

Returns:

result of calling function or null

Throws:

PhonScriptException