GeoSPARQL Fuseki

This project has been incorporated as a module of the Apache Jena project and is no longer maintained. Go to the Apache Jena project for the latest version and documentation, see https://jena.apache.org/documentation/geosparql/

This application provides a HTTP server compliant with the GeoSPARQL standard. It uses the embedded server Fuseki from Apache Jena and provides additional parameters for dataset loading.

The project uses the GeoSPARQL implementation from the GeoSPARQL Jena project (https://github.com/galbiston/geosparql-jena). Currently, there is no GUI interface as provided in the Fuseki distribution.

A subset of the EPSG spatial/coordinate reference systems are included by default from the Apache SIS project (http://sis.apache.org). The full EPSG dataset is not distributed due to the the EPSG terms of use being incompatible with the Apache Licence. Several options are available to include the EPSG dataset by setting the SIS_DATA environment variable (http://sis.apache.org/epsg.html).

It is expected that at least one Geometry Literal or Geo Predicate is present in a dataset. A spatial index is created and new data cannot be added to the index once built. The spatial index can optionally be stored for future usage and needs to removed from a TDB folder if the index is to rebuilt.

Getting Started

GeoSPARQL Fuskei can be accessed as an embedded server using Maven etc. from Maven Central or run from the command line. SPARQL queries directly on Jena Datasets and Models can be done using the GeoSPARQL Jena project (https://github.com/galbiston/geosparql-jena).

<dependency>
    <groupId>io.github.galbiston</groupId>
    <artifactId>geosparql-fuseki</artifactId>
    <version>1.1.2</version>
</dependency>

Command Line

Run from the command line (see releases tab) and send queries over HTTP.

Get Started Example: .\geosparql-fuseki.bat -rf "geosparql_test.rdf>xml" -i

The example file geosparql_test.rdf in the GitHub repository contains several geometries in geodectic WGS84 (EPSG:4326). The example file geosparql_test_27700.rdf is identical but in the projected OSGB36 (EPSG:27770) used in the United Kingdom. Both will return the same results as GeoSPARQL treats all SRS as being projected. RDFS inferencing is applied using the GeoSPARQL schema to infer additional relationships (which aren't asserted in the example files) that are used in the spatial operations and data retrieval.

Examples:

• Load RDF file (XML format) into memory and run server: .\geosparql-fuseki.bat -rf "test.rdf>xml"

• Load RDF file (TTL format: default) into memory, apply GeoSPARQL schema with RDFS inferencing and run server: .\geosparql-fuseki.bat -rf "test.rdf" -i

• Load RDF file into memory, write spatial index to file and run server: .\geosparql-fuseki.bat -rf "test.rdf" -si "spatial.index"

• Load RDF file into persistent TDB and run server: .\geosparql-fuseki.bat -rf "test.rdf>xml" -t ".\TestTDB"

• Load from persistent TDB and run server: .\geosparql-fuseki.bat -t ".\TestTDB"

• Load from persistent TDB, change port and run server: .\geosparql-fuseki.bat -t ".\TestTDB" -p 3030

See rdf-tables in Output Formats/Serialisations for supported RDF format keywords.

N.B. Windows Powershell will strip quotation pairs from arguments and so triple quotation pairs may be required, e.g. """test.rdf>xml""". Otherwise, logging output will be sent to a file called "xml". Also, "The input line is too long" error can mean the path to the .bat exceeds the character limit and needs shortening.

Embedded Server

Run within a Java application to provide GeoSPARQL support over HTTP to other applications:

GeosparqlServer server = new GeosparqlServer(portNumber, datasetName, isLoopbackOnly, dataset, isUpdate);

See GeoSPARQL Jena project (https://github.com/galbiston/geosparql-jena) for direct querying within a Java application without using HTTP.

SPARQL Query Example

Once the default server is running it can be queried using Apache Jena as follows:

String service = "http://localhost:3030/ds";
String query = ....;
try (QueryExecution qe = QueryExecutionFactory.sparqlService(service, query)) {
    ResultSet rs = qe.execSelect();
    ResultSetFormatter.outputAsTSV(rs);
}

The server will respond to any valid SPARQL HTTP so an alternative SPARQL framework can be used. More information on SPARQL querying using Apache Jena can be found on their website (https://jena.apache.org/tutorials/sparql.html). If you are using Apache Jena for queries within the same application as the server then you probably need to be using the GeoSPARQL Jena project (https://github.com/galbiston/geosparql-jena).

SIS_DATA Environment Variable

The Apache SIS library is used to support the recognition and transformation of Coordinate/Spatial Reference Systems. These Reference Systems are published as the EPSG dataset. The full EPSG dataset is not distributed due to the EPSG terms of use being incompatible with the Apache Licence. A subset of the EPSG spatial/coordinate reference systems are included by default but the wider dataset may be required. Several options are available to include the EPSG dataset by setting the SIS_DATA environment variable (http://sis.apache.org/epsg.html).

An embedded EPSG dataset can be included in an application by adding the following dependency:

• Gradle dependency in build.gradle

ext.sisVersion = "0.8"
implementation "org.apache.sis.non-free:sis-embedded-data:$sisVersion"

• Maven dependency in pom.xml

<dependency>
    <groupId>org.apache.sis.non-free</groupId>
    <artifactId>sis-embedded-data</artifactId>
    <version>0.8</version>
</dependency>

GeoSPARQL Schema and Inferencing

There is an assumption that datasets apply the GeoSPARQL schema and the inferred relationships this entails. This is necessary generally as well as when utilising query rewrite.

If not using inferencing, through choice or when updating data, then it is necessary to assert these relationships. Therefore, Feature and Geometry class relationships must be asserted along with their parent class SpatialObject. If using asWKT or asGML then hasSerialization relationship is also required.

    <http://example.org/Geometry#LineStringA> a geo:Geometry ;
            a geo:SpatialObject ;
            geo:asWKT \"LINESTRING(0 0, 10 10)\"^^<http://www.opengis.net/ont/geosparql#wktLiteral> ;
            geo:hasSerialization \"LINESTRING(0 0, 10 10)\"^^<http://www.opengis.net/ont/geosparql#wktLiteral> .

These relationships can be automatically inferred by using the -i option when the server is started.

Command Line Arguments

Boolean options that have false defaults only require "--option" to make true in release v1.0.7 or later. Release v1.0.6 and earlier use the form "--option true".

1) Port

--port, -p

The port number of the server. Default: 3030

2) Dataset name

--dataset, -d

The name of the dataset used in the URL. Default: ds

3) Loopback only

--loopback, -l

The server only accepts local host loopback requests. Default: true

4) SPARQL update allowed

--update, -u

The server accepts updates to modify the dataset. Inferencing and spatial indexing will not be applied until the server is restarted. Default: false

5) TDB folder

--tdb, -t

An existing or new TDB folder used for the dataset. Default set to memory dataset. If accessing a dataset for the first time with GeoSPARQL then consider the --inference, --default_geometry and --validate options. These operations may add additional statements to the dataset.

6) Load RDF file into dataset

--rdf_file, -rf

Comma separated list of [RDF file path#graph name&RDF format] to load into dataset. Graph name is optional and will use default graph. RDF format is optional (default: ttl) or select from one of the following: json-ld, json-rdf, nt, nq, thrift, trig, trix, ttl, ttl-pretty, xml, xml-plain, xml-pretty. e.g. test.rdf#test&xml,test2.rdf will load test.rdf file into test graph as RDF/XML and test2.rdf into default graph as TTL.

Consider the --inference, --default_geometry and --validate options. These operations may add additional statements to the dataset.

7) Load Tabular file into dataset

--tabular_file, -tf

Comma separated list of [Tabular file path#graph name|delimiter] to load into dataset. See RDF Tables for table formatting. Graph name is optional and will use default graph. Column delimiter is optional and will default to COMMA. Any character except ':', '^' and '|'. Keywords TAB, SPACE and COMMA are also supported. e.g. test.rdf#test|TAB,test2.rdf will load test.rdf file into test graph as TAB delimited and test2.rdf into default graph as COMMA delimited.

See RDF Tables project (https://github.com/galbiston/rdf-tables) for more details on tabular format.

Consider the --inference, --default_geometry and --validate options. These operations may add additional statements to the dataset.

8) GeoSPARQL RDFS inference

--inference, -i

Enable GeoSPARQL RDFS schema and inferencing (class and property hierarchy). Inferences will be applied to the dataset. Updates to dataset may require server restart. Default: false

9) Apply hasDefaultGeometry

--default_geometry, -dg

Apply hasDefaultGeometry to single Feature hasGeometry Geometry statements. Additional properties will be added to the dataset. Default: false

10) Validate Geometry Literals

--validate, -v

Validate that the Geometry Literals in the dataset are valid. Default: false

11) Convert Geo predicates

--convert_geo, -c

Convert Geo predicates in the data to Geometry with WKT WGS84 Point GeometryLiteral. Default: false

12) Remove Geo predicates

--remove_geo, -rg

Remove Geo predicates in the data after combining to Geometry.

13) Query Rewrite enabled

--rewrite, -r

Enable query rewrite extension of GeoSPARQL standard to simplify queries, which relies upon the 'hasDefaultGeometry' property. The 'default_geometry' may be useful for adding the 'hasDefaultGeometry' to a dataset. Default: true

14) Indexing enabled

--index, -x

Enable caching of re-usable data to improve query performance. Default: true See GeoSPARQL Jena project (https://github.com/galbiston/geosparql-jena) for more details.

15) Index sizes

--index_sizes, -xs

List of Index item sizes: [Geometry Literal, Geometry Transform, Query Rewrite]. Unlimited: -1, Off: 0 Unlimited: -1, Off: 0, Default: -1,-1,-1

16) Index expiries

--index_expiry, -xe

List of Index item expiry in milliseconds: [Geometry Literal, Geometry Transform, Query Rewrite]. Off: 0, Minimum: 1001, Default: 5000,5000,5000

17) Spatial Index file

--spatial_index, -si

File to load or store the spatial index. Default to "spatial.index" in TDB folder if using TDB and not set. Otherwise spatial index is not stored.

18) Properties File

Supply the above parameters as a file:

$ java Main @/tmp/parameters

Future Work

• GUI to assist users when querying a dataset.