org.aksw.rdfunit.validate.ws

Class RDFUnitWebService

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.aksw.rdfunit.validate.ws.RDFUnitWebService

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

Direct Known Subclasses:

DataIDWS, ValidateWS

public abstract class RDFUnitWebService
extends javax.servlet.http.HttpServlet

Abstract RDFUnitWebService class.

Since:

6/18/14 8:52 AM

Version:

$Id: $Id

Author:

Dimitris Kontokostas A super class that can serve as an easy validation service based on RDFUnit

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RDFUnitWebService()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doGet(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse)
protected void	doPost(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse)
protected abstract RDFUnitConfiguration	getConfiguration(javax.servlet.http.HttpServletRequest httpServletRequest) Creates an RDFUnitConfiguration based on the GET/POST parameters
protected abstract TestSuite	getTestSuite(RDFUnitConfiguration configuration, TestSource testSource) Creates a TestSuite based on the RDFUnitConfiguration and the Source to be tested
void	init()
protected abstract void	printHelpMessage(javax.servlet.http.HttpServletResponse httpServletResponse) Prints a help message with the correct arguments one can use to call the service
protected void	printMessage(javax.servlet.http.HttpServletResponse httpServletResponse, String message) Help function that writes a string to the output surrounded with {@code
protected abstract com.hp.hpl.jena.rdf.model.Model	validate(RDFUnitConfiguration configuration, TestSource testSource, TestSuite testSuite) Executes the validation of a Sourse dataset against a TestSuite based on a RDFUnitConfiguration

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

RDFUnitWebService

public RDFUnitWebService()

Method Detail

init

public void init()
          throws javax.servlet.ServletException

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

doGet

protected void doGet(javax.servlet.http.HttpServletRequest httpServletRequest,
         javax.servlet.http.HttpServletResponse httpServletResponse)
              throws javax.servlet.ServletException,
                     IOException

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

doPost

protected void doPost(javax.servlet.http.HttpServletRequest httpServletRequest,
          javax.servlet.http.HttpServletResponse httpServletResponse)
               throws javax.servlet.ServletException,
                      IOException

Overrides:

doPost in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

getConfiguration

protected abstract RDFUnitConfiguration getConfiguration(javax.servlet.http.HttpServletRequest httpServletRequest)
                                                  throws ParameterException

Creates an RDFUnitConfiguration based on the GET/POST parameters

Parameters:

httpServletRequest - the HttpServletRequest

Returns:

an initialized RDFUnitConfiguration object

Throws:

ParameterException - if any.

getTestSuite

protected abstract TestSuite getTestSuite(RDFUnitConfiguration configuration,
                     TestSource testSource)

Creates a TestSuite based on the RDFUnitConfiguration and the Source to be tested

Parameters:

configuration - an RDFUnitConfiguration object generated with getConfiguration

testSource - The dataset to be tested, this is generated automatically from the RDFUnitConfiguration object

Returns:

A TestSuite (list of test cases) for running against the tested Source

validate

protected abstract com.hp.hpl.jena.rdf.model.Model validate(RDFUnitConfiguration configuration,
                                       TestSource testSource,
                                       TestSuite testSuite)
                                                     throws TestCaseExecutionException

Executes the validation of a Sourse dataset against a TestSuite based on a RDFUnitConfiguration

Parameters:

configuration - an RDFUnitConfiguration object generated with getConfiguration

testSource - The dataset to be tested, this is generated automatically from the RDFUnitConfiguration object

testSuite - a TestSuite generated with getTestSuite()

Returns:

a Model that contains the results of a validation

Throws:

TestCaseExecutionException - if any.

printHelpMessage

protected abstract void printHelpMessage(javax.servlet.http.HttpServletResponse httpServletResponse)
                                  throws IOException

Prints a help message with the correct arguments one can use to call the service

Parameters:

httpServletResponse - a HttpServletResponse object.

Throws:

IOException - if any.

printMessage

protected void printMessage(javax.servlet.http.HttpServletResponse httpServletResponse,
                String message)
                     throws IOException

Help function that writes a string to the output surrounded with <pre> </pre>

Parameters:

httpServletResponse - a HttpServletResponse object.

message - the message we want to write

Throws:

IOException - if any.