org.colomoto.common.xml

Class XMLWriter

java.lang.Object

org.colomoto.common.xml.XMLWriter

public class XMLWriter
extends Object

A helper to write well formed XML documents.

Constructor Summary

Constructors

Constructor and Description
XMLWriter(OutputStream out, String dtdFile) Create an XML writer with indenting enabled by default.
XMLWriter(OutputStreamWriter out, String dtdFile) Create an XML writer with indenting enabled by default.
XMLWriter(String filename, String dtdFile) Create a XMLWriter with the path to a file.

Method Summary

Modifier and Type	Method and Description
void	addAttr(String name, String value) add an attribute to the opened tag.
void	addComplexContent(String s, boolean b) Add a complex "text child", it will be enclosed into CDATA markers
void	addContent(String s) Add a "text child"
void	addFormatedContent(String s, boolean b) Add a "text child", already formated: should _NOT_ be escaped
void	addTag(String name) Add (i.e.
void	addTag(String tag, String content) Add (i.e.
void	addTag(String name, String[] attributes) Add (i.e.
void	addTag(String name, String[] attributes, String content) Add (i.e.
void	close() Close the writer: automatically closes all open tags and the underlying output stream.
void	closeTag() Close the currently opened tag.
String	getBuffer() If toBuffer has previously been called, stop saving to buffer.
static boolean	isValidId(String id) Indicates if the given string is a valid GINsim ID (contains only a-z, A-Z, 0-9, "_" characters, not starting with a digit)
void	openTag(String name) Open a tag in the XML output file
void	openTag(String name, String[] attributes) Open a tag and add it the specified attributes.
void	toBuffer() ask to store the next calls into a string buffer.
void	write(char c) Write a single character directly t the output
void	write(String s) Write a String directly (no escaping)
void	writeEsc(String s, boolean isAttVal) Write a string, using escaping as needed.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLWriter

public XMLWriter(String filename,
                 String dtdFile)
          throws IOException

Create a XMLWriter with the path to a file.

Parameters:

filename - the path to the output file

dtdFile - path to the DTD file

Throws:

IOException - if the output can not be written or fails

XMLWriter

public XMLWriter(OutputStreamWriter out,
                 String dtdFile)
          throws IOException

Create an XML writer with indenting enabled by default.

Parameters:

out - the output writer

dtdFile - path to the DTD file

Throws:

IOException - if the output can not be written or fails

XMLWriter

public XMLWriter(OutputStream out,
                 String dtdFile)
          throws IOException

Create an XML writer with indenting enabled by default.

Parameters:

out - the output stream

dtdFile - path to the DTD file

Throws:

IOException - if the output can not be written or fails

Method Detail

isValidId

public static boolean isValidId(String id)

Indicates if the given string is a valid GINsim ID (contains only a-z, A-Z, 0-9, "_" characters, not starting with a digit)

Parameters:

id - the string to test

Returns:

true if the given string can be used as ID

toBuffer

public void toBuffer()
              throws IOException

ask to store the next calls into a string buffer. Use getBuffer() to stop it and get the content of the buffer.

Throws:

IOException - if writing fails

getBuffer

public String getBuffer()

If toBuffer has previously been called, stop saving to buffer.

Returns:

the content of the buffer.

writeEsc

public void writeEsc(String s,
                     boolean isAttVal)
              throws IOException

Write a string, using escaping as needed.

Parameters:

s - the String to write

isAttVal - specifies if this is an attribute value (uses a different escaping)

Throws:

IOException - if writing fails

write

public void write(String s)
           throws IOException

Write a String directly (no escaping)

Parameters:

s - the string to write

Throws:

IOException - if writing fails

write

public void write(char c)
           throws IOException

Write a single character directly t the output

Parameters:

c - the character

Throws:

IOException - if writing fails

openTag

public void openTag(String name)
             throws IOException

Open a tag in the XML output file

Parameters:

name - the tag name

Throws:

IOException - if writing fails

addTag

public void addTag(String name)
            throws IOException

Add (i.e. open and close) a tag without any attributes and content.

Parameters:

name - the tag name

Throws:

IOException - if writing fails

addTag

public void addTag(String name,
                   String[] attributes,
                   String content)
            throws IOException

Add (i.e. open and close) a tag with specified attributes and content.

Parameters:

name - the tag name

attributes - the list of attributes and their values

content - the content text

Throws:

IOException - if writing fails

openTag

public void openTag(String name,
                    String[] attributes)
             throws IOException

Open a tag and add it the specified attributes.

Parameters:

name - the tag name

attributes - the list of attributes and their values

Throws:

IOException - if writing fails

addTag

public void addTag(String name,
                   String[] attributes)
            throws IOException

Add (i.e. open and close) a tag with specified attributes and no content.

Parameters:

name - the tag name

attributes - the list of attributes and their values

Throws:

IOException - if writing fails

addTag

public void addTag(String tag,
                   String content)
            throws IOException

Add (i.e. open and close) a tag with specified content and no attributes.

Parameters:

tag - the tag name

content - the content to add

Throws:

IOException - if writing fails

closeTag

public void closeTag()
              throws IOException

Close the currently opened tag. Depending on context it will use "/> or "</name>"

Throws:

IOException - if writing fails

addAttr

public void addAttr(String name,
                    String value)
             throws IOException

add an attribute to the opened tag. If the tag is no-more really opened it will return silently without writing anything.

Parameters:

name - the attribute name

value - the attribute value

Throws:

IOException - if writing fails

addContent

public void addContent(String s)
                throws IOException

Add a "text child"

Parameters:

s - the content to write (will be escaped as needed)

Throws:

IOException - if writing fails

addFormatedContent

public void addFormatedContent(String s,
                               boolean b)
                        throws IOException

Add a "text child", already formated: should _NOT_ be escaped

Parameters:

s - the formatted content

b - if true, then the file might get indented

Throws:

IOException - if writing fails

addComplexContent

public void addComplexContent(String s,
                              boolean b)
                       throws IOException

Add a complex "text child", it will be enclosed into CDATA markers

Parameters:

s - the complex content

b - if true, then the file might get indented

Throws:

IOException - if writing fails

close

public void close()
           throws IOException

Close the writer: automatically closes all open tags and the underlying output stream.

Throws:

IOException - if writing fails