SPARQL-Generate and SPARQL-Template Java API

This document is for versions 2.x.x onward. For previous versions, check out the documentation for versions 1.x.x

sparql-generate-jena is an implementation of SPARQL-Generate and SPARQL-Template over Apache Jena. Its binaries, sources and documentation are available for download at Maven Central. To use it in your Maven project, add the following dependency declaration to your Maven project file ( *.pom file):


Parse a query as follows:

 String queryString = "........";
 SPARQLExtQuery query = (SPARQLExtQuery) QueryFactory.create(queryString, SPARQLExt.SYNTAX);

Then, use class PlanFactory to instantiate a RootPlan for that query.

RootPlan plan = PlanFactory.create(query);

Then the RootPlan can be executed multiple times against different Datasets and Documentsets.

To instantiate a Dataset, one may use:

Dataset dataset = DatasetFactory.create();

The engine fetches queries and documents on the Web if no mapping to local files is provided. Such mappings can be created using Jena’s StreamManager mechanism. The following snippet illustrates how this is achieved:

LocatorFileAccept locator = new LocatorFileAccept(new File("directory").toURI().getPath());
LocationMapperAccept mapper = new LocationMapperAccept();
mapper.addAltEntry("", "local/file/system/file1.json");
mapper.addAltEntry("", "local/file/system/file2.csv");
SPARQLExtStreamManager sm = SPARQLExtStreamManager.makeStreamManager(locator, mapper);

The StreamManager is then used to instantiate the execution Context.

// create the query execution context
Context context = SPARQLExt.createContext(sm);

Finally, call one of the exec methods to trigger the RDF generation, depending on the type of the query.

Model     output = plan.execGenerate(dataset, context);
ResultSet output = plan.execSelect  (dataset, context);
String    output = plan.execTemplate(dataset, context);

Remember: The javadoc contains comprehensive documentations and examples, and the sources contain unit tests and other examples.

Back to top

Version: 2.0-SNAPSHOT. Last Published: 2019-06-14.