de.unibonn.iai.eis.luzzu.communications.resources

Class QualityResource

java.lang.Object

de.unibonn.iai.eis.luzzu.communications.resources.QualityResource

@Path(value="/")
public class QualityResource
extends Object

REST resource, providing the functionalities to assess the quality of datasets, with respect to a set of metrics of interest

Author:

slondono

Constructor Summary

Constructors

Constructor and Description
QualityResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	cancelRequest(javax.ws.rs.core.MultivaluedMap<String,String> formParams)
javax.ws.rs.core.Response	computeQuality(javax.ws.rs.core.MultivaluedMap<String,String> formParams) Initiates the calculation of a specificed set of quality metrics on the dataset with the provided URI, returns as response, a report listing the triple instances violating quality metrics
javax.ws.rs.core.Response	getFailedRequests()
javax.ws.rs.core.Response	getPendingRequests()
javax.ws.rs.core.Response	getStatisticsForRequest(javax.ws.rs.core.MultivaluedMap<String,String> formParams)
javax.ws.rs.core.Response	getSuccessfulRequests()
javax.ws.rs.core.Response	status(javax.ws.rs.core.MultivaluedMap<String,String> formParams)

Methods inherited from class java.lang.Object

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

Constructor Detail

QualityResource

public QualityResource()

Method Detail

getStatisticsForRequest

@POST
 @Path(value="getStatisticsForRequest")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getStatisticsForRequest(javax.ws.rs.core.MultivaluedMap<String,String> formParams)

cancelRequest

@POST
 @Path(value="cancelRequest")
 @Produces(value="application/json")
public javax.ws.rs.core.Response cancelRequest(javax.ws.rs.core.MultivaluedMap<String,String> formParams)

getPendingRequests

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

getSuccessfulRequests

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

getFailedRequests

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

status

@POST
 @Path(value="status")
 @Produces(value="application/json")
public javax.ws.rs.core.Response status(javax.ws.rs.core.MultivaluedMap<String,String> formParams)

computeQuality

@POST
 @Path(value="compute_quality")
 @Produces(value="application/json")
public javax.ws.rs.core.Response computeQuality(javax.ws.rs.core.MultivaluedMap<String,String> formParams)

Initiates the calculation of a specificed set of quality metrics on the dataset with the provided URI, returns as response, a report listing the triple instances violating quality metrics

Parameters:

formParams - parameters for the calculation: Dataset = URI of the dataset to evaluate (a URI should be encoded to avoid unsafe ASCII characters such as '&'), QualityReportRequired = boolean, should a quality report be generated?, MetricsConfiguration = JSON-LD specifying the metrics to be calculated (refer to documentation for details) BaseUri = (Optional) define a base URI to the dataset when dataset dumps are split into more than one file/location

Returns:

quality report in JSON-LD format, if parameter QualityReportRequired was true, otherwise, the dataset URI (refer to documentation for details)