org.dllearner.kb
Class KBFile

java.lang.Object
  org.dllearner.core.AbstractComponent
      org.dllearner.core.AbstractKnowledgeSource
          org.dllearner.kb.KBFile

All Implemented Interfaces:

Component, KnowledgeSource

public class KBFile
extends AbstractKnowledgeSource

KB files are an internal convenience format used in DL-Learner. Their syntax is close to Description Logics and easy to use. KB files can be exported to OWL for usage outside of DL-Learner.

Author:

Jens Lehmann

Constructor Summary

KBFile()
Default constructor (needed for reflection in ComponentManager).

KBFile(KB kb)
Constructor allowing you to treat an already existing KB object as a KBFile knowledge source.

Method Summary

<T> void	applyConfigEntry(ConfigEntry<T> entry) Applies a configuration option to this component.
static Collection<ConfigOption<?>>	createConfigOptions()
void	export(File file, OntologyFormat format) Export the knowledge source to the specified file in the specified format.
KBFileConfigurator	getConfigurator() For each component, a configurator class is generated in package org.dllearner.core.configurators using the script { org.dllearner.scripts.ConfigJavaGenerator}.
static String	getName()
URL	getURL()
void	init() Method to be called after the component has been configured.
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.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

KBFile

public KBFile()

Default constructor (needed for reflection in ComponentManager).

KBFile

public KBFile(KB kb)

Constructor allowing you to treat an already existing KB object as a KBFile knowledge source. Use it sparingly, because the standard way to create components is via ComponentManager.

Parameters:

kb - A KB object.

Method Detail

getConfigurator

public KBFileConfigurator 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:

An object allowing to configure this component.

getName

public static String getName()

createConfigOptions

public static Collection<ConfigOption<?>> 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()
          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.

Throws:

ComponentInitException - This exception is thrown if any exceptions occur within the initialisation process of this component. As component developer, you are encouraged to rethrow occuring exception as ComponentInitException and giving an error message as well as the actualy exception by using the constructor ComponentInitException.ComponentInitException(String, Throwable).

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.

toString

public String toString()

Overrides:

toString in class Object

export

public void export(File file,
                   OntologyFormat format)

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.

getURL

public URL getURL()

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.