org.semanticweb.owlapi.rdf.rdfxml.renderer

Interface XMLWriter

All Known Implementing Classes:

XMLWriterImpl

public interface XMLWriter

Developed as part of the CO-ODE project http://www.co-ode.org

Since:

2.0.0

Author:

Matthew Horridge, The University Of Manchester, Medical Informatics Group

Method Summary

Modifier and Type	Method and Description
void	endDocument() Causes all open elements, including the document root element, to be closed.
XMLWriterNamespaceManager	getNamespacePrefixes()
String	getXMLBase()
void	setEncoding(String encoding) Sets the encoding for the document that the RDF writer produces.
void	setWrapAttributes(boolean b) Causes the current element's attributes to be wrapped in the output.
void	startDocument(IRI rootElement) Starts writing the document.
void	writeAttribute(IRI attr, String val) Writes an attribute of the last element to be started (that has not been closed).
void	writeAttribute(String attr, String val) Writes an attribute of the last element to be started (that has not been closed).
void	writeComment(String commentText)
void	writeEndElement() Writes the closing tag of the last element to be started.
void	writeStartElement(IRI name) Writes the start of an element.
void	writeTextContent(String text) Writes a text element

Method Detail

setEncoding

void setEncoding(@Nonnull
                 String encoding)

Sets the encoding for the document that the RDF writer produces. The default encoding is UTF-8.

Parameters:

encoding - The encoding.

getNamespacePrefixes

@Nonnull
XMLWriterNamespaceManager getNamespacePrefixes()

Returns:

The namespace manager for the writer.

getXMLBase

@Nonnull
String getXMLBase()

Returns:

the XML base

setWrapAttributes

void setWrapAttributes(boolean b)

Causes the current element's attributes to be wrapped in the output.

Parameters:

b - If true then the attributes will be wrapped if they are long. If false then no attribute wrapping will occur.

startDocument

void startDocument(@Nonnull
                   IRI rootElement)
            throws IOException

Starts writing the document. The root element will contain the namespace declarations and xml:base attribute.

Parameters:

rootElement - The iri of the root element.

Throws:

IOException - if there was an IO problem

endDocument

void endDocument()
          throws IOException

Causes all open elements, including the document root element, to be closed.

Throws:

IOException - if there was an IO problem

writeStartElement

void writeStartElement(@Nonnull
                       IRI name)
                throws IOException

Writes the start of an element.

Parameters:

name - The tag name of the element to be written. This must be a valid QName.

Throws:

IOException - if there was an IO problem

IllegalElementNameException - if the specified name is not a valid QName

writeEndElement

void writeEndElement()
              throws IOException

Writes the closing tag of the last element to be started.

Throws:

IOException - if there was an IO problem

writeAttribute

void writeAttribute(@Nonnull
                    String attr,
                    @Nonnull
                    String val)
             throws IOException

Writes an attribute of the last element to be started (that has not been closed). Note: if the attribute is an iri, use writeAttribute(IRI, String)

Parameters:

attr - The name of the attribute

val - The value of the attribute

Throws:

IOException - if there was an IO problem

writeAttribute

void writeAttribute(@Nonnull
                    IRI attr,
                    String val)
             throws IOException

Writes an attribute of the last element to be started (that has not been closed).

Parameters:

attr - The name of the attribute

val - The value of the attribute

Throws:

IOException - if there was an IO problem

writeTextContent

void writeTextContent(@Nonnull
                      String text)
               throws IOException

Writes a text element

Parameters:

text - The text to be written

Throws:

IOException - if there was an IO problem

writeComment

void writeComment(@Nonnull
                  String commentText)
           throws IOException

Parameters:

commentText - comment text

Throws:

IOException - if there was an IO problem