org.apache.marmotta.ldclient.provider.xml

Class AbstractXMLDataProvider

java.lang.Object

org.apache.marmotta.ldclient.services.provider.AbstractHttpProvider

org.apache.marmotta.ldclient.provider.xml.AbstractXMLDataProvider

All Implemented Interfaces:

DataProvider

public abstract class AbstractXMLDataProvider
extends AbstractHttpProvider

Abstract implementation of a data provider based on XML documents. Implementing classes need to provide a mapping table mapping from RDF property URIs to XPath Value Mappers that are evaluated on the XML document (getXPathMappings method), as well as a list of URIs used as types for the created resource.

Author: Sebastian Schaffert

Field Summary

Fields inherited from class org.apache.marmotta.ldclient.services.provider.AbstractHttpProvider

RETRY_AFTER

Constructor Summary

Constructors

Constructor and Description
AbstractXMLDataProvider()

Method Summary

Methods

Modifier and Type	Method and Description
protected Map<String,String>	getNamespaceMappings() Provide namespace mappings for the XPath expressions from namespace prefix to namespace URI.
protected abstract List<String>	getTypes(org.openrdf.model.URI resource) Return a list of URIs that should be added as types for each processed resource.
protected abstract Map<String,XPathValueMapper>	getXPathMappings(String requestUrl) Return a mapping table mapping from RDF properties to XPath Value Mappers.
List<String>	parseResponse(String resource, String requestUrl, org.openrdf.model.Model triples, InputStream in, String contentType) Parse the HTTP response entity returned by the web service call and return its contents as a Sesame RDF repository.

Methods inherited from class org.apache.marmotta.ldclient.services.provider.AbstractHttpProvider

buildRequestUrl, isValidContentType, retrieveResource

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.marmotta.ldclient.api.provider.DataProvider

getName, listMimeTypes

Constructor Detail

AbstractXMLDataProvider

public AbstractXMLDataProvider()

Method Detail

getXPathMappings

protected abstract Map<String,XPathValueMapper> getXPathMappings(String requestUrl)

Return a mapping table mapping from RDF properties to XPath Value Mappers. Each entry in the map is evaluated in turn; in case the XPath expression yields a result, the property is added for the processed resource.

Parameters:

requestUrl -

Returns:

getTypes

protected abstract List<String> getTypes(org.openrdf.model.URI resource)

Return a list of URIs that should be added as types for each processed resource.

Parameters:

resource -

Returns:

getNamespaceMappings

protected Map<String,String> getNamespaceMappings()

Provide namespace mappings for the XPath expressions from namespace prefix to namespace URI. May be overridden by subclasses as appropriate, the default implementation returns an empty map.

Returns:

parseResponse

public List<String> parseResponse(String resource,
                         String requestUrl,
                         org.openrdf.model.Model triples,
                         InputStream in,
                         String contentType)
                           throws DataRetrievalException

Parse the HTTP response entity returned by the web service call and return its contents as a Sesame RDF repository. The content type returned by the web service is passed as argument to help the implementation decide how to parse the data.

Specified by:

parseResponse in class AbstractHttpProvider

Parameters:

resource - the subject of the data retrieval

triples -

in - input stream as returned by the remote webservice

contentType - content type as returned in the HTTP headers of the remote webservice @return an RDF repository containing an RDF representation of the dataset located at the remote resource.

Returns:

a possibly empty list of URLs of additional resources to retrieve to complete the content

Throws:

IOException - in case an error occurs while reading the input stream

DataRetrievalException