Package com.franz.agraph.repository

Class AGGraphQuery

java.lang.Object

org.eclipse.rdf4j.query.impl.AbstractOperation

org.eclipse.rdf4j.query.impl.AbstractQuery

com.franz.agraph.repository.AGQuery

com.franz.agraph.repository.AGGraphQuery

All Implemented Interfaces:

GraphQuery, Operation, Query

public class AGGraphQuery
extends AGQuery
implements GraphQuery

Implements the Sesame GraphQuery interface for AllegroGraph.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.rdf4j.query.Query

Query.QueryType

Field Summary

Fields inherited from class com.franz.agraph.repository.AGQuery

RDFS_PLUS_PLUS, RESTRICTION, SPARQL_COVERAGE_PLANNER, SPARQL_IDENTITY_PLANNER

Constructor Summary

Constructors

Constructor	Description
AGGraphQuery(AGRepositoryConnection con, QueryLanguage ql, String queryString, String baseURI)	Creates an AGGraphQuery instance for the given connection.

Method Summary

Modifier and Type	Method	Description
long	count()	Evaluates the query and returns only the number of results to the client (counting is done on the server, the results are not returned).
void	download(File file, RDFFormat format)	Evaluates the query and saves the results to a file.
void	download(String file, RDFFormat format)	Evaluates the query and saves the results to a file.
GraphQueryResult	evaluate()	Evaluates the query and returns a GraphQueryResult.
void	evaluate(RDFHandler handler)	Evaluates the query and uses handler to process the result.
InputStream	stream(RDFFormat format)	Evaluates the query and returns the result as an input stream.

Methods inherited from class com.franz.agraph.repository.AGQuery

analyze, download, download, download, download, getBaseURI, getBindingsArray, getEngine, getEntailmentRegime, getFranzOptionPrefixString, getLanguage, getLimit, getName, getOffset, getPlanner, getQueryString, hashCode, isCheckVariables, isLoggingEnabled, isPrepared, setCheckVariables, setEngine, setEntailmentRegime, setIncludeInferred, setLimit, setLoggingEnabled, setOffset, setPlanner, setPrepared, setSaveName, stream, stream, toString

Methods inherited from class org.eclipse.rdf4j.query.impl.AbstractQuery

getMaxQueryTime, setMaxQueryTime

Methods inherited from class org.eclipse.rdf4j.query.impl.AbstractOperation

clearBindings, getBindings, getDataset, getIncludeInferred, getMaxExecutionTime, removeBinding, setBinding, setDataset, setMaxExecutionTime

Methods inherited from class java.lang.Object

equals, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.rdf4j.query.Operation

clearBindings, getBindings, getDataset, getIncludeInferred, getMaxExecutionTime, removeBinding, setBinding, setDataset, setIncludeInferred, setMaxExecutionTime

Methods inherited from interface org.eclipse.rdf4j.query.Query

explain, getMaxQueryTime, setMaxQueryTime

Constructor Details

AGGraphQuery

public AGGraphQuery(AGRepositoryConnection con,
 QueryLanguage ql,
 String queryString,
 String baseURI)

Creates an AGGraphQuery instance for the given connection.

Parameters:

con - the connection

ql - the query language

queryString - the query

baseURI - the base URI for the query

Method Details

evaluate

public GraphQueryResult evaluate()
                          throws QueryEvaluationException

Evaluates the query and returns a GraphQueryResult.

Specified by:

evaluate in interface GraphQuery

Throws:

QueryEvaluationException

evaluate

public void evaluate(RDFHandler handler)
              throws QueryEvaluationException,
RDFHandlerException

Evaluates the query and uses handler to process the result.

Specified by:

evaluate in interface GraphQuery

Throws:

QueryEvaluationException

RDFHandlerException

count

public long count()
           throws QueryEvaluationException

Evaluates the query and returns only the number of results to the client (counting is done on the server, the results are not returned).

Returns:

long the number of results

Throws:

QueryEvaluationException - if an error occurs while evaluating the query

download

public void download(File file,
 RDFFormat format)
              throws QueryEvaluationException

Evaluates the query and saves the results to a file.

Parameters:

file - Output path.

format - Output format.

Throws:

QueryEvaluationException - if there is an error while evaluating query

download

public void download(String file,
 RDFFormat format)
              throws QueryEvaluationException

Evaluates the query and saves the results to a file.

Parameters:

file - Output path.

format - Output format.

Throws:

QueryEvaluationException - if there is an error while evaluating query

stream

public InputStream stream(RDFFormat format)
                   throws QueryEvaluationException

Evaluates the query and returns the result as an input stream.

Note that it is important to close the returned stream, to avoid resource leaks.

Parameters:

format - Output format.

Returns:

An input stream containing response data. The caller MUST close this stream to release connection resources.

Throws:

QueryEvaluationException - if there is an error while evaluating query