org.mozilla.mentat

Class Query

java.lang.Object

org.mozilla.mentat.Query

All Implemented Interfaces:

AutoCloseable

public class Query
extends Object

This class allows you to construct a query, bind values to variables and run those queries against a mentat DB.

This class cannot be created directly, but must be created through `Mentat.query(String:)`.

The types of values you can bind are:

• TypedValue
• long
• Entid (as long)
• Keyword (as String)
• boolean
• double
• Date
• String
• UUID

Each bound variable must have a corresponding value in the query string used to create this query.

 String query = "[:find ?name ?cat\n" +
          "        :in ?type\n" +
          "        :where\n" +
          "        [?c :community/name ?name]\n" +
          "        [?c :community/type ?type]\n" +
          "        [?c :community/category ?cat]]";
 mentat.query(query).bindKeywordReference("?type", ":community.type/website").run(new RelResultHandler() {

Constructor Summary

Constructors

Constructor and Description
Query(JNA.QueryBuilder pointer)

Method Summary

Modifier and Type	Method and Description
Query	bind(String varName, boolean value) Binds a boolean value to the provided variable name.
Query	bind(String varName, Date value) Binds a Date value to the provided variable name.
Query	bind(String varName, double value) Binds a double value to the provided variable name.
Query	bind(String varName, long value) Binds a long value to the provided variable name.
Query	bind(String varName, String value) Binds a String value to the provided variable name.
Query	bind(String varName, UUID value) Binds a UUID value to the provided variable name.
Query	bindEntidReference(String varName, long value) Binds a Entid value to the provided variable name.
Query	bindKeyword(String varName, String value) Binds a keyword value to the provided variable name.
Query	bindKeywordReference(String varName, String value) Binds a String keyword value to the provided variable name.
void	close()
protected void	destroyPointer(JNA.QueryBuilder p)
protected void	finalize()
void	run(CollResultHandler handler) Execute the query with the values bound associated with this Query and call the provided callback function with the results with the result as a list of single TypedValues.
void	run(RelResultHandler handler) Execute the query with the values bound associated with this Query and call the provided callback function with the results as a list of rows of TypedValues.
void	run(ScalarResultHandler handler) Execute the query with the values bound associated with this Query and call the provided callback function with the results with the result as a single TypedValue.
void	run(TupleResultHandler handler) Execute the query with the values bound associated with this Query and call the provided callback function with the results with the result as a list of single TypedValues.

Methods inherited from class java.lang.Object

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

Constructor Detail

Query

public Query(JNA.QueryBuilder pointer)

Method Detail

bind

public Query bind(String varName,
                  long value)

Binds a long value to the provided variable name. TODO: Throw an exception if the query raw pointer has been consumed.

Parameters:

varName - The name of the variable in the format `?name`.

value - The value to be bound

Returns:

This Query such that further function can be called.

bindEntidReference

public Query bindEntidReference(String varName,
                                long value)

Binds a Entid value to the provided variable name. TODO: Throw an exception if the query raw pointer has been consumed.

Parameters:

varName - The name of the variable in the format `?name`.

value - The value to be bound

Returns:

This Query such that further function can be called.

bindKeywordReference

public Query bindKeywordReference(String varName,
                                  String value)

Binds a String keyword value to the provided variable name. TODO: Throw an exception if the query raw pointer has been consumed.

Parameters:

varName - The name of the variable in the format `?name`.

value - The value to be bound

Returns:

This Query such that further function can be called.

bindKeyword

public Query bindKeyword(String varName,
                         String value)

Binds a keyword value to the provided variable name. TODO: Throw an exception if the query raw pointer has been consumed.

Parameters:

varName - The name of the variable in the format `?name`.

value - The value to be bound

Returns:

This Query such that further function can be called.

bind

public Query bind(String varName,
                  boolean value)

Binds a boolean value to the provided variable name. TODO: Throw an exception if the query raw pointer has been consumed.

Parameters:

varName - The name of the variable in the format `?name`.

value - The value to be bound

Returns:

This Query such that further function can be called.

bind

public Query bind(String varName,
                  double value)

Binds a double value to the provided variable name. TODO: Throw an exception if the query raw pointer has been consumed.

Parameters:

varName - The name of the variable in the format `?name`.

value - The value to be bound

Returns:

This Query such that further function can be called.

bind

public Query bind(String varName,
                  Date value)

Binds a Date value to the provided variable name. TODO: Throw an exception if the query raw pointer has been consumed.

Parameters:

varName - The name of the variable in the format `?name`.

value - The value to be bound

Returns:

This Query such that further function can be called.

bind

public Query bind(String varName,
                  String value)

Binds a String value to the provided variable name. TODO: Throw an exception if the query raw pointer has been consumed.

Parameters:

varName - The name of the variable in the format `?name`.

value - The value to be bound

Returns:

This Query such that further function can be called.

bind

public Query bind(String varName,
                  UUID value)

Binds a UUID value to the provided variable name. TODO: Throw an exception if the query raw pointer has been consumed.

Parameters:

varName - The name of the variable in the format `?name`.

value - The value to be bound

Returns:

This Query such that further function can be called.

run

public void run(RelResultHandler handler)

Execute the query with the values bound associated with this Query and call the provided callback function with the results as a list of rows of TypedValues. TODO: Throw an exception if the query raw pointer has been consumed or the query fails to execute

Parameters:

handler - the handler to call with the results of this query

run

public void run(ScalarResultHandler handler)

Execute the query with the values bound associated with this Query and call the provided callback function with the results with the result as a single TypedValue. TODO: Throw an exception if the query raw pointer has been consumed or the query fails to execute

Parameters:

handler - the handler to call with the results of this query

run

public void run(CollResultHandler handler)

Execute the query with the values bound associated with this Query and call the provided callback function with the results with the result as a list of single TypedValues. TODO: Throw an exception if the query raw pointer has been consumed or the query fails to execute

Parameters:

handler - the handler to call with the results of this query

run

public void run(TupleResultHandler handler)

Execute the query with the values bound associated with this Query and call the provided callback function with the results with the result as a list of single TypedValues. TODO: Throw an exception if the query raw pointer has been consumed or the query fails to execute

Parameters:

handler - the handler to call with the results of this query

destroyPointer

protected void destroyPointer(JNA.QueryBuilder p)

close

public void close()

Specified by:

close in interface AutoCloseable

finalize

protected void finalize()

Overrides:

finalize in class Object