com.yworks.yfiles.graphml

Interface IXmlWriter

All Known Implementing Classes:

XmlWriter

public interface IXmlWriter

Abstraction of XML output classes that provide a consistent way to write XML elements to some output.

Method Summary

Modifier and Type	Method and Description
void	flushDocument() Close the document.
IXmlNamespaceManager	getNamespaceManager() Gets the namespace manager associated with this writer.
default IXmlWriter	writeAttribute(GraphMLXmlAttribute attribute) Write an XML attribute from the given attribute struct.
default IXmlWriter	writeAttribute(String localName, String value) Write an XML attribute with the given parameters.
IXmlWriter	writeAttribute(String prefix, String localName, String ns, String value) Write a XML attribute node.
IXmlWriter	writeCData(String content) Write a CDATA section.
IXmlWriter	writeComment(String comment) Write a XML comment node.
IXmlWriter	writeDocumentFragment(Document fragment) Write a document fragment.
void	writeEndDocument() Close the output.
IXmlWriter	writeEndElement() Close a XML element previously opened with writeStartElement(String, String) or writeStartElement(String, String, String).
IXmlWriter	writeProcessingInstruction(String target, String data) Write a xml processing instruction.
IXmlWriter	writeStartDocument() Begin the output process.
IXmlWriter	writeStartElement(String localName, String ns) Begin a new XML element with given parameters.
IXmlWriter	writeStartElement(String prefix, String localName, String ns) Begin a new XML element with given parameters.
IXmlWriter	writeString(String s) Write a text node.

Method Detail

flushDocument

void flushDocument()

Close the document.

This is typically used to actually flush the document to an output stream

getNamespaceManager

IXmlNamespaceManager getNamespaceManager()

Gets the namespace manager associated with this writer.

Returns:

The namespace manager.

writeAttribute

default IXmlWriter writeAttribute(GraphMLXmlAttribute attribute)

Write an XML attribute from the given attribute struct.

Parameters:

attribute - Encapsulates the current attribute values.

Returns:

The writer instance writer for writer chaining.

writeAttribute

default IXmlWriter writeAttribute(String localName,
                                  String value)

Write an XML attribute with the given parameters.

The attribute is not bound to a XML namespace.

Parameters:

localName - The name of the attribute.

value - The value of the attribute.

Returns:

The writer instance writer for writer chaining.

writeAttribute

IXmlWriter writeAttribute(String prefix,
                          String localName,
                          String ns,
                          String value)

Write a XML attribute node.

The attribute is attached to the closest open XML element that has been started with writeStartElement(String, String) or writeStartElement(String, String, String)

Parameters:

prefix - The namespace prefix of the attribute

localName - The local name of the attribute

ns - The namespace URI of this attribute

value - The value of this attribute

Returns:

The writer instance for further chaining

writeCData

IXmlWriter writeCData(String content)

Write a CDATA section.

Parameters:

content - The content of the CDATA section

Returns:

The writer instance for further chaining

writeComment

IXmlWriter writeComment(String comment)

Write a XML comment node.

Parameters:

comment - The content of the comment

Returns:

The writer instance for further chaining

writeDocumentFragment

IXmlWriter writeDocumentFragment(Document fragment)

Write a document fragment.

Returns:

The writer instance for further chaining

writeEndDocument

void writeEndDocument()

Close the output.

Attempts to write after this method has been called will have undefined results.

writeEndElement

IXmlWriter writeEndElement()

Close a XML element previously opened with writeStartElement(String, String) or writeStartElement(String, String, String).

Returns:

The writer instance for further chaining

writeProcessingInstruction

IXmlWriter writeProcessingInstruction(String target,
                                      String data)

Write a xml processing instruction.

Parameters:

target - The target of the PI

data - The data of the PI

Returns:

The writer instance for further chaining

writeStartDocument

IXmlWriter writeStartDocument()

Begin the output process.

Returns:

The writer instance for further chaining

writeStartElement

IXmlWriter writeStartElement(String localName,
                             String ns)

Begin a new XML element with given parameters.

All subsequent output is attached to this element until writeEndElement() has been called or a new element has been started.

This acts like writeStartElement(String, String, String), but uses the default prefix for the namespace

Parameters:

localName - The local name of this element

ns - The namespace of this element

Returns:

The writer instance for further chaining

writeStartElement

IXmlWriter writeStartElement(String prefix,
                             String localName,
                             String ns)

Begin a new XML element with given parameters.

All subsequent output is attached to this element until writeEndElement() has been called or a new element has been started.

Parameters:

prefix - The namespace prefix to use for this element

localName - The local name of this element

ns - The namespace of this element

Returns:

The writer instance for further chaining

writeString

IXmlWriter writeString(String s)

Write a text node.

The string value of s will be correctly escaped

Parameters:

s - The string that gets written as XML text

Returns:

The writer instance for further chaining