OWLOntologyLoaderConfiguration (OWLAPI :: Distribution 4.5.6 API)

java.lang.Object
- org.semanticweb.owlapi.model.OWLOntologyLoaderConfiguration

All Implemented Interfaces:

Serializable
```
public class OWLOntologyLoaderConfiguration
extends Object
implements Serializable
```
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.
Since:

3.2.0

Author:

Matthew Horridge, The University of Manchester, Bio-Health Informatics Group

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class OWLOntologyLoaderConfiguration.MissingOntologyHeaderStrategy
what action to take if the ontology header is missing.

Nested Classes
Modifier and Type	Class and Description
`static class`	`OWLOntologyLoaderConfiguration.MissingOntologyHeaderStrategy` what action to take if the ontology header is missing.

Constructor Summary

Constructors
Constructor and Description

OWLOntologyLoaderConfiguration()

Constructors
Constructor and Description
`OWLOntologyLoaderConfiguration()`

Method Summary

All Methods Instance Methods Concrete 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.
`String`	`getAuthorizationValue()`
`String`	`getBannedParsers()`
`int`	`getConnectionTimeout()`
`String`	`getEntityExpansionLimit()`
`MissingImportHandlingStrategy`	`getMissingImportHandlingStrategy()` Gets the strategy used for missing imports.
`OWLOntologyLoaderConfiguration.MissingOntologyHeaderStrategy`	`getMissingOntologyHeaderStrategy()`
`PriorityCollectionSorting`	`getPriorityCollectionSorting()`
`int`	`getRetriesToAttempt()`
`boolean`	`isAcceptingHTTPCompression()`
`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`	`isStrict()`
`boolean`	`isTreatDublinCoreAsBuiltIn()` Determines if the various parsers, for formats such as RDF based formats that do not require strong typing, should treat Dublin Core Vocabulary as built in vocabulary, so that Dublin Core metadata properties are interpreted as annotation properties.
`OWLOntologyLoaderConfiguration`	`removeIgnoredImport(IRI ontologyDocumentIRI)` Removes an ontology document IRI from the list of ontology imports that will be ignored during ontology loading.
`OWLOntologyLoaderConfiguration`	`setAcceptingHTTPCompression(boolean b)`
`OWLOntologyLoaderConfiguration`	`setAuthorizationValue(String authorizationValue)`
`OWLOntologyLoaderConfiguration`	`setBannedParsers(String ban)`
`OWLOntologyLoaderConfiguration`	`setConnectionTimeout(int l)`
`OWLOntologyLoaderConfiguration`	`setEntityExpansionLimit(String limit)`
`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`	`setPriorityCollectionSorting(PriorityCollectionSorting sorting)` Set the priorty collection sorting option.
`OWLOntologyLoaderConfiguration`	`setRepairIllegalPunnings(boolean b)`
`OWLOntologyLoaderConfiguration`	`setReportStackTraces(boolean b)` Set the value for the report stack traces flag.
`OWLOntologyLoaderConfiguration`	`setRetriesToAttempt(int retries)`
`OWLOntologyLoaderConfiguration`	`setStrict(boolean strict)`
`OWLOntologyLoaderConfiguration`	`setTreatDublinCoreAsBuiltIn(boolean value)`
`OWLOntologyLoaderConfiguration`	`setTrimToSize(boolean value)`
`boolean`	`shouldRepairIllegalPunnings()`
`boolean`	`shouldTrimToSize()`

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

- Constructor Detail
  - OWLOntologyLoaderConfiguration
```
public OWLOntologyLoaderConfiguration()
```
- Method Detail
  - 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.
  - 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.
  - removeIgnoredImport
```
@Nonnull
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.
  - setPriorityCollectionSorting
```
public OWLOntologyLoaderConfiguration setPriorityCollectionSorting(PriorityCollectionSorting sorting)
```
    Set the priorty collection sorting option.
    
    Parameters:
    
    sorting - the sorting option to be used.
    
    Returns:
    
    An OWLOntologyLoaderConfiguration with the new sorting option set.
  - getPriorityCollectionSorting
```
public PriorityCollectionSorting getPriorityCollectionSorting()
```
    Returns:
    
    The PriorityCollectionSorting for this configuration. It determines how parsers, storers and mappers are ordered. Default is PriorityCollectionSorting.ON_SET_INJECTION_ONLY
  - getConnectionTimeout
```
public int getConnectionTimeout()
```
    Returns:
    
    the connection timeout for this configuration
  - 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
  - getMissingOntologyHeaderStrategy
```
public OWLOntologyLoaderConfiguration.MissingOntologyHeaderStrategy getMissingOntologyHeaderStrategy()
```
    Returns:
    
    the ontology header strategy
  - getRetriesToAttempt
```
public int getRetriesToAttempt()
```
    Returns:
    
    number of retries to attempt when retrieving an ontology form a remote URL.
  - isAcceptingHTTPCompression
```
public boolean isAcceptingHTTPCompression()
```
    Returns:
    
    true if http compression should be accepted.
  - 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
  - isIgnoredImport
```
public boolean isIgnoredImport(IRI iri)
```
    Parameters:
    
    iri - iri to check
    
    Returns:
    
    true if iri should be ignored
  - 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.
  - isReportStackTrace
```
public boolean isReportStackTrace()
```
    Returns:
    
    value for the report stack trace flag.
  - isStrict
```
public boolean isStrict()
```
    Returns:
    
    true if parsing should be strict
  - shouldRepairIllegalPunnings
```
public boolean shouldRepairIllegalPunnings()
```
    Returns:
    
    true if illegal punnings should be repaired
  - isTreatDublinCoreAsBuiltIn
```
public boolean isTreatDublinCoreAsBuiltIn()
```
    Determines if the various parsers, for formats such as RDF based formats that do not require strong typing, should treat Dublin Core Vocabulary as built in vocabulary, so that Dublin Core metadata properties are interpreted as annotation properties.
    
    Returns:
    
    true if the Dublin Core Vocabulary should be treated as built in vocabulary and Dublin Core properties are interpreted as annotation properties, otherwise false. The defaut is true.
  - getBannedParsers
```
public String getBannedParsers()
```
    Returns:
    
    list of parser factory class names that should be skipped when attempting ontology parsing. The list is space separated.
  - getAuthorizationValue
```
public String getAuthorizationValue()
```
    Returns:
    
    authorization header value
  - getEntityExpansionLimit
```
public String getEntityExpansionLimit()
```
    Returns:
    
    max number of XML entity expansions to perform while parsing RDF/XML.
  - shouldTrimToSize
```
public boolean shouldTrimToSize()
```
    Returns:
    
    true if ontology should be trimmed to size after load
  - setAcceptingHTTPCompression
```
@Nonnull
public OWLOntologyLoaderConfiguration setAcceptingHTTPCompression(boolean b)
```
    Parameters:
    
    b - true if HTTP compression should be accepted
    
    Returns:
    
    a copy of this configuration with accepting HTTP compression set to the new value
  - setConnectionTimeout
```
@Nonnull
public OWLOntologyLoaderConfiguration setConnectionTimeout(int l)
```
    Parameters:
    
    l - new timeout Note: the timeout is an int and represents milliseconds. This is necessary for use in URLConnection
    
    Returns:
    
    A OWLOntologyLoaderConfiguration with the connection timeout set to the new value.
  - setFollowRedirects
```
@Nonnull
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.
  - setLoadAnnotationAxioms
```
@Nonnull
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.
  - setMissingImportHandlingStrategy
```
@Nonnull
public OWLOntologyLoaderConfiguration setMissingImportHandlingStrategy(@Nonnull
                                                                                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
  - setMissingOntologyHeaderStrategy
```
@Nonnull
public OWLOntologyLoaderConfiguration setMissingOntologyHeaderStrategy(@Nonnull
                                                                                OWLOntologyLoaderConfiguration.MissingOntologyHeaderStrategy missingOntologyHeaderStrategy)
```
    Parameters:
    
    missingOntologyHeaderStrategy - new value
    
    Returns:
    
    a copy of this configuration object with a different strategy
  - setReportStackTraces
```
@Nonnull
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.
  - setRetriesToAttempt
```
@Nonnull
public OWLOntologyLoaderConfiguration setRetriesToAttempt(int retries)
```
    Parameters:
    
    retries - new value of retries to attempt
    
    Returns:
    
    copy of this configuration with modified retries attempts.
  - setStrict
```
@Nonnull
public OWLOntologyLoaderConfiguration setStrict(boolean strict)
```
    Parameters:
    
    strict - new value for strict
    
    Returns:
    
    copy of the configuration with new strict value
  - setTreatDublinCoreAsBuiltIn
```
@Nonnull
public OWLOntologyLoaderConfiguration setTreatDublinCoreAsBuiltIn(boolean value)
```
    Parameters:
    
    value - true if Dublin Core vocabulary should be treated as built in.
    
    Returns:
    
    a copy of the current object with treatDublinCoreAsBuiltIn set to the new value.
  - setBannedParsers
```
public OWLOntologyLoaderConfiguration setBannedParsers(String ban)
```
    Parameters:
    
    ban - list of parser factory class names that should be skipped when attempting ontology parsing. The list is space separated.
    
    Returns:
    
    An OntologyConfigurator with the new option set.
  - setEntityExpansionLimit
```
public OWLOntologyLoaderConfiguration setEntityExpansionLimit(String limit)
```
    Parameters:
    
    limit - maximum number of XML entities to expand.
    
    Returns:
    
    An OntologyConfigurator with the new option set.
  - setRepairIllegalPunnings
```
public OWLOntologyLoaderConfiguration setRepairIllegalPunnings(boolean b)
```
    Parameters:
    
    b - if illegal punnings should be repaired
    
    Returns:
    
    A OWLOntologyLoaderConfiguration with the repair flag set to the new value.
  - setAuthorizationValue
```
public OWLOntologyLoaderConfiguration setAuthorizationValue(String authorizationValue)
```
    Parameters:
    
    authorizationValue - Authorization header value.
    
    Returns:
    
    An OntologyConfigurator with the new option set.
  - setTrimToSize
```
public OWLOntologyLoaderConfiguration setTrimToSize(boolean value)
```
    Parameters:
    
    value - new value for trim to size
    
    Returns:
    
    An OntologyConfigurator with the new option set.

Class OWLOntologyLoaderConfiguration

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OWLOntologyLoaderConfiguration

Method Detail

addIgnoredImport

clearIgnoredImports

removeIgnoredImport

setPriorityCollectionSorting

getPriorityCollectionSorting

getConnectionTimeout

getMissingImportHandlingStrategy

getMissingOntologyHeaderStrategy

getRetriesToAttempt

isAcceptingHTTPCompression

isFollowRedirects

isIgnoredImport

isLoadAnnotationAxioms

isReportStackTrace

isStrict

shouldRepairIllegalPunnings

isTreatDublinCoreAsBuiltIn

getBannedParsers

getAuthorizationValue

getEntityExpansionLimit

shouldTrimToSize

setAcceptingHTTPCompression

setConnectionTimeout

setFollowRedirects

setLoadAnnotationAxioms

setMissingImportHandlingStrategy

setMissingOntologyHeaderStrategy

setReportStackTraces

setRetriesToAttempt

setStrict

setTreatDublinCoreAsBuiltIn

setBannedParsers

setEntityExpansionLimit

setRepairIllegalPunnings

setAuthorizationValue

setTrimToSize