org.semanticweb.owlapi.rdf.rdfxml.parser

Class OWLRDFConsumer

java.lang.Object

org.semanticweb.owlapi.rdf.rdfxml.parser.OWLRDFConsumer

All Implemented Interfaces:

RDFConsumer, AnonymousNodeChecker

Direct Known Subclasses:

OWLRDFConsumerAdapter

public class OWLRDFConsumer
extends Object
implements RDFConsumer, AnonymousNodeChecker

A parser/interpreter for an RDF graph which represents an OWL ontology. The consumer interprets triple patterns in the graph to produce the appropriate OWLAPI entities, class expressions and axioms. The parser is based on triple handlers. A given triple handler handles a specific type of triple. Generally speaking this is based on the predicate of a triple, for example, A rdfs:subClassOf B is handled by a subClassOf handler. A handler determines if it can handle a triple in a streaming mode (i.e. while parsing is taking place) or if it can handle a triple after parsing has taken place and the complete graph is in memory. Once a handler handles a triple, that triple is deemed to have been consumed an is discarded. The parser attempts to consume as many triples as possible while streaming parsing is taking place. Whether or not a triple can be consumed during parsing is determined by installed triple handlers.

Since:

2.0.0

Author:

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

Constructor Summary

Constructors

Constructor and Description
OWLRDFConsumer(OWLOntology ontology, AnonymousNodeChecker checker, OWLOntologyLoaderConfiguration configuration) Instantiates a new oWLRDF consumer.
OWLRDFConsumer(OWLOntology ontology, OWLOntologyLoaderConfiguration configuration) Instantiates a new oWLRDF consumer.

Method Summary

Modifier and Type	Method and Description
void	addAnnotatedSource(IRI annotatedAnonSource, IRI annotationMainNode) Records an annotation of an anonymous node (either an annotation of an annotation, or an annotation of an axiom for example).
void	addClassExpression(IRI iri, boolean explicitlyTyped) Adds the class expression.
void	addDataProperty(IRI iri, boolean explicitlyTyped) Adds the data property.
void	addDataRange(IRI iri, boolean explicitlyTyped) Adds the data range.
void	addObjectProperty(IRI iri, boolean explicitlyTyped) Adds the object property.
void	addPrefix(String abbreviation, String value) Add a prefix to the underlying ontology format, if prefixes are supported.
void	endModel() Called when model parsing is finished.
<E extends OWLEntity> E	generateAndLogParseError(EntityType<E> entityType, IRI mainNode)
Set<IRI>	getAnnotatedSourceAnnotationMainNodes(IRI source) Gets the main nodes of annotations that annotated the specified source.
OWLDataFactory	getDataFactory() Gets the data factory.
OWLAxiom	getLastAddedAxiom() Gets the last added axiom.
OWLOntology	getOntology() Gets the ontology.
RDFDocumentFormat	getOntologyFormat() Gets the ontology format.
OWLOntologyManager	getOWLOntologyManager() Gets the oWL ontology manager.
Set<OWLAnnotation>	getPendingAnnotations() Gets any annotations that were translated since the last call of this method (calling this method clears the current pending annotations).
void	includeModel(String logicalURI, String physicalURI) Receives the notification that the model being parsed includes another model with supplied URIs.
boolean	isAnonymousNode(IRI iri)
boolean	isAnonymousNode(String iri)
boolean	isAnonymousSharedNode(String iri)
boolean	isClassExpression(IRI iri) Checks if is class expression.
boolean	isParsedAllTriples() Checks if is parsed all triples.
boolean	isRestriction(IRI iri) Checks if is restriction.
void	logicalURI(IRI logicalURI) Receives the logical URI of the model.
IRI	remapIRI(IRI i) for iris that need to be mapped to blank nodes, e.g., SWRL rules with an IRI - the IRI should be dropped for such constructs.
String	remapOnlyIfRemapped(String i) for iris that have been remapped to blank nodes, e.g., SWRL rules: the triple subject swrl:body object, for example, needs the subject to be remapped consistently.
void	setExpectedAxioms(int expectedAxioms) Sets the expected axioms.
void	setOntologyFormat(RDFDocumentFormat format) Sets the ontology format.
void	startModel(IRI physicalURI) Called when model parsing is started.
void	statementWithLiteralValue(IRI subject, IRI predicate, String object, String language, IRI datatype) Called when a statement with literal value is added to the model.
void	statementWithLiteralValue(String subject, String predicate, String object, String language, String datatype) Called when a statement with literal value is added to the model.
void	statementWithResourceValue(IRI subject, IRI predicate, IRI object) Called when a statement with resource value is added to the model.
void	statementWithResourceValue(String subject, String predicate, String object) Called when a statement with resource value is added to the model.
Set<OWLAnnotation>	translateAnnotations(IRI mainNode) Translates the annotation on a main node.
OWLClassExpression	translateClassExpression(IRI i) compatibility proxy for TranslatorAccessor#translateClassExpression
OWLDataPropertyExpression	translateDataPropertyExpression(IRI iri) Translate data property expression.
OWLDataRange	translateDataRange(IRI mainNode) Given a main node, translated data ranges according to Table 12.
OWLIndividual	translateIndividual(IRI node) Translate individual.
OWLObjectPropertyExpression	translateObjectPropertyExpression(IRI mainNode) Translate object property expression.

Methods inherited from class java.lang.Object

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

Constructor Detail

OWLRDFConsumer

public OWLRDFConsumer(@Nonnull
                      OWLOntology ontology,
                      @Nonnull
                      OWLOntologyLoaderConfiguration configuration)

Instantiates a new oWLRDF consumer.

Parameters:

ontology - the ontology

configuration - the configuration

OWLRDFConsumer

public OWLRDFConsumer(@Nonnull
                      OWLOntology ontology,
                      @Nonnull
                      AnonymousNodeChecker checker,
                      @Nonnull
                      OWLOntologyLoaderConfiguration configuration)

Instantiates a new oWLRDF consumer.

Parameters:

ontology - the ontology

checker - anonymous node checker

configuration - the configuration

Method Detail

addPrefix

public void addPrefix(String abbreviation,
                      String value)

Description copied from interface: RDFConsumer

Add a prefix to the underlying ontology format, if prefixes are supported.

Specified by:

addPrefix in interface RDFConsumer

Parameters:

abbreviation - short name for prefix

value - replacement for short version

getOntology

@Nonnull
public OWLOntology getOntology()

Gets the ontology.

Returns:

the ontology

getOntologyFormat

@Nonnull
public RDFDocumentFormat getOntologyFormat()

Gets the ontology format.

Returns:

the ontology format

setOntologyFormat

public void setOntologyFormat(RDFDocumentFormat format)

Sets the ontology format.

Parameters:

format - the new ontology format

setExpectedAxioms

public void setExpectedAxioms(int expectedAxioms)

Sets the expected axioms.

Parameters:

expectedAxioms - the new expected axioms

getDataFactory

public OWLDataFactory getDataFactory()

Gets the data factory.

Returns:

the data factory

getPendingAnnotations

@Nonnull
public Set<OWLAnnotation> getPendingAnnotations()

Gets any annotations that were translated since the last call of this method (calling this method clears the current pending annotations).

Returns:

The set (possibly empty) of pending annotations.

isAnonymousNode

public boolean isAnonymousNode(String iri)

Specified by:

isAnonymousNode in interface AnonymousNodeChecker

isAnonymousSharedNode

public boolean isAnonymousSharedNode(String iri)

Specified by:

isAnonymousSharedNode in interface AnonymousNodeChecker

isAnonymousNode

public boolean isAnonymousNode(IRI iri)

Specified by:

isAnonymousNode in interface AnonymousNodeChecker

getLastAddedAxiom

public OWLAxiom getLastAddedAxiom()

Gets the last added axiom.

Returns:

the last added axiom

addClassExpression

public void addClassExpression(IRI iri,
                               boolean explicitlyTyped)

Adds the class expression.

Parameters:

iri - the iri

explicitlyTyped - the explicitly typed

isClassExpression

public boolean isClassExpression(IRI iri)

Checks if is class expression.

Parameters:

iri - the iri

Returns:

true, if is class expression

addObjectProperty

public void addObjectProperty(IRI iri,
                              boolean explicitlyTyped)

Adds the object property.

Parameters:

iri - the iri

explicitlyTyped - the explicitly typed

addDataProperty

public void addDataProperty(IRI iri,
                            boolean explicitlyTyped)

Adds the data property.

Parameters:

iri - the iri

explicitlyTyped - the explicitly typed

addDataRange

public void addDataRange(IRI iri,
                         boolean explicitlyTyped)

Adds the data range.

Parameters:

iri - the iri

explicitlyTyped - the explicitly typed

isRestriction

public boolean isRestriction(IRI iri)

Checks if is restriction.

Parameters:

iri - the iri

Returns:

true, if is restriction

getOWLOntologyManager

public OWLOntologyManager getOWLOntologyManager()

Gets the oWL ontology manager.

Returns:

the oWL ontology manager

addAnnotatedSource

public void addAnnotatedSource(IRI annotatedAnonSource,
                               IRI annotationMainNode)

Records an annotation of an anonymous node (either an annotation of an annotation, or an annotation of an axiom for example).

Parameters:

annotatedAnonSource - The source that the annotation annotates

annotationMainNode - The annotations

getAnnotatedSourceAnnotationMainNodes

public Set<IRI> getAnnotatedSourceAnnotationMainNodes(IRI source)

Gets the main nodes of annotations that annotated the specified source.

Parameters:

source - The source (axiom or annotation main node)

Returns:

The set of main nodes that annotate the specified source

startModel

public void startModel(IRI physicalURI)

Description copied from interface: RDFConsumer

Called when model parsing is started.

Specified by:

startModel in interface RDFConsumer

Parameters:

physicalURI - physical URI of the model

isParsedAllTriples

public boolean isParsedAllTriples()

Checks if is parsed all triples.

Returns:

true, if is parsed all triples

endModel

public void endModel()

Description copied from interface: RDFConsumer

Called when model parsing is finished.

Specified by:

endModel in interface RDFConsumer

includeModel

public void includeModel(String logicalURI,
                         String physicalURI)

Description copied from interface: RDFConsumer

Receives the notification that the model being parsed includes another model with supplied URIs.

Specified by:

includeModel in interface RDFConsumer

Parameters:

logicalURI - logical URI of the model

physicalURI - physical URI of the model

logicalURI

public void logicalURI(IRI logicalURI)

Description copied from interface: RDFConsumer

Receives the logical URI of the model.

Specified by:

logicalURI in interface RDFConsumer

Parameters:

logicalURI - logical URI of the model

statementWithLiteralValue

public void statementWithLiteralValue(@Nonnull
                                      String subject,
                                      @Nonnull
                                      String predicate,
                                      @Nonnull
                                      String object,
                                      @Nullable
                                      String language,
                                      @Nullable
                                      String datatype)

Description copied from interface: RDFConsumer

Called when a statement with literal value is added to the model.

Specified by:

statementWithLiteralValue in interface RDFConsumer

Parameters:

subject - URI of the subject resource

predicate - URI of the predicate resource

object - literal object value

language - the language

datatype - the URI of the literal's datatype (may be null)

statementWithLiteralValue

public void statementWithLiteralValue(@Nonnull
                                      IRI subject,
                                      @Nonnull
                                      IRI predicate,
                                      @Nonnull
                                      String object,
                                      String language,
                                      IRI datatype)

Description copied from interface: RDFConsumer

Called when a statement with literal value is added to the model.

Specified by:

statementWithLiteralValue in interface RDFConsumer

Parameters:

subject - URI of the subject resource

predicate - URI of the predicate resource

object - literal object value

language - the language

datatype - the URI of the literal's datatype (may be null)

statementWithResourceValue

public void statementWithResourceValue(@Nonnull
                                       String subject,
                                       @Nonnull
                                       String predicate,
                                       @Nonnull
                                       String object)

Description copied from interface: RDFConsumer

Called when a statement with resource value is added to the model.

Specified by:

statementWithResourceValue in interface RDFConsumer

Parameters:

subject - URI of the subject resource

predicate - URI of the predicate resource

object - URI of the object resource

statementWithResourceValue

public void statementWithResourceValue(@Nonnull
                                       IRI subject,
                                       @Nonnull
                                       IRI predicate,
                                       @Nonnull
                                       IRI object)

Description copied from interface: RDFConsumer

Called when a statement with resource value is added to the model.

Specified by:

statementWithResourceValue in interface RDFConsumer

Parameters:

subject - URI of the subject resource

predicate - URI of the predicate resource

object - URI of the object resource

translateClassExpression

@Nonnull
public OWLClassExpression translateClassExpression(@Nonnull
                                                            IRI i)

compatibility proxy for TranslatorAccessor#translateClassExpression

Parameters:

i - iri fr the class expression

Returns:

translated class expression

translateDataRange

@Nonnull
public OWLDataRange translateDataRange(@Nonnull
                                                IRI mainNode)

Given a main node, translated data ranges according to Table 12.

Parameters:

mainNode - The main node

Returns:

The translated data range. If the data range could not be translated then an OWLDatatype with the given IRI is returned.

translateDataPropertyExpression

@Nonnull
public OWLDataPropertyExpression translateDataPropertyExpression(@Nonnull
                                                                          IRI iri)

Translate data property expression.

Parameters:

iri - the iri

Returns:

the oWL data property expression

translateObjectPropertyExpression

@Nonnull
public OWLObjectPropertyExpression translateObjectPropertyExpression(@Nonnull
                                                                              IRI mainNode)

Translate object property expression.

Parameters:

mainNode - the main node

Returns:

the oWL object property expression

translateIndividual

@Nonnull
public OWLIndividual translateIndividual(@Nonnull
                                                  IRI node)

Translate individual.

Parameters:

node - the node

Returns:

the oWL individual

translateAnnotations

@Nonnull
public Set<OWLAnnotation> translateAnnotations(IRI mainNode)

Translates the annotation on a main node. Triples whose subject is the specified main node and whose subject is typed an an annotation property (or is a built in annotation property) will be translated to annotation on this main node.

Parameters:

mainNode - The main node

Returns:

The set of annotations on the main node

generateAndLogParseError

@Nonnull
public <E extends OWLEntity> E generateAndLogParseError(@Nonnull
                                                                 EntityType<E> entityType,
                                                                 @Nonnull
                                                                 IRI mainNode)

Type Parameters:

E - entity type

Parameters:

entityType - entity type

mainNode - main node

Returns:

error entity

remapIRI

@Nonnull
public IRI remapIRI(@Nonnull
                             IRI i)

Description copied from interface: RDFConsumer

for iris that need to be mapped to blank nodes, e.g., SWRL rules with an IRI - the IRI should be dropped for such constructs.

Specified by:

remapIRI in interface RDFConsumer

Parameters:

i - iri to remap if not blank

Returns:

blank iri remapping i

remapOnlyIfRemapped

@Nonnull
public String remapOnlyIfRemapped(@Nonnull
                                           String i)

Description copied from interface: RDFConsumer

for iris that have been remapped to blank nodes, e.g., SWRL rules: the triple subject swrl:body object, for example, needs the subject to be remapped consistently.

Specified by:

remapOnlyIfRemapped in interface RDFConsumer

Parameters:

i - iri to remap if not blank

Returns:

blank iri remapping i, or i if i has not been remapped earlier.