SPARQLQueryDefinition (MarkLogic Java Client API 3.0.6 2016-10-14)

All Superinterfaces:

QueryDefinition
```
public interface SPARQLQueryDefinition
extends QueryDefinition
```
Represents a SPARQL query.

For details about RDF, SPARQL, and semantics in MarkLogic see the Semantics Developer's Guide.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`SPARQLQueryDefinition`	`clearBindings()` Remove all variable bindings from the child SPARQLBindings instance.
`String`	`getBaseUri()`
`SPARQLBindings`	`getBindings()` Get the child SPARQLBindings instance (normally populated by calls to withBinding methods).
`QueryDefinition`	`getConstrainingQueryDefinition()`
`String[]`	`getDefaultGraphUris()`
`Boolean`	`getIncludeDefaultRulesets()`
`String[]`	`getNamedGraphUris()`
`int`	`getOptimizeLevel()`
`SPARQLRuleset[]`	`getRulesets()`
`String`	`getSparql()` Get the SPARQL query or update statement
`GraphPermissions`	`getUpdatePermissions()` Get any permissions set on this instance.
`String[]`	`getUsingGraphUris()`
`String[]`	`getUsingNamedGraphUris()`
`void`	`setBaseUri(String uri)` set the base IRI for the query
`void`	`setBindings(SPARQLBindings bindings)` Set the child SPARQLBindings instance.
`void`	`setConstrainingQueryDefinition(QueryDefinition query)` Set the search query used to constrain the set of documents included in the SPARQL query.
`void`	`setDefaultGraphUris(String... uris)` Set the URI of the graph or graphs to use as the default graph.
`void`	`setIncludeDefaultRulesets(Boolean include)` Set whether to include database-default inference or not.
`void`	`setNamedGraphUris(String... uris)` Set the URI of a named graph or graphs to include in the query or update operation.
`void`	`setOptimizeLevel(int level)` Set a number indicating how much time for the query engine to spend analyzing a query.
`void`	`setRulesets(SPARQLRuleset... ruleset)` Set the name of rulesets to include for inferring triples.
`void`	`setSparql(String sparql)` Set the SPARQL query or update statement
`void`	`setSparql(TextWriteHandle sparql)` Set the SPARQL query or update statement
`void`	`setUpdatePermissions(GraphPermissions permissions)` For use with `SPARQL update`, where specified permissions will apply to any records created by the update.
`void`	`setUsingGraphUris(String... uris)` Set the URI of the graph or graphs to address as part of a SPARQL update operation.
`void`	`setUsingNamedGraphUris(String... uris)` Set the URI of a named graph or graphs to address as part of a SPARQL update operation.
`SPARQLQueryDefinition`	`withBinding(String name, String value)` Bind a variable of type iri.
`SPARQLQueryDefinition`	`withBinding(String name, String value, Locale languageTag)` Bind a variable of type http://www.w3.org/1999/02/22-rdf-syntax-ns#langString with the specified language tag.
`SPARQLQueryDefinition`	`withBinding(String name, String value, RDFTypes type)` Bind a variable of specified type.
`SPARQLQueryDefinition`	`withConstrainingQuery(QueryDefinition query)` Set the search query used to constrain the set of documents included in the SPARQL query.
`SPARQLQueryDefinition`	`withIncludeDefaultRulesets(Boolean include)` Set whether to include database-default inference or not.
`SPARQLQueryDefinition`	`withRuleset(SPARQLRuleset ruleset)` Set the name of rulesets to include for inferring triples.
`SPARQLQueryDefinition`	`withSparql(String sparql)` Set the SPARQL query or update statement
`SPARQLQueryDefinition`	`withSparql(TextWriteHandle sparql)` Set the SPARQL query or update statement
`SPARQLQueryDefinition`	`withUpdatePermission(String role, Capability capability)` Calls `setUpdatePermissions(com.marklogic.client.semantics.GraphPermissions)` then returns this instance for method chaining.

Methods inherited from interface com.marklogic.client.query.QueryDefinition
getCollections, getDirectory, getOptionsName, getResponseTransform, setCollections, setDirectory, setOptionsName, setResponseTransform

- Method Detail
  - setSparql
```
void setSparql(String sparql)
```
    Set the SPARQL query or update statement
    
    Parameters:
    
    sparql - the SPARQL statement
  - setSparql
```
void setSparql(TextWriteHandle sparql)
```
    Set the SPARQL query or update statement
    
    Parameters:
    
    sparql - the SPARQL statement
  - getSparql
```
String getSparql()
```
    Get the SPARQL query or update statement
    
    Returns:
    
    the SPARQL statement
  - withSparql
```
SPARQLQueryDefinition withSparql(String sparql)
```
    Set the SPARQL query or update statement
    
    Parameters:
    
    sparql - the SPARQL statement
    
    Returns:
    
    this instance (for method chaining)
  - withSparql
```
SPARQLQueryDefinition withSparql(TextWriteHandle sparql)
```
    Set the SPARQL query or update statement
    
    Parameters:
    
    sparql - the SPARQL statement
    
    Returns:
    
    this instance (for method chaining)
  - setBindings
```
void setBindings(SPARQLBindings bindings)
```
    Set the child SPARQLBindings instance.
    
    Parameters:
    
    bindings - bindings to set as the child SPARQLBindings instance
  - getBindings
```
SPARQLBindings getBindings()
```
    Get the child SPARQLBindings instance (normally populated by calls to withBinding methods).
    
    Returns:
    
    the bindings set on this instance
  - withBinding
```
SPARQLQueryDefinition withBinding(String name,
                                  String value)
```
    Bind a variable of type iri.
    
    Parameters:
    
    name - the bound variable name
    
    value - the iri value
    
    Returns:
    
    this instance (for method chaining)
  - withBinding
```
SPARQLQueryDefinition withBinding(String name,
                                  String value,
                                  RDFTypes type)
```
    Bind a variable of specified type.
    
    Parameters:
    
    name - the bound variable name
    
    value - the value of the literal
    
    type - the literal type
    
    Returns:
    
    this instance (for method chaining)
  - withBinding
```
SPARQLQueryDefinition withBinding(String name,
                                  String value,
                                  Locale languageTag)
```
    Bind a variable of type http://www.w3.org/1999/02/22-rdf-syntax-ns#langString with the specified language tag. Note that we call Locale.toLanguageTag() to get compliant IETF BCP 47 language tags.
    
    Parameters:
    
    name - the bound variable name
    
    value - the value as a string
    
    languageTag - the language and regional modifiers compliant with BCP-47
    
    Returns:
    
    this instance (for method chaining)
  - clearBindings
```
SPARQLQueryDefinition clearBindings()
```
    Remove all variable bindings from the child SPARQLBindings instance.
    
    Returns:
    
    this instance (for method chaining)
  - setUpdatePermissions
```
void setUpdatePermissions(GraphPermissions permissions)
```
    For use with SPARQL update, where specified permissions will apply to any records created by the update. Create a GraphPermissions builder object with the specified role and capabilities.
    
    For example:
```
    String sparqlUpdate = "INSERT DATA { <a> <b> <c> }";
    SPARQLQueryDefinition qdef = sparqlMgr.newQueryDefinition(sparqlUpdate);
    qdef.setUpdatePermissions(sparqlMgr.permission("rest-reader", Capability.UPDATE));
    sparqlMgr.executeUpdate(qdef);
```
    Parameters:
    
    permissions - the permissions (use SPARQLQueryManager.permission(java.lang.String, com.marklogic.client.semantics.Capability...) to create)
  - getUpdatePermissions
```
GraphPermissions getUpdatePermissions()
```
    Get any permissions set on this instance. This does not get any info from the database.
    
    Returns:
    
    the permissions set on this instance
  - withUpdatePermission
```
SPARQLQueryDefinition withUpdatePermission(String role,
                                           Capability capability)
```
    Calls setUpdatePermissions(com.marklogic.client.semantics.GraphPermissions) then returns this instance for method chaining.
    
    Parameters:
    
    role - the name of the role receiving these capabilities
    
    capability - the capabilities (READ, UPDATE, or EXECUTE) granted to this role
    
    Returns:
    
    this instance (for method chaining)
  - getBaseUri
```
String getBaseUri()
```
  - setBaseUri
```
void setBaseUri(String uri)
```
    set the base IRI for the query
    
    Parameters:
    
    uri - the base uri
  - getDefaultGraphUris
```
String[] getDefaultGraphUris()
```
  - setDefaultGraphUris
```
void setDefaultGraphUris(String... uris)
```
    Set the URI of the graph or graphs to use as the default graph. Use with SPARQL query only. If this parameter is used with SPARQL Update, it will cause an exception.
    
    Parameters:
    
    uris - the default graph uris
  - getNamedGraphUris
```
String[] getNamedGraphUris()
```
  - setNamedGraphUris
```
void setNamedGraphUris(String... uris)
```
    Set the URI of a named graph or graphs to include in the query or update operation. Use with SPARQL query only. If this parameter is used with SPARQL Update, it will cause an exception.
    
    Parameters:
    
    uris - the named graph uris
  - getUsingGraphUris
```
String[] getUsingGraphUris()
```
  - setUsingGraphUris
```
void setUsingGraphUris(String... uris)
```
    Set the URI of the graph or graphs to address as part of a SPARQL update operation. Use with SPARQL Update only. If this parameter is used with SPARQL query, it will cause an exception.
    
    Parameters:
    
    uris - the graph uris
  - getUsingNamedGraphUris
```
String[] getUsingNamedGraphUris()
```
  - setUsingNamedGraphUris
```
void setUsingNamedGraphUris(String... uris)
```
    Set the URI of a named graph or graphs to address as part of a SPARQL update operation. Use with SPARQL Update only. If this parameter is used with SPARQL query, it will cause an exception.
    
    Parameters:
    
    uris - the named graph uris
  - setConstrainingQueryDefinition
```
void setConstrainingQueryDefinition(QueryDefinition query)
```
    Set the search query used to constrain the set of documents included in the SPARQL query. Only meant to query unmanaged triples. The behavior is unspecified if used to query managed triples.
    
    Parameters:
    
    query - the constraining query
  - getConstrainingQueryDefinition
```
QueryDefinition getConstrainingQueryDefinition()
```
  - withConstrainingQuery
```
SPARQLQueryDefinition withConstrainingQuery(QueryDefinition query)
```
    Set the search query used to constrain the set of documents included in the SPARQL query. Only meant to query unmanaged triples. The behavior is unspecified if used to query managed triples.
    
    Parameters:
    
    query - the query to use to constrain
    
    Returns:
    
    this instance (for method chaining)
  - setRulesets
```
void setRulesets(SPARQLRuleset... ruleset)
```
    Set the name of rulesets to include for inferring triples. Ruleset names can be those of the built-in rulesets, or user-managed rulesets stored in the schemas database.
    
    Parameters:
    
    ruleset - the names of the rulesets to use
  - getRulesets
```
SPARQLRuleset[] getRulesets()
```
  - withRuleset
```
SPARQLQueryDefinition withRuleset(SPARQLRuleset ruleset)
```
    Set the name of rulesets to include for inferring triples. Ruleset names can be those of the built-in rulesets, or user-managed rulesets stored in the schemas database.
    
    Parameters:
    
    ruleset - the name of the ruleset to use
    
    Returns:
    
    this instance (for method chaining)
  - setIncludeDefaultRulesets
```
void setIncludeDefaultRulesets(Boolean include)
```
    Set whether to include database-default inference or not. Default is true.
    
    Parameters:
    
    include - whether to include or not
  - getIncludeDefaultRulesets
```
Boolean getIncludeDefaultRulesets()
```
  - withIncludeDefaultRulesets
```
SPARQLQueryDefinition withIncludeDefaultRulesets(Boolean include)
```
    Set whether to include database-default inference or not. Default is true.
    
    Parameters:
    
    include - whether to include or not
    
    Returns:
    
    this instance (for method chaining)
  - getOptimizeLevel
```
int getOptimizeLevel()
```
  - setOptimizeLevel
```
void setOptimizeLevel(int level)
```
    Set a number indicating how much time for the query engine to spend analyzing a query. (See sem:sparql in the server-side XQuery API docs)
    
    Parameters:
    
    level - the optimization level

Interface SPARQLQueryDefinition

Method Summary

Methods inherited from interface com.marklogic.client.query.QueryDefinition

Method Detail

setSparql

setSparql

getSparql

withSparql

withSparql

setBindings

getBindings

withBinding

withBinding

withBinding

clearBindings

setUpdatePermissions

getUpdatePermissions

withUpdatePermission

getBaseUri

setBaseUri

getDefaultGraphUris

setDefaultGraphUris

getNamedGraphUris

setNamedGraphUris

getUsingGraphUris

setUsingGraphUris

getUsingNamedGraphUris

setUsingNamedGraphUris

setConstrainingQueryDefinition

getConstrainingQueryDefinition

withConstrainingQuery

setRulesets

getRulesets

withRuleset

setIncludeDefaultRulesets

getIncludeDefaultRulesets

withIncludeDefaultRulesets

getOptimizeLevel

setOptimizeLevel