org.apache.marmotta.platform.ldpath.webservices

Class LDPathWebService

java.lang.Object

org.apache.marmotta.platform.ldpath.webservices.LDPathWebService

@ApplicationScoped
@Path(value="/ldpath")
public class LDPathWebService
extends Object

Execute LDPath queries against the LMF backend. Depending on the LMF configuration, this might trigger retrieval of external Linked Data resources before returning results.

Author: Sebastian Schaffert

Constructor Summary

Constructors

Constructor and Description
LDPathWebService()

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	evaluatePathQuery(String path, String resourceUri) Evaluate a single LDPath selection using the path passed as argument and starting at the resource identified by the uri.
javax.ws.rs.core.Response	evaluateProgramQuery(InputStream body, String resourceUri) Evaluate a LDPath program using the program string passed as argument and starting at the resource identified by the uri.
javax.ws.rs.core.Response	evaluateProgramQuery(String program, String resourceUri) Evaluate a LDPath program using the program string passed as argument and starting at the resource identified by the uri.
javax.ws.rs.core.Response	getFunction(String name) Return a description of the function whose name is passed as path argument.
javax.ws.rs.core.Response	listFunctions() Return a list of all LDPath functions that have been registered in the LDPath installation.
javax.ws.rs.core.Response	testProgram(String[] contextURI, String[] contextURIarr, javax.servlet.http.HttpServletRequest request) Evaluate the LDPath program send as byte stream in the POST body of the request starting at the contexts (array) given as URL query arguments.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LDPathWebService

public LDPathWebService()

Method Detail

evaluatePathQuery

@GET
@Path(value="/path")
@Produces(value="application/json")
public javax.ws.rs.core.Response evaluatePathQuery(@QueryParam(value="path")
                                                            String path,
                                                            @QueryParam(value="uri")
                                                            String resourceUri)

Evaluate a single LDPath selection using the path passed as argument and starting at the resource identified by the uri. Returns a list of RDF Nodes using the same syntax as RDF/JSON, i.e.

• { "type": "uri", "value": "..." } for resources
• { "type": "literal", "value": "...", "language": "...", "datatype": "..."} for literals (datatype and language optional)

Parameters:

path - the LDPath expression to evaluate

resourceUri - the URI of the resource from which to start the resource

Returns:

a list of RDF Nodes using the same syntax as RDF/JSON

HTTP Status Codes

404 in case the resource with the given URI does not exist, 400 in case the path could not be parsed or the resource is not a valid URI, 200 in case the query was evaluated successfully

evaluateProgramQuery

@GET
@Path(value="/program")
@Produces(value="application/json")
public javax.ws.rs.core.Response evaluateProgramQuery(@QueryParam(value="program")
                                                               String program,
                                                               @QueryParam(value="uri")
                                                               String resourceUri)

Evaluate a LDPath program using the program string passed as argument and starting at the resource identified by the uri. Returns a map from field names to lists of RDF nodes using the same syntax as RDF/JSON, i.e.

• { "type": "uri", "value": "..." } for resources
• { "type": "literal", "value": "...", "language": "...", "datatype": "..."} for literals (datatype and language optional)

Parameters:

program - the program to evaluate

resourceUri - the URI of the resource where to start

Returns:

a map from field names to lists of rdf nodes in rdf/json format

HTTP Status Codes

404 in case the resource with the given URI does not exist, 400 in case the path could not be parsed or the resource is not a valid URI, 200 in case the query was evaluated successfully

evaluateProgramQuery

@POST
@Path(value="/program")
@Produces(value="application/json")
public javax.ws.rs.core.Response evaluateProgramQuery(InputStream body,
                                                                @QueryParam(value="uri")
                                                                String resourceUri)

Evaluate a LDPath program using the program string passed as argument and starting at the resource identified by the uri. Returns a map from field names to lists of RDF nodes using the same syntax as RDF/JSON, i.e.

• { "type": "uri", "value": "..." } for resources
• { "type": "literal", "value": "...", "language": "...", "datatype": "..."} for literals (datatype and language optional)

Parameters:

body - the program to evaluate

resourceUri - the URI of the resource where to start

Returns:

a map from field names to lists of rdf nodes in rdf/json format

HTTP Status Codes

404 in case the resource with the given URI does not exist, 400 in case the path could not be parsed or the resource is not a valid URI, 200 in case the query was evaluated successfully

listFunctions

@GET
@Path(value="/functions")
@Produces(value="application/json")
public javax.ws.rs.core.Response listFunctions()

Return a list of all LDPath functions that have been registered in the LDPath installation.

Returns:

a list of JSON maps with the fields "name", "signature" and "description"

HTTP Status Codes

200 in case the functions exist; will return the function descriptions, 500 in case there was an error accessing the triple store

getFunction

@GET
@Path(value="/functions/{name}")
@Produces(value="application/json")
public javax.ws.rs.core.Response getFunction(@PathParam(value="name")
                                                      String name)

Return a description of the function whose name is passed as path argument.

Returns:

a JSON map with the fields "name", "signature" and "description"

HTTP Status Codes

200 in case the function exists; will return the function description, 404 in case the function does not exist, 500 in case there was an error accessing the triple store

testProgram

@POST
@Path(value="/debug")
@Produces(value="application/json")
public javax.ws.rs.core.Response testProgram(@QueryParam(value="context")
                                                       String[] contextURI,
                                                       @QueryParam(value="context[]")
                                                       String[] contextURIarr,
                                                       @Context
                                                       javax.servlet.http.HttpServletRequest request)

Evaluate the LDPath program send as byte stream in the POST body of the request starting at the contexts (array) given as URL query arguments. Will return a JSON map with an entry for each context and its evaluation result. The value of each entry will have the following format:

• { "type": "uri", "value": "..." } for resources
• { "type": "literal", "value": "...", "language": "...", "datatype": "..."} for literals (datatype and language optional)

Parameters:

contextURI - the URI of a single context to evaluate the program against

contextURIarr - an array of URIs to use as contexts to evaluate the program against

request - a POST request containing the LDPath program in the POST body

Returns:

a JSON map with an entry for each context pointing to its evaluation result (another map with field/value pairs)

HTTP Status Codes

200 in case the evaluation was successful for all contexts, 400 in case the LDPath program was invalid, 404 in case one of the contexts passed as argument does not exist, 500 in case there was an error accessing the repository or reading the POST body