org.ginsim.common.xml

Class XMLWriter

java.lang.Object

org.ginsim.common.xml.XMLWriter

Direct Known Subclasses:

SVGWriter

public class XMLWriter
extends Object

A helper to write well formed XML documents.

Constructor Summary

Constructors

Constructor and Description
XMLWriter(OutputStream out) Create a XMLWriter with an output stream.
XMLWriter(OutputStreamWriter out) Create a XMLWriter with an existing Writer.
XMLWriter(OutputStreamWriter out, String docType) Create a XMLWriter with an existing Writer.
XMLWriter(String filename) Create a XMLWriter with the path to a file.
XMLWriter(String filename, String docType) Create a XMLWriter with the path to a file.

Method Summary

Modifier and Type	Method and Description
void	addAttr(String name, Color color) Add a color attribute to the opened tag.
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 name, String[] attributes) add (i.e.
void	addTag(String name, String[] attributes, String content) add (i.e.
void	addTagWithContent(String tag, Object content) add (i.e.
void	addTagWithContent(String tag, String content) add (i.e.
void	close() Close the writer: all open tags and the underlying outputstream.
void	closeTag() close the currently opened tag.
static String	deriveValidId(String id)
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, "_" or "-" characters)
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)
void	write(String s)
void	writeEsc(String s, boolean isAttVal)

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)
          throws IOException

Create a XMLWriter with the path to a file.

Parameters:

filename -

Throws:

IOException

XMLWriter

public XMLWriter(String filename,
                 String docType)
          throws IOException

Create a XMLWriter with the path to a file.

Parameters:

filename -

docType -

Throws:

IOException

XMLWriter

public XMLWriter(OutputStreamWriter out)
          throws IOException

Create a XMLWriter with an existing Writer. Warning: the writer should use the right encoding, otherwise we may get into troubles.

Parameters:

out -

Throws:

IOException

XMLWriter

public XMLWriter(OutputStreamWriter out,
                 String docType)
          throws IOException

Create a XMLWriter with an existing Writer. Warning: the writer should use the right encoding, otherwise we may get into troubles.

Parameters:

out -

docType -

Throws:

IOException

XMLWriter

public XMLWriter(OutputStream out)
          throws IOException

Create a XMLWriter with an output stream. It will create a Writer for this stream, using an UTF-8 encoding.

Parameters:

out -

Throws:

IOException

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, "_" or "-" characters)

Parameters:

id - the string to test

Returns:

true if the given string can be used as ID

deriveValidId

public static String deriveValidId(String 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

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

Parameters:

s -

isAttVal -

Throws:

IOException

write

public void write(String s)
           throws IOException

Parameters:

s -

Throws:

IOException

write

public void write(char c)
           throws IOException

Parameters:

c -

Throws:

IOException

openTag

public void openTag(String name)
             throws IOException

open a tag in the XML output file

Parameters:

name -

Throws:

IOException

addTag

public void addTag(String name)
            throws IOException

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

Parameters:

name -

Throws:

IOException

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 -

attributes -

content -

Throws:

IOException

openTag

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

open a tag and add it the specified attributes.

Parameters:

name -

attributes -

Throws:

IOException

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 -

attributes -

Throws:

IOException

addTagWithContent

public void addTagWithContent(String tag,
                              Object content)
                       throws IOException

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

Parameters:

tag -

content -

Throws:

IOException

addTagWithContent

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

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

Parameters:

tag -

content -

Throws:

IOException

closeTag

public void closeTag()
              throws IOException

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

Throws:

IOException

addAttr

public void addAttr(String name,
                    Color color)
             throws IOException

Add a color attribute to the opened tag. The color will be encoded as #RRGGBB

Parameters:

name -

color -

Throws:

IOException

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 -

value -

Throws:

IOException

addContent

public void addContent(String s)
                throws IOException

add a "text child"

Parameters:

s -

Throws:

IOException

addFormatedContent

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

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

Parameters:

s -

b - if true, then the file might get indented

Throws:

IOException

addComplexContent

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

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

Parameters:

s -

b - if true, then the file might get indented

Throws:

IOException

close

public void close()
           throws IOException

Close the writer: all open tags and the underlying outputstream.

Throws:

IOException