org.dllearner.kb.sparql
Class SparqlKnowledgeSource

java.lang.Object
  org.dllearner.core.AbstractComponent
      org.dllearner.core.AbstractKnowledgeSource
          org.dllearner.kb.sparql.SparqlKnowledgeSource

All Implemented Interfaces:

Component, KnowledgeSource

public class SparqlKnowledgeSource
extends AbstractKnowledgeSource

Represents the SPARQL Endpoint Component.

Author:

Jens Lehmann, Sebastian Knappe, Sebastian Hellmann

Constructor Summary

SparqlKnowledgeSource()

Method Summary

void	addProgressMonitor(ProgressMonitor mon)
<T> void	applyConfigEntry(ConfigEntry<T> entry) Applies a configuration option to this component.
static Collection<ConfigOption<?>>	createConfigOptions() Specifies the configuration options for this knowledge source.
void	export(File file, OntologyFormat format) Export the knowledge source to the specified file in the specified format.
List<Node>	extractParallel()
String	getCacheDir()
SparqlKnowledgeSourceConfigurator	getConfigurator() For each component, a configurator class is generated in package org.dllearner.core.configurators using the script { org.dllearner.scripts.ConfigJavaGenerator}.
Manipulator	getManipulator()
static String	getName()
int	getNrOfExtractedAxioms()
URL	getOntologyFragmentURL()
org.semanticweb.owlapi.model.OWLOntology	getOWLAPIOntology()
SparqlEndpoint	getSparqlEndpoint()
SparqlQueryMaker	getSparqlQueryMaker()
SPARQLTasks	getSPARQLTasks()
TupleAquisitor	getTupleAquisitor()
URL	getURL()
void	init() Method to be called after the component has been configured.
boolean	isUseCache()
void	setManipulator(Manipulator m)
SparqlQuery	sparqlQuery(String query)
String	toDIG(URI kbURI) Transforms this knowledge source to DIG 1.1 code according to the specification.
KB	toKB() Transforms this knowledge source into an internal knowledge base.

Methods inherited from class java.lang.Object

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

Constructor Detail

SparqlKnowledgeSource

public SparqlKnowledgeSource()

Method Detail

getConfigurator

public SparqlKnowledgeSourceConfigurator getConfigurator()

Description copied from class: AbstractComponent

For each component, a configurator class is generated in package org.dllearner.core.configurators using the script { org.dllearner.scripts.ConfigJavaGenerator}. The configurator provides set and get methods for the configuration options of a component.

Specified by:

getConfigurator in class AbstractComponent

Returns:

the configurator for this Knowledgesource

getName

public static String getName()

createConfigOptions

public static Collection<ConfigOption<?>> createConfigOptions()

Specifies the configuration options for this knowledge source.

Returns:

Options of this component.

See Also:

AbstractComponent.createConfigOptions()

applyConfigEntry

public <T> void applyConfigEntry(ConfigEntry<T> entry)
                      throws InvalidConfigOptionValueException

Description copied from class: AbstractComponent

Applies a configuration option to this component. Implementations of components should use option and value of the config entry to perform an action (usually setting an internal variable to an appropriate value). Since the availability of configurators, it is optional for components to implement this method. Instead of using this method to take an action based on a configuration value, components can also use the getters defined in the components configurator. Important note: Never call this method directly. All calls are done via the ComponentManager.

Type Parameters:

T - Type of the config entry (Integer, String etc.).

Parameters:

entry - A configuration entry.

Throws:

InvalidConfigOptionValueException - This exception is thrown if the value of the config entry is not valid. For instance, a config option may only accept values, which are within intervals 0.1 to 0.3 or 0.5 to 0.8. If the value is outside of those intervals, an exception is thrown. Note that many of the common cases are already caught in the constructor of ConfigEntry (for instance for a DoubleConfigOption you can specify an interval for the value). This means that, as a component developer, you often do not need to implement further validity checks.

See Also:

AbstractComponent.getConfigurator()

init

public void init()

Description copied from interface: Component

Method to be called after the component has been configured. Implementation of components can overwrite this method to perform setup and initialisation tasks for this component.

extractParallel

public List<Node> extractParallel()

toDIG

public String toDIG(URI kbURI)

Description copied from class: AbstractKnowledgeSource

Transforms this knowledge source to DIG 1.1 code according to the specification. DIG is used for communicating with reasoners.

Specified by:

toDIG in class AbstractKnowledgeSource

Parameters:

kbURI - The URI which is assigned to the knowledge base. The URI is used to refer to the knowledge base in queries (DIG supports using several knowledge bases).

Returns:

The DIG XML code.

export

public void export(File file,
                   OntologyFormat format)
            throws OntologyFormatUnsupportedException

Description copied from class: AbstractKnowledgeSource

Export the knowledge source to the specified file in the specified format.

Specified by:

export in class AbstractKnowledgeSource

Parameters:

file - File to store the knowledge base.

format - Format of the knowledge base, e.g. N-Triples.

Throws:

OntologyFormatUnsupportedException - Thrown if the conversion to the specified format is not supported by this knowledge source.

getURL

public URL getURL()

Returns:

the URL of the used sparql endpoint

sparqlQuery

public SparqlQuery sparqlQuery(String query)

getSparqlEndpoint

public SparqlEndpoint getSparqlEndpoint()

getSPARQLTasks

public SPARQLTasks getSPARQLTasks()

getSparqlQueryMaker

public SparqlQueryMaker getSparqlQueryMaker()

getManipulator

public Manipulator getManipulator()

setManipulator

public void setManipulator(Manipulator m)

getTupleAquisitor

public TupleAquisitor getTupleAquisitor()

toKB

public KB toKB()

Description copied from class: AbstractKnowledgeSource

Transforms this knowledge source into an internal knowledge base.

Specified by:

toKB in class AbstractKnowledgeSource

Returns:

An internal Knowledge base or null if this knowledge source does not support a conversion to an internal knowledge base.

getOntologyFragmentURL

public URL getOntologyFragmentURL()

getOWLAPIOntology

public org.semanticweb.owlapi.model.OWLOntology getOWLAPIOntology()

isUseCache

public boolean isUseCache()

getCacheDir

public String getCacheDir()

getNrOfExtractedAxioms

public int getNrOfExtractedAxioms()

addProgressMonitor

public void addProgressMonitor(ProgressMonitor mon)