jplot

Class XMLWrite

java.lang.Object

jplot.XMLWrite

public class XMLWrite
extends Object

XML-formated writing utilities. The class creates a number of useful methods to write keywords and values to an XML-valid format. The class creates a string buffer, to which new settings are added. They return as a string. Each setting is separated by a line-separator (cariage return by default): other separators can be used if needed.

By default, we assume that the XML stuff is written to a StringBuffer, and indentation is used to beautify the output. After a call to 'open()', an additional indent is added after each line-separator, this shifting the text to the right. The text is left-shifted by the 'close()' method.

To add more complete XML stuff, use 'add'. This is an example of who we can add the settings <position x="0.0" y="1.0"/> to the writer:

XMLWriter xw = new XMLWriter(); xw.add("x","0.0");
xw.add("y","1.0");
xw.set("position");


To open a new field and add elements, use 'open()', e.g.:

xw.open("context");
xw.addSetting("Just this, folks");
xw.close();


creates something like

<context>
Just this, folks
</context>

The string buffer can be reset to 0 at any time. If not reset, the settings are continuously added.

See Also:

XMLRead

Constructor Summary

Constructors

Constructor and Description
XMLWrite() Builds the XML writer class with default settings.
XMLWrite(String indent) Builds the XML writer.
XMLWrite(String indent, String ls) Builds the XML writer.

Method Summary

Modifier and Type	Method and Description
void	add(String attr, String val) Set an attribute of a setting.
void	addData(String data) Adds data to the buffer.
void	addSettings(String s) Add a value (or eventually a sub-set of valid XML stuff) to the current buffer.
void	clear() Resets the string buffer to zero.
void	close() Adds a simple setting to a string(buffer), notifying a closing tag: the tag is preceded by a / (e.g.
String	getSettings() Returns the settings currently added to the buffer in a string
void	open() Shifts the text an indent to the right (open a new field).
void	open(String key) Adds an opening tag to a string(buffer).
void	set(String key) Adds a key to a string(buffer).
void	set(String key, BasicStroke f) Adds a font setting to a string(buffer).
void	set(String key, Color c) Adds a color setting to a string(buffer).
void	set(String key, Font f) Adds a font setting to a string(buffer).
void	setData(String key, double double_data) Adds data between within the scope of a tag.
void	setData(String key, int integer_data) Adds data between within the scope of a tag.
void	setData(String key, String data) Adds data between within the scope of a tag.
void	setIndent(String indent) Sets the indentation, a number of spaces.
void	setSeparator(String s) This method resets the separator between settings to a specific string.
void	setShift(String ii) Sets the initial indentation level, a number of spaces.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLWrite

public XMLWrite()

Builds the XML writer class with default settings. By default, the indent is 3 spaces.

XMLWrite

public XMLWrite(String indent)

Builds the XML writer. The argument is the indentation (series of blanks) added to the string after each opening.

Parameters:

indent - indentation (right-shift)

XMLWrite

public XMLWrite(String indent,
                String ls)

Builds the XML writer. The argument is the indentation (series of blanks) added to the string after each opening. The line-separator (used after each call to a addSetting method) is a line-feed by default.

Parameters:

indent - indentation (right-shift)

ls - new line separator

Method Detail

set

public void set(String key)

Adds a key to a string(buffer). Always ends with a closing '/'.

Parameters:

key - key or name of the XML item

open

public void open(String key)

Adds an opening tag to a string(buffer). Never ends with a closing '/' and the right-shift is incremented with white space.

Parameters:

key - key or name of the XML item

close

public void close()

Adds a simple setting to a string(buffer), notifying a closing tag: the tag is preceded by a / (e.g. ) and a left-shift indentation.

set

public void set(String key,
                Color c)

Adds a color setting to a string(buffer).

Parameters:

key - key or name of the XML item

c - a color instance

set

public void set(String key,
                Font f)

Adds a font setting to a string(buffer).

Parameters:

key - key or name of the XML item

f - a font instance

set

public void set(String key,
                BasicStroke f)

Adds a font setting to a string(buffer).

Parameters:

key - key or name of the XML item

f - a stroke instance

getSettings

public String getSettings()

Returns the settings currently added to the buffer in a string

Returns:

the settings in a string.

setSeparator

public void setSeparator(String s)

This method resets the separator between settings to a specific string. By default, a line-separator is used.

Parameters:

s - new line separator

setShift

public void setShift(String ii)

Sets the initial indentation level, a number of spaces.

Parameters:

ii - initial indentation

setIndent

public void setIndent(String indent)

Sets the indentation, a number of spaces.

Parameters:

indent - indentation

open

public void open()

Shifts the text an indent to the right (open a new field).

clear

public void clear()

Resets the string buffer to zero. Calling this method erases all the settings.

addSettings

public void addSettings(String s)

Add a value (or eventually a sub-set of valid XML stuff) to the current buffer.

Parameters:

s - string with settings.

add

public void add(String attr,
                String val)

Set an attribute of a setting. Using this method with e.g. "foo" and "bar" will write, for the next call to set("key"), something like to the settings buffer.

Parameters:

attr - name of the attribute

val - value of the attribute

addData

public void addData(String data)

Adds data to the buffer. You generally use this method between a open(key) and close() method.

Parameters:

data - data or values

See Also:

open(String), close(), setData(String,String)

setData

public void setData(String key,
                    String data)

Adds data between within the scope of a tag. You can obtain this also by using the methods open(), addData() and close(), but this method writes the tags and data on a single line. You therefore prefer this method for short (one-word) data.

Parameters:

key - key or name of the XML item

See Also:

open(String), addData(String), close()

setData

public void setData(String key,
                    double double_data)

Adds data between within the scope of a tag. You can obtain this also by using the methods open(), addData() and close(), but this method writes the tags and data on a single line. You therefore prefer this method for short (one-word) data.

Parameters:

key - key or name of the XML item

See Also:

open(String), addData(String), close()

setData

public void setData(String key,
                    int integer_data)

Adds data between within the scope of a tag. You can obtain this also by using the methods open(), addData() and close(), but this method writes the tags and data on a single line. You therefore prefer this method for short (one-word) data.

Parameters:

key - key or name of the XML item

See Also:

open(String), addData(String), close()