org.semanticweb.owlapi.io

Interface OWLParser

All Known Implementing Classes:

AbstractOWLParser

public interface OWLParser

An OWLParser parses an ontology document and adds the axioms of the parsed ontology to the OWLOntology object passed to the parse methods. OWLParsers are typically used by OWLOntologyManagers to populate empty OWLOntologies, but can be used to add axioms to an OWLOntology that already contains axioms.
One such case is parsing owl:imports which point to documents that are not ontologies. In this case, any axioms parsed from the imported document are added to the existing ontology, which already contains axioms parsed from a different document.

Author:

Matthew Horridge, The University Of Manchester, Bio-Health Informatics Group, Date: 14-Nov-2006

Method Summary

Modifier and Type	Method and Description
OWLOntologyFormat	parse(IRI documentIRI, OWLOntology ontology) Parses the ontology with a concrete representation available at documentIRI and adds its axioms to ontology.
OWLOntologyFormat	parse(OWLOntologyDocumentSource documentSource, OWLOntology ontology) Parses the ontology with a concrete representation in documentSource and adds its axioms to ontology.
OWLOntologyFormat	parse(OWLOntologyDocumentSource documentSource, OWLOntology ontology, OWLOntologyLoaderConfiguration configuration) Parses the ontology with a concrete representation in documentSource and adds its axioms to ontology.
void	setOWLOntologyManager(OWLOntologyManager owlOntologyManager) Deprecated. Each OWLOntology contains a reference to its manager. This method is no longer necessary. Parsers will obtain the manager from the ontology in the various parse methods i.e. parse(OWLOntologyDocumentSource, org.semanticweb.owlapi.model.OWLOntology) , parse(OWLOntologyDocumentSource, org.semanticweb.owlapi.model.OWLOntology) , parse(OWLOntologyDocumentSource, org.semanticweb.owlapi.model.OWLOntology, org.semanticweb.owlapi.model.OWLOntologyLoaderConfiguration)

Method Detail

setOWLOntologyManager

@Deprecated
void setOWLOntologyManager(OWLOntologyManager owlOntologyManager)

Deprecated. Each OWLOntology contains a reference to its manager. This method is no longer necessary. Parsers will obtain the manager from the ontology in the various parse methods i.e. parse(OWLOntologyDocumentSource, org.semanticweb.owlapi.model.OWLOntology) , parse(OWLOntologyDocumentSource, org.semanticweb.owlapi.model.OWLOntology) , parse(OWLOntologyDocumentSource, org.semanticweb.owlapi.model.OWLOntology, org.semanticweb.owlapi.model.OWLOntologyLoaderConfiguration)

Sets the OWLOntologyManager which should be used to load imports etc.

Parameters:

owlOntologyManager - The ontology manager to be set

parse

OWLOntologyFormat parse(IRI documentIRI,
                        OWLOntology ontology)
                 throws OWLParserException,
                        IOException,
                        OWLOntologyChangeException,
                        UnloadableImportException

Parses the ontology with a concrete representation available at documentIRI and adds its axioms to ontology. Implementors of this method should load imported ontologies through makeLoadImportRequest().

Parameters:

documentIRI - the IRI of the document to parse

ontology - the ontology to which the parsed axioms are added

Returns:

the format of the parsed ontology, never null

Throws:

OWLParserException - if there was a parsing problem parsing the ontology.

IOException - if there was an IO problem during parsing.

OWLOntologyChangeException - if there was a problem updating ontology. Typically this depends on the document being parsed containing an ontology with an ontology IRI clashing with one already loaded.

UnloadableImportException - if one or more imports could not be loaded.

parse

OWLOntologyFormat parse(OWLOntologyDocumentSource documentSource,
                        OWLOntology ontology)
                 throws OWLParserException,
                        IOException,
                        OWLOntologyChangeException,
                        UnloadableImportException

Parses the ontology with a concrete representation in documentSource and adds its axioms to ontology. Implementors of this method should load imported ontologies through makeLoadImportRequest().

Parameters:

documentSource - the source of a concrete representation of the document to parse.

ontology - the ontology to which the parsed axioms are added

Returns:

the format of the parsed ontology, never null

Throws:

OWLParserException - if there was a parsing problem parsing the ontology.

IOException - if there was an IO problem during parsing.

OWLOntologyChangeException - if there was a problem updating ontology. Typically this depends on the document being parsed containing an ontology with an ontology IRI clashing with one already loaded.

UnloadableImportException - if one or more imports could not be loaded.

parse

OWLOntologyFormat parse(OWLOntologyDocumentSource documentSource,
                        OWLOntology ontology,
                        OWLOntologyLoaderConfiguration configuration)
                 throws OWLParserException,
                        IOException,
                        OWLOntologyChangeException,
                        UnloadableImportException

Parses the ontology with a concrete representation in documentSource and adds its axioms to ontology. Implementors of this method should load imported ontologies through makeLoadImportRequest().

Parameters:

documentSource - the source of a concrete representation of the document to parse

ontology - the ontology to which the parsed axioms are added

configuration - parsing options for the parser

Returns:

the format of the parsed ontology, never null

Throws:

OWLParserException - if there was a parsing problem parsing the ontology.

IOException - if there was an IO problem during parsing.

OWLOntologyChangeException - if there was a problem updating ontology. Typically this depends on the document being parsed containing an ontology with an ontology IRI clashing with one already loaded.

UnloadableImportException - if one or more imports could not be loaded.