com.franz.agraph.repository

Class AGTupleQuery

java.lang.Object

org.eclipse.rdf4j.query.impl.AbstractOperation

org.eclipse.rdf4j.query.impl.AbstractQuery

com.franz.agraph.repository.AGQuery

com.franz.agraph.repository.AGTupleQuery

All Implemented Interfaces:

Operation, Query, TupleQuery

Direct Known Subclasses:

AGStreamTupleQuery

public class AGTupleQuery
extends AGQuery
implements TupleQuery

Implements the Sesame TupleQuery interface for AllegroGraph.

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 and Description
AGTupleQuery(AGRepositoryConnection con, QueryLanguage ql, String queryString, String baseURI)

Method Summary

Modifier and Type	Method and 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, TupleQueryResultFormat format) Evaluates the query and saves the results to a file.
void	download(String file, TupleQueryResultFormat format) Evaluates the query and saves the results to a file.
TupleQueryResult	evaluate()
void	evaluate(TupleQueryResultHandler handler)
InputStream	stream(TupleQueryResultFormat 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, 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, hashCode, notify, notifyAll, wait, wait, wait

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

getMaxQueryTime, setMaxQueryTime

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

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

Constructor Detail

AGTupleQuery

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

Method Detail

evaluate

public TupleQueryResult evaluate()
                          throws QueryEvaluationException

Specified by:

evaluate in interface TupleQuery

Throws:

QueryEvaluationException

evaluate

public void evaluate(TupleQueryResultHandler handler)
              throws QueryEvaluationException,
                     TupleQueryResultHandlerException

Specified by:

evaluate in interface TupleQuery

Throws:

QueryEvaluationException

TupleQueryResultHandlerException

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:

the number of results

Throws:

QueryEvaluationException - if there is an error with this request

download

public void download(File file,
                     TupleQueryResultFormat 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,
                     TupleQueryResultFormat 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(TupleQueryResultFormat 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