org.coode.owlapi.owlxml.renderer
Class OWLXMLWriter

java.lang.Object
  org.coode.owlapi.owlxml.renderer.OWLXMLWriter

public class OWLXMLWriter
extends java.lang.Object

Author: Matthew Horridge
The University Of Manchester
Bio-Health Informatics Group
Date: 12-Dec-2006

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.

Constructor Summary

OWLXMLWriter(java.io.Writer writer, OWLOntology ontology)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

OWLXMLWriter

public OWLXMLWriter(java.io.Writer writer,
                    OWLOntology ontology)

Method Detail

getIRIPrefixMap

public java.util.Map<java.lang.String,java.lang.String> getIRIPrefixMap()

getNamespaceManager

public XMLWriterNamespaceManager getNamespaceManager()

writePrefix

public void writePrefix(java.lang.String prefixName,
                        java.lang.String iri)
                 throws java.io.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:

java.io.IOException

getIRIString

public java.lang.String getIRIString(java.net.URI 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

Throws:

OWLRendererException

endDocument

public void endDocument()

writeStartElement

public void writeStartElement(OWLXMLVocabulary name)

writeEndElement

public void writeEndElement()

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)

writeIRIAttribute

public void writeIRIAttribute(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

Throws:

java.io.IOException

writeLangAttribute

public void writeLangAttribute(java.lang.String lang)

writeCardinalityAttribute

public void writeCardinalityAttribute(int cardinality)

writeTextContent

public void writeTextContent(java.lang.String text)

writeFacetAttribute

public void writeFacetAttribute(OWLFacet facet)

writeAnnotationURIAttribute

public void writeAnnotationURIAttribute(java.net.URI uri)