AbstractAxiomLearningAlgorithm (DL-Learner Javadoc)

java.lang.Object
- org.dllearner.core.AbstractComponent
- - org.dllearner.core.AbstractAxiomLearningAlgorithm<T,S,E>

All Implemented Interfaces:: AxiomLearningAlgorithm<T>, Component, LearningAlgorithm

Direct Known Subclasses:: CELOEWrapper, DisjointClassesLearner, PatternBasedAxiomLearningAlgorithm, PropertyAxiomLearner, SimpleSubclassLearner

public abstract class AbstractAxiomLearningAlgorithm<T extends org.semanticweb.owlapi.model.OWLAxiom,S extends org.semanticweb.owlapi.model.OWLObject,E extends org.semanticweb.owlapi.model.OWLEntity>
extends AbstractComponent
implements AxiomLearningAlgorithm<T>

Author:: Lorenz BÃ¼hmann, Jens Lehmann

Constructor Summary

Constructors
Constructor and Description

AbstractAxiomLearningAlgorithm()

Constructors
Constructor and Description
`AbstractAxiomLearningAlgorithm()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFilterNamespace(String namespace)`
`void`	`explainScore(EvaluatedAxiom<T> evAxiom)`
`org.semanticweb.owlapi.model.AxiomType<T>`	`getAxiomType()`
`EvaluatedAxiom<T>`	`getBestEvaluatedAxiom()`
`List<T>`	`getCurrentlyBestAxioms()`
`List<T>`	`getCurrentlyBestAxioms(double accuracyThreshold)`
`List<T>`	`getCurrentlyBestAxioms(int nrOfAxioms)`
`List<T>`	`getCurrentlyBestAxioms(int nrOfAxioms, double accuracyThreshold)`
`EvaluatedAxiom<T>`	`getCurrentlyBestEvaluatedAxiom()`
`List<EvaluatedAxiom<T>>`	`getCurrentlyBestEvaluatedAxioms()`
`List<EvaluatedAxiom<T>>`	`getCurrentlyBestEvaluatedAxioms(double accuracyThreshold)`
`List<EvaluatedAxiom<T>>`	`getCurrentlyBestEvaluatedAxioms(int nrOfAxioms)`
`List<EvaluatedAxiom<T>>`	`getCurrentlyBestEvaluatedAxioms(int nrOfAxioms, double accuracyThreshold)`
`E`	`getEntityToDescribe()`
`long`	`getEvaluatedFramentSize()`
`LearningProblem`	`getLearningProblem()` Get underlying learning problem.
`int`	`getMaxExecutionTimeInSeconds()`
`int`	`getMaxFetchedRows()`
`Set<S>`	`getNegativeExamples(EvaluatedAxiom<T> evAxiom)`
`Set<S>`	`getPositiveExamples(EvaluatedAxiom<T> evAxiom)`
`SPARQLReasoner`	`getReasoner()`
`void`	`init()` Method to be called after the component has been configured.
`boolean`	`isReturnOnlyNewAxioms()`
`boolean`	`isTimeout()`
`boolean`	`isUseSampling()`
`static <E> void`	`printSubset(Collection<E> collection, int maxSize)`
`void`	`setEntityToDescribe(E entityToDescribe)`
`void`	`setForceSPARQL_1_0_Mode(boolean forceSPARQL_1_0_Mode)`
`void`	`setKs(SparqlEndpointKS ks)`
`void`	`setLearningProblem(LearningProblem learningProblem)` Set the learning problem, which the algorithm should solve.
`void`	`setMaxExecutionTimeInSeconds(int maxExecutionTimeInSeconds)`
`void`	`setMaxFetchedRows(int maxFetchedRows)`
`void`	`setProgressMonitor(AxiomLearningProgressMonitor progressMonitor)`
`void`	`setQueryExecutionFactory(org.aksw.jena_sparql_api.core.QueryExecutionFactory qef)`
`void`	`setReasoner(SPARQLReasoner reasoner)`
`void`	`setReturnOnlyNewAxioms(boolean returnOnlyNewAxioms)`
`void`	`setUseSampling(boolean useSampling)`
`void`	`start()` Starts the algorithm.
`boolean`	`wasTimeout()`

Methods inherited from class org.dllearner.core.AbstractComponent
isInitialized

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractAxiomLearningAlgorithm
```
public AbstractAxiomLearningAlgorithm()
```
- Method Detail
  - setQueryExecutionFactory
```
public void setQueryExecutionFactory(org.aksw.jena_sparql_api.core.QueryExecutionFactory qef)
```
  - getLearningProblem
```
public LearningProblem getLearningProblem()
```
    Description copied from interface: LearningAlgorithm
    
    Get underlying learning problem.
    
    Specified by:
    
    getLearningProblem in interface LearningAlgorithm
    
    Returns:
    
    Underlying learning problem.
  - setLearningProblem
```
@Autowired
public void setLearningProblem(LearningProblem learningProblem)
```
    Description copied from interface: LearningAlgorithm
    
    Set the learning problem, which the algorithm should solve.
    
    Specified by:
    
    setLearningProblem in interface LearningAlgorithm
    
    Parameters:
    
    learningProblem - The learning problem to solve.
  - setEntityToDescribe
```
public void setEntityToDescribe(E entityToDescribe)
```
    Parameters:
    
    entityToDescribe - the entity for which axioms will be computed
  - getEntityToDescribe
```
public E getEntityToDescribe()
```
    Returns:
    
    the entity for which axioms will be computed
  - setUseSampling
```
public void setUseSampling(boolean useSampling)
```
  - isUseSampling
```
public boolean isUseSampling()
```
  - getAxiomType
```
public org.semanticweb.owlapi.model.AxiomType<T> getAxiomType()
```
    Returns:
    
    the axiomType
  - getMaxExecutionTimeInSeconds
```
public int getMaxExecutionTimeInSeconds()
```
  - setMaxExecutionTimeInSeconds
```
public void setMaxExecutionTimeInSeconds(int maxExecutionTimeInSeconds)
```
  - getReasoner
```
public SPARQLReasoner getReasoner()
```
  - setReasoner
```
public void setReasoner(SPARQLReasoner reasoner)
```
  - isReturnOnlyNewAxioms
```
public boolean isReturnOnlyNewAxioms()
```
  - setReturnOnlyNewAxioms
```
public void setReturnOnlyNewAxioms(boolean returnOnlyNewAxioms)
```
  - getMaxFetchedRows
```
public int getMaxFetchedRows()
```
  - setMaxFetchedRows
```
public void setMaxFetchedRows(int maxFetchedRows)
```
  - setForceSPARQL_1_0_Mode
```
public void setForceSPARQL_1_0_Mode(boolean forceSPARQL_1_0_Mode)
```
  - start
```
public void start()
```
    Description copied from interface: LearningAlgorithm
    
    Starts the algorithm. It runs until paused, stopped, or a termination criterion has been reached.
    
    Specified by:
    
    start in interface LearningAlgorithm
  - setProgressMonitor
```
public void setProgressMonitor(AxiomLearningProgressMonitor progressMonitor)
```
    Parameters:
    
    progressMonitor - the progressMonitor to set
  - init
```
public void init()
          throws ComponentInitException
```
    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.
    
    Specified by:
    
    init in interface Component
    
    Throws:
    
    ComponentInitException - This exception is thrown if any exceptions occur within the initialisation process of this component. As component developer, you are encouraged to re-throw occurring exception as ComponentInitException and giving an error message as well as the actually exception by using the constructor ComponentInitException(String, Throwable).
  - getCurrentlyBestAxioms
```
public List<T> getCurrentlyBestAxioms()
```
    Specified by:
    
    getCurrentlyBestAxioms in interface AxiomLearningAlgorithm<T extends org.semanticweb.owlapi.model.OWLAxiom>
    
    Returns:
    
    The best axioms found by the learning algorithm so far.
  - getCurrentlyBestAxioms
```
public List<T> getCurrentlyBestAxioms(int nrOfAxioms)
```
    Specified by:
    
    getCurrentlyBestAxioms in interface AxiomLearningAlgorithm<T extends org.semanticweb.owlapi.model.OWLAxiom>
    
    Parameters:
    
    nrOfAxioms - Limit for the number or returned axioms.
    
    Returns:
    
    The best axioms found by the learning algorithm so far.
  - wasTimeout
```
public boolean wasTimeout()
```
  - isTimeout
```
public boolean isTimeout()
```
  - getCurrentlyBestAxioms
```
public List<T> getCurrentlyBestAxioms(int nrOfAxioms,
                                      double accuracyThreshold)
```
  - getCurrentlyBestAxioms
```
public List<T> getCurrentlyBestAxioms(double accuracyThreshold)
```
  - getCurrentlyBestEvaluatedAxiom
```
public EvaluatedAxiom<T> getCurrentlyBestEvaluatedAxiom()
```
  - getCurrentlyBestEvaluatedAxioms
```
public List<EvaluatedAxiom<T>> getCurrentlyBestEvaluatedAxioms()
```
    Specified by:
    
    getCurrentlyBestEvaluatedAxioms in interface AxiomLearningAlgorithm<T extends org.semanticweb.owlapi.model.OWLAxiom>
    
    Returns:
    
    The best evaluated axioms found by the learning algorithm so far.
  - getCurrentlyBestEvaluatedAxioms
```
public List<EvaluatedAxiom<T>> getCurrentlyBestEvaluatedAxioms(int nrOfAxioms)
```
    Specified by:
    
    getCurrentlyBestEvaluatedAxioms in interface AxiomLearningAlgorithm<T extends org.semanticweb.owlapi.model.OWLAxiom>
    
    Parameters:
    
    nrOfAxioms - Limit for the number or returned evaluated axioms.
    
    Returns:
    
    The best evaluated axioms found by the learning algorithm so far.
  - getCurrentlyBestEvaluatedAxioms
```
public List<EvaluatedAxiom<T>> getCurrentlyBestEvaluatedAxioms(double accuracyThreshold)
```
  - getCurrentlyBestEvaluatedAxioms
```
public List<EvaluatedAxiom<T>> getCurrentlyBestEvaluatedAxioms(int nrOfAxioms,
                                                               double accuracyThreshold)
```
    Specified by:
    
    getCurrentlyBestEvaluatedAxioms in interface AxiomLearningAlgorithm<T extends org.semanticweb.owlapi.model.OWLAxiom>
  - getBestEvaluatedAxiom
```
public EvaluatedAxiom<T> getBestEvaluatedAxiom()
```
  - addFilterNamespace
```
public void addFilterNamespace(String namespace)
```
  - getPositiveExamples
```
public Set<S> getPositiveExamples(EvaluatedAxiom<T> evAxiom)
```
  - getNegativeExamples
```
public Set<S> getNegativeExamples(EvaluatedAxiom<T> evAxiom)
```
  - explainScore
```
public void explainScore(EvaluatedAxiom<T> evAxiom)
```
  - getEvaluatedFramentSize
```
public long getEvaluatedFramentSize()
```
  - printSubset
```
public static <E> void printSubset(Collection<E> collection,
                                   int maxSize)
```
  - setKs
```
@Autowired
public void setKs(SparqlEndpointKS ks)
```

Class AbstractAxiomLearningAlgorithm<T extends org.semanticweb.owlapi.model.OWLAxiom,S extends org.semanticweb.owlapi.model.OWLObject,E extends org.semanticweb.owlapi.model.OWLEntity>

Constructor Summary

Method Summary

Methods inherited from class org.dllearner.core.AbstractComponent

Methods inherited from class java.lang.Object

Constructor Detail

AbstractAxiomLearningAlgorithm

Method Detail

setQueryExecutionFactory

getLearningProblem

setLearningProblem

setEntityToDescribe

getEntityToDescribe

setUseSampling

isUseSampling

getAxiomType

getMaxExecutionTimeInSeconds

setMaxExecutionTimeInSeconds

getReasoner

setReasoner

isReturnOnlyNewAxioms

setReturnOnlyNewAxioms

getMaxFetchedRows

setMaxFetchedRows

setForceSPARQL_1_0_Mode

start

setProgressMonitor

init

getCurrentlyBestAxioms

getCurrentlyBestAxioms

wasTimeout

isTimeout

getCurrentlyBestAxioms

getCurrentlyBestAxioms

getCurrentlyBestEvaluatedAxiom

getCurrentlyBestEvaluatedAxioms

getCurrentlyBestEvaluatedAxioms

getCurrentlyBestEvaluatedAxioms

getCurrentlyBestEvaluatedAxioms

getBestEvaluatedAxiom

addFilterNamespace

getPositiveExamples

getNegativeExamples

explainScore

getEvaluatedFramentSize

printSubset

setKs