com.screenscraper.datamanager.xml

Class XmlDataWriter

java.lang.Object

com.screenscraper.datamanager.xml.XmlDataWriter

All Implemented Interfaces:

DataWriter

class XmlDataWriter
extends java.lang.Object
implements DataWriter

An XML writer that writes out DataNodes. The standard sql schemas generated from the SQLSchemaBuilder are compatible with this writer, but you can also use add the attribute "type=attribute" to the data to have that be written in the attributes portion of an xml node. if a column is named after the table name it will be the primary value of a node, otherwise it will be a child xml node. Children DataNodes will also be presented as a child xml node.
When write is called it writes out the node, but keeps an index so that children can later be added to it and written to the file at the appropriate place with proper indentation.
If flush is called the DataNode is written to the file and cleared so no additional writing on it is possible. This allows you to write a DataNode but later add and flush leaves, so that only a portion of the total xml document only has to be kept in memory at any given time. If you have written to a node and later you want to clear it from memory, once all of its children have been added for instance, you pass the flush method to the node and it will clear it out without rewriting it. Once a node has been written you can't add more data directly to it, but you can add more children.
Still need to implement mechanism in writer to keep track of auto-increment values

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.lang.String	heading
(package private) java.lang.String	linebreak

Constructor Summary

Constructors

Constructor and Description
XmlDataWriter(java.lang.String file, java.lang.String heading) Creates an XmlDataWriter

Method Summary

Modifier and Type	Method and Description
void	clearComplement(java.util.Map variables) Any variables that aren't referenced in the Map passed get cleared out this is so that you can pass all the session variables from screen-scraper and if any aren't referenced in the list you can't connect or write to them anyway (unless they are mid script non-session variables, obviously)
void	close() Closes any connections and frees up any system resources/files
void	finishWriting(java.lang.String finishUp) finishes up the writing, this is not always required but may be depending on the output The purpose is to write out file footers, and get things cleaned up in general
boolean	flush(RootNode n) write and clears the DataNode.
java.lang.String	getCharEncoding()
java.lang.String	getFile()
java.lang.String	getHeading()
void	setCharEncoding(java.lang.String charEncoding)
void	setFile(java.lang.String file)
void	setHeading(java.lang.String heading)
void	startWriting(java.lang.String startUp) starts up the writing, this is not always required but may be depending on the output The purpose is to write out file headers, and get things going in general
boolean	write(RootNode root) write the contents to the file

Methods inherited from class java.lang.Object

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

Field Detail

linebreak

java.lang.String linebreak

heading

java.lang.String heading

Constructor Detail

XmlDataWriter

public XmlDataWriter(@NotNull
                     java.lang.String file,
                     @NotNull
                     java.lang.String heading)

Creates an XmlDataWriter

Parameters:

file -

heading -

Method Detail

write

public boolean write(@NotNull
                     RootNode root)

write the contents to the file

Specified by:

write in interface DataWriter

Parameters:

root - The root node to write

Returns:

true if write was successful

flush

public boolean flush(@NotNull
                     RootNode n)

write and clears the DataNode. No more data or children can be added once flush is called.

Parameters:

n -

Throws:

java.io.IOException

getHeading

public java.lang.String getHeading()

setHeading

public void setHeading(java.lang.String heading)

getCharEncoding

public java.lang.String getCharEncoding()

setCharEncoding

public void setCharEncoding(java.lang.String charEncoding)

getFile

public java.lang.String getFile()

setFile

public void setFile(java.lang.String file)

clearComplement

public void clearComplement(@NotNull
                            java.util.Map variables)
                     throws java.lang.Exception

Any variables that aren't referenced in the Map passed get cleared out this is so that you can pass all the session variables from screen-scraper and if any aren't referenced in the list you can't connect or write to them anyway (unless they are mid script non-session variables, obviously)

Parameters:

variables -

Throws:

java.lang.Exception

startWriting

public void startWriting(java.lang.String startUp)

Description copied from interface: DataWriter

starts up the writing, this is not always required but may be depending on the output The purpose is to write out file headers, and get things going in general

Specified by:

startWriting in interface DataWriter

Parameters:

startUp - A startup query to run before writing

finishWriting

public void finishWriting(java.lang.String finishUp)

Description copied from interface: DataWriter

finishes up the writing, this is not always required but may be depending on the output The purpose is to write out file footers, and get things cleaned up in general

Specified by:

finishWriting in interface DataWriter

Parameters:

finishUp - A closing query to execute

close

public void close()

Description copied from interface: DataWriter

Closes any connections and frees up any system resources/files

Specified by:

close in interface DataWriter