org.semanticweb.owlapi.model

Class OWLOntologyLoaderConfiguration

java.lang.Object

org.semanticweb.owlapi.model.OWLOntologyLoaderConfiguration

public final class OWLOntologyLoaderConfiguration
extends Object

A configuration object that specifies options and hints to objects that load OWLOntologies. Every OWLOntologyLoaderConfiguration is immutable. Changing a setting results in the creation of a new OWLOntologyLoaderConfiguration with that setting. For example,

 OWLOntologyLoaderConfiguration config = new OWLOntologyLoaderConfiguration();
 config = config.setLoadAnnotationAxioms(false);
 

creates an OWLOntologyLoaderConfiguration object with the load annotation axioms set to false.

Author:

Matthew Horridge, The University of Manchester, Bio-Health Informatics Group, Date: 15/12/2010

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OWLOntologyLoaderConfiguration.MissingOntologyHeaderStrategy strategies to cope with missing headers.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_LOAD_ANNOTATIONS_FLAG_VALUE default annotation value.
static OWLOntologyLoaderConfiguration.MissingOntologyHeaderStrategy	DEFAULT_MISSING_ONTOLOGY_HEADER_STRATEGY default missing ontology strategy.

Constructor Summary

Constructors

Constructor and Description
OWLOntologyLoaderConfiguration() default constructor

Method Summary

Methods

Modifier and Type	Method and Description
OWLOntologyLoaderConfiguration	addIgnoredImport(IRI ontologyDocumentIRI) Adds an ontology document IRI to the list of ontology imports that will be ignored during ontology loading.
OWLOntologyLoaderConfiguration	clearIgnoredImports() Clears all ontology document IRIs from the list of ignored ontology document IRIs.
Set<IRI>	getIgnoredImports() Gets the list of ontology document IRIs that are ignored during ontology loading if they are encountered as imported ontologies.
MissingImportHandlingStrategy	getMissingImportHandlingStrategy() Gets the strategy used for missing imports.
OWLOntologyLoaderConfiguration.MissingOntologyHeaderStrategy	getMissingOntologyHeaderStrategy()
boolean	isFollowRedirects() When loading an ontology, a parser might connect to a remote URL.
boolean	isIgnoredImport(IRI iri)
boolean	isLoadAnnotationAxioms() Determines whether or not annotation axioms (instances of OWLAnnotationAxiom) should be loaded.
boolean	isReportStackTrace()
boolean	isSilentMissingImportsHandling() Deprecated. Use getMissingImportHandlingStrategy().
boolean	isStrict()
OWLOntologyLoaderConfiguration	removeIgnoredImport(IRI ontologyDocumentIRI) Removes an ontology document IRI from the list of ontology imports that will be ignored during ontology loading.
OWLOntologyLoaderConfiguration	setFollowRedirects(boolean value)
OWLOntologyLoaderConfiguration	setLoadAnnotationAxioms(boolean b) Specifies whether or not annotation axioms (instances of OWLAnnotationAxiom) should be loaded or whether they should be discarded on loading.
OWLOntologyLoaderConfiguration	setMissingImportHandlingStrategy(MissingImportHandlingStrategy missingImportHandlingStrategy) Sets the strategy that is used for missing imports handling.
OWLOntologyLoaderConfiguration	setMissingOntologyHeaderStrategy(OWLOntologyLoaderConfiguration.MissingOntologyHeaderStrategy missingOntologyHeaderStrategy)
OWLOntologyLoaderConfiguration	setReportStackTraces(boolean b) Set the value for the report stack traces flag.
void	setSilentMissingImportsHandling(boolean b) Deprecated. Do not use because this method mutates the OWLOntologyLoaderConfiguration instance that it is called on. Use setMissingImportHandlingStrategy(MissingImportHandlingStrategy)
OWLOntologyLoaderConfiguration	setStrict(boolean strict)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LOAD_ANNOTATIONS_FLAG_VALUE

public static final boolean DEFAULT_LOAD_ANNOTATIONS_FLAG_VALUE

default annotation value.

See Also:

Constant Field Values

DEFAULT_MISSING_ONTOLOGY_HEADER_STRATEGY

public static final OWLOntologyLoaderConfiguration.MissingOntologyHeaderStrategy DEFAULT_MISSING_ONTOLOGY_HEADER_STRATEGY

default missing ontology strategy.

Constructor Detail

OWLOntologyLoaderConfiguration

public OWLOntologyLoaderConfiguration()

default constructor

Method Detail

getMissingOntologyHeaderStrategy

public OWLOntologyLoaderConfiguration.MissingOntologyHeaderStrategy getMissingOntologyHeaderStrategy()

Returns:

the ontology header strategy

setMissingOntologyHeaderStrategy

public OWLOntologyLoaderConfiguration setMissingOntologyHeaderStrategy(OWLOntologyLoaderConfiguration.MissingOntologyHeaderStrategy missingOntologyHeaderStrategy)

Parameters:

missingOntologyHeaderStrategy - new value

Returns:

a copy of this configuration object with a different strategy

setLoadAnnotationAxioms

public OWLOntologyLoaderConfiguration setLoadAnnotationAxioms(boolean b)

Specifies whether or not annotation axioms (instances of OWLAnnotationAxiom) should be loaded or whether they should be discarded on loading. By default, the loading of annotation axioms is enabled.

Parameters:

b - true if annotation axioms should be loaded, or false if annotation axioms should not be loaded and should be discarded on loading.

Returns:

An OWLOntologyLoaderConfiguration object with the option set.

isLoadAnnotationAxioms

public boolean isLoadAnnotationAxioms()

Determines whether or not annotation axioms (instances of OWLAnnotationAxiom) should be loaded. By default, the loading of annotation axioms is enabled.

Returns:

true if annotation assertions will be loaded, or false if annotation assertions will not be loaded because they will be discarded on loading.

isFollowRedirects

public boolean isFollowRedirects()

When loading an ontology, a parser might connect to a remote URL. If the remote URL is a 302 redirect and the protocol is different, e.g., http to https, the parser needs to decide whether to follow the redirect and download the ontology from an alternate source, or stop with an UnloadableOntologyError. By default this is true, meaning redirects will be followed across protocols. If set to false, redirects will be followed only within the same protocol (URLConnection limits this to five redirects).

Returns:

true if redirects should be followed when importing ontologies from remote URLs

setFollowRedirects

public OWLOntologyLoaderConfiguration setFollowRedirects(boolean value)

Parameters:

value - true if redirects should be followed across protocols, false otherwise.

Returns:

a copy of the current object with followRedirects set to the new value.

setMissingImportHandlingStrategy

public OWLOntologyLoaderConfiguration setMissingImportHandlingStrategy(MissingImportHandlingStrategy missingImportHandlingStrategy)

Sets the strategy that is used for missing imports handling. See MissingImportHandlingStrategy for the strategies and their descriptions.

Parameters:

missingImportHandlingStrategy - The strategy to be used.

Returns:

An OWLOntologyLoaderConfiguration object with the strategy set.

Since:

3.3

getMissingImportHandlingStrategy

public MissingImportHandlingStrategy getMissingImportHandlingStrategy()

Gets the strategy used for missing imports.

Returns:

The strategy. See MissingImportHandlingStrategy for the strategies and their descriptions.

Since:

3.3

setSilentMissingImportsHandling

@Deprecated
public void setSilentMissingImportsHandling(boolean b)

Deprecated. Do not use because this method mutates the OWLOntologyLoaderConfiguration instance that it is called on. Use setMissingImportHandlingStrategy(MissingImportHandlingStrategy)

Parameters:

b - new value for missing imports

Since:

3.2.4

isSilentMissingImportsHandling

@Deprecated
public boolean isSilentMissingImportsHandling()

Deprecated. Use getMissingImportHandlingStrategy().

Returns:

true if a missing import does not raise an error.

Since:

3.2.4

isStrict

public boolean isStrict()

Returns:

true if parsing should be strict

setStrict

public OWLOntologyLoaderConfiguration setStrict(boolean strict)

Parameters:

strict - new value for strict

Returns:

copy of the configuration with new strict value

isIgnoredImport

public boolean isIgnoredImport(IRI iri)

Parameters:

iri - iri to check

Returns:

true if iri should be ignored

getIgnoredImports

public Set<IRI> getIgnoredImports()

Gets the list of ontology document IRIs that are ignored during ontology loading if they are encountered as imported ontologies.

Returns:

A set of IRIs that represent ontology document IRI to be ignored during ontology loading.

addIgnoredImport

public OWLOntologyLoaderConfiguration addIgnoredImport(IRI ontologyDocumentIRI)

Adds an ontology document IRI to the list of ontology imports that will be ignored during ontology loading.

Parameters:

ontologyDocumentIRI - The ontology document IRI that will be ignored if it is encountered as an imported ontology during loading.

Returns:

An OWLOntologyLoaderConfiguration with the ignored ontology document IRI set.

removeIgnoredImport

public OWLOntologyLoaderConfiguration removeIgnoredImport(IRI ontologyDocumentIRI)

Removes an ontology document IRI from the list of ontology imports that will be ignored during ontology loading.

Parameters:

ontologyDocumentIRI - The ontology document IRI that would be ignored if it is encountered as an imported ontology during loading.

Returns:

An OWLOntologyLoaderConfiguration with the ignored ontology document IRI removed.

clearIgnoredImports

public OWLOntologyLoaderConfiguration clearIgnoredImports()

Clears all ontology document IRIs from the list of ignored ontology document IRIs.

Returns:

An OWLOntologyLoaderConfiguration with the list of ignored ontology document IRIs set to be empty.

setReportStackTraces

public OWLOntologyLoaderConfiguration setReportStackTraces(boolean b)

Set the value for the report stack traces flag. If true, parsing exceptions will have the full stack trace for the source exceptions. Default is false.

Parameters:

b - the new value for the flag

Returns:

A OWLOntologyLoaderConfiguration with the report flag set to the new value.

isReportStackTrace

public boolean isReportStackTrace()

Returns:

value for the report stack trace flag.