org.coode.owlapi.owlxmlparser

Class OWLXMLParserHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.coode.owlapi.owlxmlparser.OWLXMLParserHandler

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class OWLXMLParserHandler
extends org.xml.sax.helpers.DefaultHandler

A handler which knows about OWLXML.

Author:

Matthew Horridge, The University Of Manchester, Bio-Health Informatics Group, Date: 13-Dec-2006

Constructor Summary

Constructors

Constructor and Description
OWLXMLParserHandler(OWLOntology ontology)
OWLXMLParserHandler(OWLOntologyManager owlOntologyManager, OWLOntology ontology) Deprecated. manager unnecessary
OWLXMLParserHandler(OWLOntologyManager owlOntologyManager, OWLOntology ontology, OWLElementHandler<?> topHandler) Deprecated. manager unnecessary
OWLXMLParserHandler(OWLOntologyManager owlOntologyManager, OWLOntology ontology, OWLElementHandler<?> topHandler, OWLOntologyLoaderConfiguration configuration) Deprecated. manager is unnecessary
OWLXMLParserHandler(OWLOntologyManager owlOntologyManager, OWLOntology ontology, OWLOntologyLoaderConfiguration configuration) Deprecated. manager is unnecessary
OWLXMLParserHandler(OWLOntology ontology, OWLElementHandler<?> topHandler)
OWLXMLParserHandler(OWLOntology ontology, OWLElementHandler<?> topHandler, OWLOntologyLoaderConfiguration configuration) Creates an OWLXML handler with the specified top level handler.
OWLXMLParserHandler(OWLOntology ontology, OWLOntologyLoaderConfiguration configuration)

Method Summary

Methods

Modifier and Type	Method and Description
void	characters(char[] ch, int start, int length)
void	endDocument()
void	endElement(String uri, String localName, String qName)
IRI	getAbbreviatedIRI(String abbreviatedIRI)
URI	getBase() Return the base URI for resolution of relative URIs.
int	getColumnNumber()
OWLOntologyLoaderConfiguration	getConfiguration()
OWLDataFactory	getDataFactory()
IRI	getIRI(String iriStr)
int	getLineNumber() Gets the line number that the parser is at.
OWLOntology	getOntology()
OWLOntologyManager	getOWLOntologyManager()
Map<String,String>	getPrefixName2PrefixMap()
protected void	processXMLBase(Attributes attributes)
InputSource	resolveEntity(String publicId, String systemId)
void	setDocumentLocator(Locator locator)
void	startDocument()
void	startElement(String uri, String localName, String qName, Attributes attributes)
void	startPrefixMapping(String prefix, String uri)

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, skippedEntity, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Constructor Detail

OWLXMLParserHandler

@Deprecated
public OWLXMLParserHandler(OWLOntologyManager owlOntologyManager,
                              OWLOntology ontology)

Deprecated. manager unnecessary

Parameters:

owlOntologyManager - manager

ontology - ontology

OWLXMLParserHandler

public OWLXMLParserHandler(OWLOntology ontology)

Parameters:

ontology - ontology to parse into

OWLXMLParserHandler

@Deprecated
public OWLXMLParserHandler(OWLOntologyManager owlOntologyManager,
                              OWLOntology ontology,
                              OWLOntologyLoaderConfiguration configuration)

Deprecated. manager is unnecessary

Creates an OWLXML handler.

Parameters:

owlOntologyManager - The manager that should be used to obtain a data factory, imported ontologies etc.

ontology - The ontology that the XML representation will be parsed into.

configuration - load configuration

OWLXMLParserHandler

public OWLXMLParserHandler(OWLOntology ontology,
                   OWLOntologyLoaderConfiguration configuration)

Parameters:

ontology - ontology to add to

configuration - load configuration

OWLXMLParserHandler

@Deprecated
public OWLXMLParserHandler(OWLOntologyManager owlOntologyManager,
                              OWLOntology ontology,
                              OWLElementHandler<?> topHandler)

Deprecated. manager unnecessary

Parameters:

owlOntologyManager - manager

ontology - ontology to parse into

topHandler - top level handler

OWLXMLParserHandler

public OWLXMLParserHandler(OWLOntology ontology,
                   OWLElementHandler<?> topHandler)

Parameters:

ontology - ontology to parse into

topHandler - top level handler

OWLXMLParserHandler

public OWLXMLParserHandler(OWLOntology ontology,
                   OWLElementHandler<?> topHandler,
                   OWLOntologyLoaderConfiguration configuration)

Creates an OWLXML handler with the specified top level handler. This allows OWL/XML representations of axioms to be embedded in abitrary XML documents e.g. DIG 2.0 documents. (The default handler behaviour expects the top level element to be an Ontology element).

Parameters:

ontology - The ontology object that the XML representation should be parsed into.

topHandler - top level handler

configuration - load configuration

OWLXMLParserHandler

@Deprecated
public OWLXMLParserHandler(OWLOntologyManager owlOntologyManager,
                              OWLOntology ontology,
                              OWLElementHandler<?> topHandler,
                              OWLOntologyLoaderConfiguration configuration)

Deprecated. manager is unnecessary

Creates an OWLXML handler with the specified top level handler. This allows OWL/XML representations of axioms to be embedded in abitrary XML documents e.g. DIG 2.0 documents. (The default handler behaviour expects the top level element to be an Ontology element).

Parameters:

owlOntologyManager - The manager that should be used to obtain a data factory, imported ontologies etc.

ontology - The ontology object that the XML representation should be parsed into.

topHandler - The handler for top level elements - may be null, in which case the parser will expect an Ontology element to be the root element.

configuration - load configuration

Method Detail

setDocumentLocator

public void setDocumentLocator(Locator locator)

Specified by:

setDocumentLocator in interface ContentHandler

Overrides:

setDocumentLocator in class org.xml.sax.helpers.DefaultHandler

getConfiguration

public OWLOntologyLoaderConfiguration getConfiguration()

Returns:

config

getLineNumber

public int getLineNumber()

Gets the line number that the parser is at.

Returns:

A positive integer that represents the line number or -1 if the line number is not known.

getColumnNumber

public int getColumnNumber()

Returns:

column number

getIRI

public IRI getIRI(String iriStr)
           throws OWLParserException

Parameters:

iriStr - iri

Returns:

parsed, absolute iri

Throws:

OWLParserException - if an error is raised

getAbbreviatedIRI

public IRI getAbbreviatedIRI(String abbreviatedIRI)
                      throws OWLParserException

Parameters:

abbreviatedIRI - short iri

Returns:

extended iri

Throws:

OWLParserException - if an error is raised

getPrefixName2PrefixMap

public Map<String,String> getPrefixName2PrefixMap()

Returns:

prefix name to prefix

getOntology

public OWLOntology getOntology()

Returns:

ontology

getDataFactory

public OWLDataFactory getDataFactory()

Returns:

data factory

startDocument

public void startDocument()
                   throws SAXException

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

endDocument

public void endDocument()
                 throws SAXException

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

characters

public void characters(char[] ch,
              int start,
              int length)
                throws SAXException

Specified by:

characters in interface ContentHandler

Overrides:

characters in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

startElement

public void startElement(String uri,
                String localName,
                String qName,
                Attributes attributes)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

processXMLBase

protected void processXMLBase(Attributes attributes)

getBase

public URI getBase()

Return the base URI for resolution of relative URIs.

Returns:

base URI or null if unavailable (xml:base not present and the document locator does not provide a URI)

endElement

public void endElement(String uri,
              String localName,
              String qName)
                throws SAXException

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

startPrefixMapping

public void startPrefixMapping(String prefix,
                      String uri)
                        throws SAXException

Specified by:

startPrefixMapping in interface ContentHandler

Overrides:

startPrefixMapping in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

resolveEntity

public InputSource resolveEntity(String publicId,
                        String systemId)
                          throws IOException,
                                 SAXException

Specified by:

resolveEntity in interface EntityResolver

Overrides:

resolveEntity in class org.xml.sax.helpers.DefaultHandler

Throws:

IOException

SAXException

getOWLOntologyManager

public OWLOntologyManager getOWLOntologyManager()

Returns:

manager