Package com.complexible.stardog.api

Interface GraphQuery

All Superinterfaces:

Query<GraphQueryResult>, ReadQuery<GraphQueryResult>

public interface GraphQuery
extends ReadQuery<GraphQueryResult>

A SPARQL graph (describe or construct) query.

Since:

2.0

Version:

6.0

Author:

Michael Grove

Field Summary

Fields inherited from interface com.complexible.stardog.api.Query

NO_ID, NO_TIMEOUT

Fields inherited from interface com.complexible.stardog.api.ReadQuery

NO_LIMIT, NO_OFFSET

Method Summary

Modifier and Type	Method	Description
GraphQuery	dataset(Dataset theDataset)	Specify the dataset this query will be executed against.
GraphQuery	limit(long theLimit)	Set the maximum number of results that can be returned by this query.
GraphQuery	offset(long theOffset)	Set the offset of the query results.
GraphQuery	parameter(java.lang.String theName, boolean theValue)	Set the parameter to the xsd:boolean value
GraphQuery	parameter(java.lang.String theName, byte theValue)	Set the parameter to the xsd:byte value
GraphQuery	parameter(java.lang.String theName, double theValue)	Set the parameter to the xsd:double value
GraphQuery	parameter(java.lang.String theName, float theValue)	Set the parameter to the xsd:float value
GraphQuery	parameter(java.lang.String theName, int theValue)	Set the parameter to the xsd:int value
GraphQuery	parameter(java.lang.String theName, long theValue)	Set the parameter to the xsd:long value
GraphQuery	parameter(java.lang.String theName, short theValue)	Set the parameter to the xsd:short value
GraphQuery	parameter(java.lang.String theName, Value theValue)	Set the value of the parameter
GraphQuery	parameter(java.lang.String theName, java.lang.Object theObj)	Set the parameter to the specified value.
GraphQuery	parameter(java.lang.String theName, java.lang.String theValue)	Set the parameter to the xsd:string value
GraphQuery	parameter(java.lang.String theName, java.net.URI theURI)	Set the parameter to the xsd:URI value
GraphQuery	parameter(java.lang.String theName, java.util.Date theValue)	Set the parameter to the xsd:date value
GraphQuery	parameter(java.lang.String theName, java.util.GregorianCalendar theValue)	Set the parameter to the xsd:dateTime value
GraphQuery	reasoning(boolean theReasoningType)	{Specify whether you would like the query to be executed with reasoning.
GraphQuery	schema(java.lang.String theSchema)	{Sets the schema that will be used by this query or {@code null} if reasoning will not be used.
GraphQuery	timeout(long theTimeout)	Set the timeout for query execution.

Methods inherited from interface com.complexible.stardog.api.Query

baseURI, dataset, execute, explain, explain, explain, getID, getSchema, hint, hints, id, isReasoningEnabled, parameters, queryString, timeout, toString

Methods inherited from interface com.complexible.stardog.api.ReadQuery

execute, limit, offset

Method Detail

dataset

GraphQuery dataset(Dataset theDataset)

Specify the dataset this query will be executed against. This defines the active graph for the query and will override anything specified within the query. Use Datasets.NO_DATASET remove the dataset.

Specified by:

dataset in interface Query<GraphQueryResult>

Specified by:

dataset in interface ReadQuery<GraphQueryResult>

Parameters:

theDataset - the active graph dataset

Returns:

this query

See Also:

Datasets

limit

GraphQuery limit(long theLimit)

Set the maximum number of results that can be returned by this query. Setting the limit on the query will override any limit specified in the original query string, however, setting the limit to ReadQuery.NO_LIMIT will not remove the limit if it is specified in the query, but you can use it to remove a limit that has already been set if there was not a limit specified in the query originally.

Specified by:

limit in interface ReadQuery<GraphQueryResult>

Parameters:

theLimit - the new limit

Returns:

this query

offset

GraphQuery offset(long theOffset)

Set the offset of the query results. Similar to ReadQuery.limit() this will override an offset in the query, and you can use ReadQuery.NO_OFFSET to remove an offset specified on the query, but not in the query string.

Specified by:

offset in interface ReadQuery<GraphQueryResult>

Parameters:

theOffset - the offset

Returns:

this query

timeout

GraphQuery timeout(long theTimeout)

Set the timeout for query execution.

Specified by:

timeout in interface Query<GraphQueryResult>

Parameters:

theTimeout - the timeout in ms. A zero or negative value will be interpreted as no timeout

Returns:

this query

reasoning

GraphQuery reasoning(boolean theReasoningType)

{

Specify whether you would like the query to be executed with reasoning. For update queries, the reasoning flag only affects the evaluation of WHERE clauses in DELETE/INSERT queries.

You can only modify the reasoning flag of a query outside of a transaction. If querying within a transaction you can only use the reasoning flag associated with the connection.

If the reasoning schema is explicitly set via the Query.schema(String) function beforehand then calling reasoning(true) will have no effect. If the schema is not set then calling reasoning(true) is equivalent to setting the schema to the default schema. Calling reasoning(false) is always equivalent to setting the schema to the null schema.

}

Specified by:

reasoning in interface Query<GraphQueryResult>

Parameters:

theReasoningType - the reasoning flag

Returns:

this query

schema

GraphQuery schema(java.lang.String theSchema)

{Sets the schema that will be used by this query or {@code null} if reasoning will not be used. If the schema is set with this function Query.reasoning(boolean) function is not needed to be called.}

Specified by:

schema in interface Query<GraphQueryResult>

Parameters:

theSchema - the name of the schema

Returns:

this query

parameter

GraphQuery parameter(java.lang.String theName,
                     Value theValue)

Set the value of the parameter

Specified by:

parameter in interface Query<GraphQueryResult>

Parameters:

theName - the parameter to set

theValue - the value of the parameter

Returns:

this query

parameter

GraphQuery parameter(java.lang.String theName,
                     int theValue)

Set the parameter to the xsd:int value

Specified by:

parameter in interface Query<GraphQueryResult>

Parameters:

theName - the parameter to set

theValue - the value of the parameter

Returns:

this query

parameter

GraphQuery parameter(java.lang.String theName,
                     long theValue)

Set the parameter to the xsd:long value

Specified by:

parameter in interface Query<GraphQueryResult>

Parameters:

theName - the parameter to set

theValue - the value of the parameter

Returns:

this query

parameter

GraphQuery parameter(java.lang.String theName,
                     float theValue)

Set the parameter to the xsd:float value

Specified by:

parameter in interface Query<GraphQueryResult>

Parameters:

theName - the parameter to set

theValue - the value of the parameter

Returns:

this query

parameter

GraphQuery parameter(java.lang.String theName,
                     double theValue)

Set the parameter to the xsd:double value

Specified by:

parameter in interface Query<GraphQueryResult>

Parameters:

theName - the parameter to set

theValue - the value of the parameter

Returns:

this query

parameter

GraphQuery parameter(java.lang.String theName,
                     short theValue)

Set the parameter to the xsd:short value

Specified by:

parameter in interface Query<GraphQueryResult>

Parameters:

theName - the parameter to set

theValue - the value of the parameter

Returns:

this query

parameter

GraphQuery parameter(java.lang.String theName,
                     boolean theValue)

Set the parameter to the xsd:boolean value

Specified by:

parameter in interface Query<GraphQueryResult>

Parameters:

theName - the parameter to set

theValue - the value of the parameter

Returns:

this query

parameter

GraphQuery parameter(java.lang.String theName,
                     byte theValue)

Set the parameter to the xsd:byte value

Specified by:

parameter in interface Query<GraphQueryResult>

Parameters:

theName - the parameter to set

theValue - the value of the parameter

Returns:

this query

parameter

GraphQuery parameter(java.lang.String theName,
                     java.lang.String theValue)

Set the parameter to the xsd:string value

Specified by:

parameter in interface Query<GraphQueryResult>

Parameters:

theName - the parameter to set

theValue - the value of the parameter

Returns:

this query

parameter

GraphQuery parameter(java.lang.String theName,
                     java.util.Date theValue)

Set the parameter to the xsd:date value

Specified by:

parameter in interface Query<GraphQueryResult>

Parameters:

theName - the parameter to set

theValue - the value of the parameter

Returns:

this query

parameter

GraphQuery parameter(java.lang.String theName,
                     java.util.GregorianCalendar theValue)

Set the parameter to the xsd:dateTime value

Specified by:

parameter in interface Query<GraphQueryResult>

Parameters:

theName - the parameter to set

theValue - the value of the parameter

Returns:

this query

parameter

GraphQuery parameter(java.lang.String theName,
                     java.net.URI theURI)

Set the parameter to the xsd:URI value

Specified by:

parameter in interface Query<GraphQueryResult>

Parameters:

theName - the parameter to set

theURI - the value of the parameter

Returns:

this query

parameter

GraphQuery parameter(java.lang.String theName,
                     java.lang.Object theObj)

Set the parameter to the specified value. Convenience method which will delegate to one of the other parameter(...) methods

Specified by:

parameter in interface Query<GraphQueryResult>

Parameters:

theName - the parameter name

theObj - the param value

Returns:

this query