org.coode.xml

Class XMLWriterImpl

java.lang.Object

org.coode.xml.XMLWriterImpl

All Implemented Interfaces:

XMLWriter

public class XMLWriterImpl
extends Object
implements XMLWriter

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

Author:

Matthew Horridge, The University Of Manchester, Medical Informatics Group, Date: 30-May-2006

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	XMLWriterImpl.XMLElement xml element

Field Summary

Fields

Modifier and Type	Field and Description
protected Writer	writer

Constructor Summary

Constructors

Constructor and Description
XMLWriterImpl(Writer writer, XMLWriterNamespaceManager xmlWriterNamespaceManager, String xmlBase)

Method Summary

Modifier and Type	Method and Description
void	endDocument() Causes all open elements, including the document root element, to be closed.
String	getDefaultNamespace()
XMLWriterNamespaceManager	getNamespacePrefixes() Gets the Writer's namespace manager.
String	getXMLBase()
URI	getXMLBaseAsURI()
void	setEncoding(String encoding) Sets the encoding for the document that the rdfwriter produces.
void	setWrapAttributes(boolean b) Causes the current element's attributes to be wrapped in the output.
void	startDocument(org.semanticweb.owlapi.model.IRI rootElement) Starts writing the document.
void	startDocument(String rootElementName) Starts writing the document.
protected String	swapForEntity(String value)
void	writeAttribute(org.semanticweb.owlapi.model.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(org.semanticweb.owlapi.model.IRI name) Writes the start of an element.
void	writeStartElement(String name) Writes the start of an element.
void	writeTextContent(String text) Writes a text element

Methods inherited from class java.lang.Object

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

Field Detail

writer

protected Writer writer

Constructor Detail

XMLWriterImpl

public XMLWriterImpl(Writer writer,
                     XMLWriterNamespaceManager xmlWriterNamespaceManager,
                     String xmlBase)

Parameters:

writer - writer

xmlWriterNamespaceManager - xmlWriterNamespaceManager

xmlBase - xmlBase

Method Detail

swapForEntity

protected String swapForEntity(String value)

getDefaultNamespace

public String getDefaultNamespace()

Returns:

default namespace

getXMLBase

public String getXMLBase()

Specified by:

getXMLBase in interface XMLWriter

Returns:

xml base

getXMLBaseAsURI

public URI getXMLBaseAsURI()

Returns:

xml base

getNamespacePrefixes

public XMLWriterNamespaceManager getNamespacePrefixes()

Description copied from interface: XMLWriter

Gets the Writer's namespace manager.

Specified by:

getNamespacePrefixes in interface XMLWriter

Returns:

The namespace manager.

setEncoding

public void setEncoding(String encoding)

Description copied from interface: XMLWriter

Sets the encoding for the document that the rdfwriter produces. The default encoding is "UTF-8".

Specified by:

setEncoding in interface XMLWriter

Parameters:

encoding - The encoding.

setWrapAttributes

public void setWrapAttributes(boolean b)

Description copied from interface: XMLWriter

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

Specified by:

setWrapAttributes in interface XMLWriter

Parameters:

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

writeStartElement

public void writeStartElement(String name)
                       throws IOException

Description copied from interface: XMLWriter

Writes the start of an element.

Specified by:

writeStartElement in interface XMLWriter

Parameters:

name - The tag name of the element to be written. This must be a valid QName. If name is an IRI use writeStartName(IRI)

Throws:

IOException - if there was an IO problem

writeStartElement

public void writeStartElement(org.semanticweb.owlapi.model.IRI name)
                       throws IOException

Description copied from interface: XMLWriter

Writes the start of an element.

Specified by:

writeStartElement in interface XMLWriter

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

writeEndElement

public void writeEndElement()
                     throws IOException

Description copied from interface: XMLWriter

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

Specified by:

writeEndElement in interface XMLWriter

Throws:

IOException - if there was an IO problem

writeAttribute

public void writeAttribute(String attr,
                           String val)

Description copied from interface: XMLWriter

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

Specified by:

writeAttribute in interface XMLWriter

Parameters:

attr - The name of the attribute

val - The value of the attribute

writeAttribute

public void writeAttribute(org.semanticweb.owlapi.model.IRI attr,
                           String val)

Description copied from interface: XMLWriter

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

Specified by:

writeAttribute in interface XMLWriter

Parameters:

attr - The name of the attribute

val - The value of the attribute

writeTextContent

public void writeTextContent(String text)

Description copied from interface: XMLWriter

Writes a text element

Specified by:

writeTextContent in interface XMLWriter

Parameters:

text - The text to be written

writeComment

public void writeComment(String commentText)
                  throws IOException

Specified by:

writeComment in interface XMLWriter

Parameters:

commentText - commentText

Throws:

IOException - if there was an IO problem

startDocument

public void startDocument(String rootElementName)
                   throws IOException

Description copied from interface: XMLWriter

Starts writing the document. The root element will contain the namespace declarations and xml:base attribute. If the name of the element is an IRI, use startDocument(IRI)

Specified by:

startDocument in interface XMLWriter

Parameters:

rootElementName - The name of the root element.

Throws:

IOException - if there was an IO problem

startDocument

public void startDocument(org.semanticweb.owlapi.model.IRI rootElement)
                   throws IOException

Description copied from interface: XMLWriter

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

Specified by:

startDocument in interface XMLWriter

Parameters:

rootElement - The iri of the root element.

Throws:

IOException - if there was an IO problem

endDocument

public void endDocument()
                 throws IOException

Description copied from interface: XMLWriter

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

Specified by:

endDocument in interface XMLWriter

Throws:

IOException - if there was an IO problem