OntologyConfigurator (OWLAPI :: Interfaces 5.1.6 API)

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

All Implemented Interfaces:

Serializable
```
public class OntologyConfigurator
extends Object
implements Serializable
```
A configuration builder that specifies all available options in the OWL API. Can be used to build OWLOntologyLoaderConfiguration and OWLOntologyWriterConfiguration objects

Since:

5.0.0

Author:

Ignazio

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

OntologyConfigurator()

Constructors
Constructor and Description
`OntologyConfigurator()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OntologyConfigurator`	`addIgnoredImport(IRI ontologyDocumentIRI)` Adds an ontology document IRI to the list of ontology imports that will be ignored during ontology loading.
`OWLOntologyLoaderConfiguration`	`buildLoaderConfiguration()`
`OWLOntologyWriterConfiguration`	`buildWriterConfiguration()`
`OntologyConfigurator`	`clearIgnoredImports()` Clears all ontology document IRIs from the list of ignored ontology document IRIs.
`String`	`getBannedParsers()`
`int`	`getConnectionTimeout()`
`int`	`getIndentSize()`
`MissingImportHandlingStrategy`	`getMissingImportHandlingStrategy()`
`MissingOntologyHeaderStrategy`	`getMissingOntologyHeaderStrategy()`
`PriorityCollectionSorting`	`getPriorityCollectionSorting()`
`int`	`getRetriesToAttempt()`
`OntologyConfigurator`	`removeIgnoredImport(IRI ontologyDocumentIRI)` Removes an ontology document IRI from the list of ontology imports that will be ignored during ontology loading.
`OntologyConfigurator`	`setAcceptingHTTPCompression(boolean b)`
`OntologyConfigurator`	`setConnectionTimeout(int l)`
`OntologyConfigurator`	`setFollowRedirects(boolean value)`
`OntologyConfigurator`	`setLoadAnnotationAxioms(boolean b)` Specifies whether or not annotation axioms (instances of `OWLAnnotationAxiom`) should be loaded or whether they should be discarded on loading.
`OntologyConfigurator`	`setMissingImportHandlingStrategy(MissingImportHandlingStrategy strategy)` Sets the strategy that is used for missing imports handling.
`OntologyConfigurator`	`setMissingOntologyHeaderStrategy(MissingOntologyHeaderStrategy strategy)`
`OntologyConfigurator`	`setPriorityCollectionSorting(PriorityCollectionSorting sorting)` Set the priorty collection sorting option.
`OntologyConfigurator`	`setReportStackTraces(boolean b)` Set the value for the report stack traces flag.
`OntologyConfigurator`	`setRetriesToAttempt(int retries)`
`OntologyConfigurator`	`setStrict(boolean strict)`
`OntologyConfigurator`	`setTreatDublinCoreAsBuiltIn(boolean value)`
`boolean`	`shouldAcceptHTTPCompression()`
`boolean`	`shouldFollowRedirects()`
`boolean`	`shouldIndent()`
`boolean`	`shouldLoadAnnotations()`
`boolean`	`shouldParseWithStrictConfiguration()`
`boolean`	`shouldRemapIds()`
`boolean`	`shouldRepairIllegalPunnings()`
`boolean`	`shouldReportStackTraces()`
`boolean`	`shouldSaveIds()`
`boolean`	`shouldTreatDublinCoreAsBuiltin()`
`boolean`	`shouldUseBanners()`
`boolean`	`shouldUseLabelsAsBanner()`
`boolean`	`shouldUseNamespaceEntities()`
`OntologyConfigurator`	`withBannedParsers(String ban)`
`OntologyConfigurator`	`withBannersEnabled(boolean label)`
`OntologyConfigurator`	`withIndenting(boolean indent)`
`OntologyConfigurator`	`withIndentSize(int indent)`
`OntologyConfigurator`	`withLabelsAsBanner(boolean label)`
`OntologyConfigurator`	`withRemapAllAnonymousIndividualsIds(boolean b)`
`OntologyConfigurator`	`withRepairIllegalPunnings(boolean b)`
`OntologyConfigurator`	`withSaveIdsForAllAnonymousIndividuals(boolean b)`
`OntologyConfigurator`	`withUseNamespaceEntities(boolean useEntities)`

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

- Constructor Detail
  - OntologyConfigurator
```
public OntologyConfigurator()
```
- Method Detail
  - withBannedParsers
```
public OntologyConfigurator withBannedParsers(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.
  - getBannedParsers
```
public String getBannedParsers()
```
    Returns:
    
    list of parser factory class names that should be skipped when attempting ontology parsing. The list is space separated.
  - getPriorityCollectionSorting
```
public PriorityCollectionSorting getPriorityCollectionSorting()
```
    Returns:
    
    the priorty collection sorting option
  - setPriorityCollectionSorting
```
public OntologyConfigurator setPriorityCollectionSorting(PriorityCollectionSorting sorting)
```
    Set the priorty collection sorting option.
    
    Parameters:
    
    sorting - the sorting option to be used.
    
    Returns:
    
    An OntologyConfigurator with the new sorting option set.
  - addIgnoredImport
```
public OntologyConfigurator 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 OntologyConfigurator 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
```
public OntologyConfigurator 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.
  - setAcceptingHTTPCompression
```
public OntologyConfigurator 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
  - shouldAcceptHTTPCompression
```
public boolean shouldAcceptHTTPCompression()
```
    Returns:
    
    true if HTTP compression should be used
  - getConnectionTimeout
```
public int getConnectionTimeout()
```
    Returns:
    
    the connection timeout
  - setConnectionTimeout
```
public OntologyConfigurator 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
```
public OntologyConfigurator 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.
  - shouldFollowRedirects
```
public boolean shouldFollowRedirects()
```
    Returns:
    
    follow redirects
  - setLoadAnnotationAxioms
```
public OntologyConfigurator 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.
  - shouldLoadAnnotations
```
public boolean shouldLoadAnnotations()
```
    Returns:
    
    load annotations
  - getMissingImportHandlingStrategy
```
public MissingImportHandlingStrategy getMissingImportHandlingStrategy()
```
    Returns:
    
    missing import handling strategy
  - setMissingImportHandlingStrategy
```
public OntologyConfigurator setMissingImportHandlingStrategy(MissingImportHandlingStrategy strategy)
```
    Sets the strategy that is used for missing imports handling. See MissingImportHandlingStrategy for the strategies and their descriptions.
    
    Parameters:
    
    strategy - The strategy to be used.
    
    Returns:
    
    An OWLOntologyLoaderConfiguration object with the strategy set.
    
    Since:
    
    3.3
  - getMissingOntologyHeaderStrategy
```
public MissingOntologyHeaderStrategy getMissingOntologyHeaderStrategy()
```
    Returns:
    
    missing ontology header strategy
  - setMissingOntologyHeaderStrategy
```
public OntologyConfigurator setMissingOntologyHeaderStrategy(MissingOntologyHeaderStrategy strategy)
```
    Parameters:
    
    strategy - new value
    
    Returns:
    
    a copy of this configuration object with a different strategy
  - setReportStackTraces
```
public OntologyConfigurator 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.
  - shouldReportStackTraces
```
public boolean shouldReportStackTraces()
```
    Returns:
    
    report stack traces
  - getRetriesToAttempt
```
public int getRetriesToAttempt()
```
    Returns:
    
    value of retries to attempt
  - setRetriesToAttempt
```
public OntologyConfigurator setRetriesToAttempt(int retries)
```
    Parameters:
    
    retries - new value of retries to attempt
    
    Returns:
    
    copy of this configuration with modified retries attempts.
  - setStrict
```
public OntologyConfigurator setStrict(boolean strict)
```
    Parameters:
    
    strict - new value for strict
    
    Returns:
    
    copy of the configuration with new strict value
  - shouldParseWithStrictConfiguration
```
public boolean shouldParseWithStrictConfiguration()
```
    Returns:
    
    true if parsing should be strict
  - setTreatDublinCoreAsBuiltIn
```
public OntologyConfigurator 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.
  - shouldTreatDublinCoreAsBuiltin
```
public boolean shouldTreatDublinCoreAsBuiltin()
```
    Returns:
    
    true if Dublin Core vocabulary should be treated as built in.
  - shouldRepairIllegalPunnings
```
public boolean shouldRepairIllegalPunnings()
```
    Returns:
    
    true if illegal punnings should be repaired
  - withRepairIllegalPunnings
```
public OntologyConfigurator withRepairIllegalPunnings(boolean b)
```
    Parameters:
    
    b - if illegal punnings should be repaired
    
    Returns:
    
    A OWLOntologyLoaderConfiguration with the repair flag set to the new value.
  - buildLoaderConfiguration
```
public OWLOntologyLoaderConfiguration buildLoaderConfiguration()
```
    Returns:
    
    a new OWLOntologyLoaderConfiguration from the builder current settings
  - withSaveIdsForAllAnonymousIndividuals
```
public OntologyConfigurator withSaveIdsForAllAnonymousIndividuals(boolean b)
```
    Parameters:
    
    b - True if ids for blank nodes should always be written (axioms and anonymous individuals only).
    
    Returns:
    
    new config object
  - shouldSaveIds
```
public boolean shouldSaveIds()
```
    Returns:
    
    should save ids
  - withRemapAllAnonymousIndividualsIds
```
public OntologyConfigurator withRemapAllAnonymousIndividualsIds(boolean b)
```
    Parameters:
    
    b - True if all anonymous individuals should have their ids remapped after parsing.
    
    Returns:
    
    new config object
  - shouldRemapIds
```
public boolean shouldRemapIds()
```
    Returns:
    
    should remap ids
  - withUseNamespaceEntities
```
public OntologyConfigurator withUseNamespaceEntities(boolean useEntities)
```
    Parameters:
    
    useEntities - True if entities should be used for namespace abbreviations.
    
    Returns:
    
    new config object
  - shouldUseNamespaceEntities
```
public boolean shouldUseNamespaceEntities()
```
    Returns:
    
    should use namespace entities
  - withIndenting
```
public OntologyConfigurator withIndenting(boolean indent)
```
    Parameters:
    
    indent - True if indenting should be used when writing out a file.
    
    Returns:
    
    new config object
  - shouldIndent
```
public boolean shouldIndent()
```
    Returns:
    
    should indent
  - withIndentSize
```
public OntologyConfigurator withIndentSize(int indent)
```
    Parameters:
    
    indent - Size of indentation between levels. Only used if indenting is set to true.
    
    Returns:
    
    new config object
  - getIndentSize
```
public int getIndentSize()
```
    Returns:
    
    indent size
  - withLabelsAsBanner
```
public OntologyConfigurator withLabelsAsBanner(boolean label)
```
    Parameters:
    
    label - True if rdfs:labels should be used for banner comments.
    
    Returns:
    
    new config object
  - shouldUseLabelsAsBanner
```
public boolean shouldUseLabelsAsBanner()
```
    Returns:
    
    should use labels as banner
  - withBannersEnabled
```
public OntologyConfigurator withBannersEnabled(boolean label)
```
    Parameters:
    
    label - True if banner comments should be enabled.
    
    Returns:
    
    new config object
  - shouldUseBanners
```
public boolean shouldUseBanners()
```
    Returns:
    
    should output banners
  - buildWriterConfiguration
```
public OWLOntologyWriterConfiguration buildWriterConfiguration()
```
    Returns:
    
    a new OWLOntologyWriterConfiguration from the builder current settings

Class OntologyConfigurator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OntologyConfigurator

Method Detail

withBannedParsers

getBannedParsers

getPriorityCollectionSorting

setPriorityCollectionSorting

addIgnoredImport

clearIgnoredImports

removeIgnoredImport

setAcceptingHTTPCompression

shouldAcceptHTTPCompression

getConnectionTimeout

setConnectionTimeout

setFollowRedirects

shouldFollowRedirects

setLoadAnnotationAxioms

shouldLoadAnnotations

getMissingImportHandlingStrategy

setMissingImportHandlingStrategy

getMissingOntologyHeaderStrategy

setMissingOntologyHeaderStrategy

setReportStackTraces

shouldReportStackTraces

getRetriesToAttempt

setRetriesToAttempt

setStrict

shouldParseWithStrictConfiguration

setTreatDublinCoreAsBuiltIn

shouldTreatDublinCoreAsBuiltin

shouldRepairIllegalPunnings

withRepairIllegalPunnings

buildLoaderConfiguration

withSaveIdsForAllAnonymousIndividuals

shouldSaveIds

withRemapAllAnonymousIndividualsIds

shouldRemapIds

withUseNamespaceEntities

shouldUseNamespaceEntities

withIndenting

shouldIndent

withIndentSize

getIndentSize

withLabelsAsBanner

shouldUseLabelsAsBanner

withBannersEnabled

shouldUseBanners

buildWriterConfiguration