org.apache.marmotta.platform.sparql.api.sparql

Interface SparqlService

All Known Implementing Classes:

SparqlServiceImpl

public interface SparqlService

Add file description here!

User: sschaffe

Method Summary

Methods

Modifier and Type	Method and Description
boolean	ask(org.openrdf.query.QueryLanguage queryLanguage, String query) Evaluate a SPARQL ASK query on the KiWi TripleStore see http://www.w3.org/TR/sparql11-query/
void	createServiceDescription(org.openrdf.rio.RDFWriter writer, String string, boolean isUpdate) Write a SparqlServiceDescription of the Service to the provided RDFWriter.
QueryType	getQueryType(org.openrdf.query.QueryLanguage language, String query) Parse and return the concrete query type
org.openrdf.query.Query	parseQuery(org.openrdf.query.QueryLanguage language, String query) Parse query
List<Map<String,org.openrdf.model.Value>>	query(org.openrdf.query.QueryLanguage queryLanguage, String query) Evaluate a SPARQL query on the KiWi TripleStore.
void	query(org.openrdf.query.QueryLanguage language, String query, OutputStream output, String format, int timeoutInSeconds) Evaluate a SPARQL query on the KiWi TripleStore.
void	query(org.openrdf.query.QueryLanguage queryLanguage, String query, org.openrdf.query.resultio.QueryResultWriter writer, int timeoutInSeconds) Deprecated. Use query(QueryLanguage, String, OutputStream, String, int) instead
void	query(org.openrdf.query.QueryLanguage queryLanguage, String query, org.openrdf.query.resultio.TupleQueryResultWriter tupleWriter, org.openrdf.query.resultio.BooleanQueryResultWriter booleanWriter, SPARQLGraphResultWriter graphWriter, int timeoutInSeconds) Deprecated. Use query(QueryLanguage, String, OutputStream, String, int) instead
void	update(org.openrdf.query.QueryLanguage queryLanguage, String query) Execute a SPARQL update on the KiWi TripleStore.

Method Detail

parseQuery

org.openrdf.query.Query parseQuery(org.openrdf.query.QueryLanguage language,
                                 String query)
                                   throws org.openrdf.repository.RepositoryException,
                                          org.openrdf.query.MalformedQueryException

Parse query

Parameters:

language - language

query - query

Returns:

query parsed

Throws:

org.openrdf.repository.RepositoryException

org.openrdf.query.MalformedQueryException

getQueryType

QueryType getQueryType(org.openrdf.query.QueryLanguage language,
                     String query)
                       throws org.openrdf.query.MalformedQueryException

Parse and return the concrete query type

Parameters:

language -

query -

Returns:

Throws:

org.openrdf.query.MalformedQueryException

query

void query(org.openrdf.query.QueryLanguage language,
         String query,
         OutputStream output,
         String format,
         int timeoutInSeconds)
           throws org.apache.marmotta.platform.core.exception.MarmottaException,
                  TimeoutException,
                  org.openrdf.query.MalformedQueryException

Evaluate a SPARQL query on the KiWi TripleStore. Writes the query results to the stream passed in the format requested.

Parameters:

query - query

output - strem to write

format - mimetype

timeoutInSeconds -

Throws:

org.apache.marmotta.platform.core.exception.MarmottaException

TimeoutException

org.openrdf.query.MalformedQueryException

ask

boolean ask(org.openrdf.query.QueryLanguage queryLanguage,
          String query)
            throws org.apache.marmotta.platform.core.exception.MarmottaException

Evaluate a SPARQL ASK query on the KiWi TripleStore see http://www.w3.org/TR/sparql11-query/

Parameters:

queryLanguage - the query language to use

query - the SPARQL query to evaluate in SPARQL 1.1 syntax

Throws:

org.apache.marmotta.platform.core.exception.MarmottaException - if the query evaluation fails

query

List<Map<String,org.openrdf.model.Value>> query(org.openrdf.query.QueryLanguage queryLanguage,
                                              String query)
                                                throws org.apache.marmotta.platform.core.exception.MarmottaException

Evaluate a SPARQL query on the KiWi TripleStore. Returns the results as a list of result maps, each element a KiWiNode. see http://www.w3.org/TR/sparql11-query/

Parameters:

queryLanguage - the query language to use

query - the SPARQL query to evaluate in SPARQL 1.1 syntax

Throws:

org.apache.marmotta.platform.core.exception.MarmottaException

update

void update(org.openrdf.query.QueryLanguage queryLanguage,
          String query)
            throws org.apache.marmotta.platform.core.exception.InvalidArgumentException,
                   org.apache.marmotta.platform.core.exception.MarmottaException,
                   org.openrdf.query.MalformedQueryException,
                   org.openrdf.query.UpdateExecutionException

Execute a SPARQL update on the KiWi TripleStore. Throws a KiWiException in case the update execution fails. see http://www.w3.org/TR/sparql11-update/

Parameters:

queryLanguage -

query - a string representing the update query in SPARQL Update 1.1 syntax

Throws:

Exception

org.apache.marmotta.platform.core.exception.InvalidArgumentException

org.apache.marmotta.platform.core.exception.MarmottaException

org.openrdf.query.MalformedQueryException

org.openrdf.query.UpdateExecutionException

query

@Deprecated
void query(org.openrdf.query.QueryLanguage queryLanguage,
                    String query,
                    org.openrdf.query.resultio.TupleQueryResultWriter tupleWriter,
                    org.openrdf.query.resultio.BooleanQueryResultWriter booleanWriter,
                    SPARQLGraphResultWriter graphWriter,
                    int timeoutInSeconds)
           throws org.apache.marmotta.platform.core.exception.MarmottaException,
                  org.openrdf.query.MalformedQueryException,
                  org.openrdf.query.QueryEvaluationException,
                  TimeoutException

Deprecated. Use query(QueryLanguage, String, OutputStream, String, int) instead

Evaluate a SPARQL query, writing the results on the required writer.

Parameters:

queryLanguage -

query -

tupleWriter -

booleanWriter -

graphWriter -

timeoutInSeconds -

Throws:

org.apache.marmotta.platform.core.exception.MarmottaException

org.openrdf.query.MalformedQueryException

org.openrdf.query.QueryEvaluationException

TimeoutException

query

@Deprecated
void query(org.openrdf.query.QueryLanguage queryLanguage,
                    String query,
                    org.openrdf.query.resultio.QueryResultWriter writer,
                    int timeoutInSeconds)
           throws org.apache.marmotta.platform.core.exception.MarmottaException,
                  org.openrdf.query.MalformedQueryException,
                  org.openrdf.query.QueryEvaluationException,
                  TimeoutException

Deprecated. Use query(QueryLanguage, String, OutputStream, String, int) instead

Evaluate a SPARQL query, writing the results on the writer.

Parameters:

queryLanguage -

query -

writer -

timeoutInSeconds -

Throws:

org.apache.marmotta.platform.core.exception.MarmottaException

org.openrdf.query.MalformedQueryException

org.openrdf.query.QueryEvaluationException

TimeoutException

createServiceDescription

void createServiceDescription(org.openrdf.rio.RDFWriter writer,
                            String string,
                            boolean isUpdate)
                              throws org.openrdf.rio.RDFHandlerException

Write a SparqlServiceDescription of the Service to the provided RDFWriter.

Parameters:

writer - the RDFWriter to write the description to

string - the URI of the SPARQL Endpoint

isUpdate - if the endpoint is a update or select/query endpoint

Throws:

org.openrdf.rio.RDFHandlerException

See Also:

http://www.w3.org/TR/sparql11-service-description/