Package org.semanticweb.owlapi.owlxml.renderer

Class OWLXMLWriter

java.lang.Object

org.semanticweb.owlapi.owlxml.renderer.OWLXMLWriter

public class OWLXMLWriter
extends Object

Writes OWL/XML. In an OWL/XML documents written by this writer, the base is always the ontology URI, and the default namespace is always the OWL namespace (http://www.w3.org/2002/07/owl#). Unlike RDF/XML, entity URIs aren't abbreviated using the XML namespace mechanism, instead they are encoded using 'prefix' elements.

Since:

2.0.0

Author:

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

Constructor Summary

Constructors

Constructor	Description
OWLXMLWriter(Writer writer, OWLOntology ontology)

Method Summary

Modifier and Type	Method	Description
void	endDocument()
Map<String,String>	getIRIPrefixMap()
String	getIRIString(IRI iri)	Gets an IRI attribute value for a full IRI.
XMLWriterNamespaceManager	getNamespaceManager()
void	startDocument(OWLOntology ontology)
void	writeAnnotationURIAttribute(URI uri)
void	writeCardinalityAttribute(int cardinality)
void	writeDatatypeAttribute(OWLDatatype datatype)	Writes a datatype attributed (used on Literal elements).
void	writeEndElement()	write end element
void	writeFacetAttribute(OWLFacet facet)
void	writeIRIAttribute(IRI iri)
void	writeIRIElement(IRI iri)	Writes an IRI element for a given IRI.
void	writeLangAttribute(String lang)
void	writeNodeIDAttribute(NodeID nodeID)
void	writePrefix(String prefixName, String iri)	A convenience method to write a prefix.
void	writeStartElement(OWLXMLVocabulary name)
void	writeTextContent(String text)

Methods inherited from class java.lang.Object

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

Constructor Detail

OWLXMLWriter

public OWLXMLWriter(@Nonnull
                    Writer writer,
                    @Nullable
                    OWLOntology ontology)

Parameters:

writer - writer

ontology - ontology

Method Detail

getIRIPrefixMap

public Map<String,String> getIRIPrefixMap()

Returns:

iri to prefix map

getNamespaceManager

public XMLWriterNamespaceManager getNamespaceManager()

Returns:

namespace manager

writePrefix

public void writePrefix(String prefixName,
                        String iri)
                 throws IOException

A convenience method to write a prefix.

Parameters:

prefixName - The name of the prefix (e.g. owl: is the prefix name for the OWL prefix)

iri - The prefix iri

Throws:

IOException - io error

getIRIString

public String getIRIString(IRI iri)

Gets an IRI attribute value for a full IRI. If the IRI has a prefix that coincides with a written prefix then the compact IRI will be returned, otherwise the full IRI will be returned.

Parameters:

iri - The IRI

Returns:

Either the compact version of the IRI or the full IRI.

startDocument

public void startDocument(OWLOntology ontology)
                   throws OWLRendererException

Parameters:

ontology - ontology

Throws:

OWLRendererException - renderer error

endDocument

public void endDocument()

writeStartElement

public void writeStartElement(OWLXMLVocabulary name)

Parameters:

name - name

writeEndElement

public void writeEndElement()

write end element

writeDatatypeAttribute

public void writeDatatypeAttribute(OWLDatatype datatype)

Writes a datatype attributed (used on Literal elements). The full datatype IRI is written out

Parameters:

datatype - The datatype

writeNodeIDAttribute

public void writeNodeIDAttribute(NodeID nodeID)

Parameters:

nodeID - nodeID

writeIRIAttribute

public void writeIRIAttribute(IRI iri)

Parameters:

iri - iri

writeIRIElement

public void writeIRIElement(IRI iri)

Writes an IRI element for a given IRI.

Parameters:

iri - The IRI to be written as an element. If the IRI can be abbreviated then an AbbreviatedIRI element will be written

writeLangAttribute

public void writeLangAttribute(@Nonnull
                               String lang)

Parameters:

lang - lang

writeCardinalityAttribute

public void writeCardinalityAttribute(int cardinality)

Parameters:

cardinality - cardinality

writeTextContent

public void writeTextContent(@Nonnull
                             String text)

Parameters:

text - text

writeFacetAttribute

public void writeFacetAttribute(OWLFacet facet)

Parameters:

facet - facet

writeAnnotationURIAttribute

public void writeAnnotationURIAttribute(URI uri)

Parameters:

uri - uri