org.clazzes.jdbc2xml.sax
Class JDBCToSAXWriter

java.lang.Object
  org.clazzes.jdbc2xml.sax.JDBCToSAXWriter

public class JDBCToSAXWriter
extends java.lang.Object

This class writes a series of JDBC select queries to an XML document using a SAX ContentHandler instance.

Author:

wglas

Constructor Summary

JDBCToSAXWriter()
Create an uninitialized instance.

JDBCToSAXWriter(java.sql.Connection connection, java.util.TimeZone timeZone, org.xml.sax.ContentHandler contentHandler)

JDBCToSAXWriter(SchemaEngine schemaEngine, org.xml.sax.ContentHandler contentHandler)

Method Summary

void	addQueries(java.util.Collection<java.lang.String> queries) Add the given list of queries to the data being dumped.
void	addQuery(java.lang.String sql) Add the given SQL select query to the data being dumped.
void	addRestrictedTable(java.lang.String table, java.lang.String sql) Add the given database table and a query, which selects a subset of the table data to the data being dumped.
void	addTable(java.lang.String table) Add the given database table to the data being dumped.
void	addTable(TableInfo tableInfo) Add the given database table to the data being dumped.
void	addTables(java.util.Collection<java.lang.String> tables) Add the given list of database tables to the data being dumped.
protected void	doPrettyParagraph()
java.sql.Connection	getConnection()
org.xml.sax.ContentHandler	getContentHandler()
ProcessRestrictionFilter	getProcessRestrictionFilter()
java.lang.String	getSchema()
java.util.TimeZone	getTimeZone()
protected void	initPrettyParams()
void	processData() Proceed by executing all SQL statement and writing the resulting data to the ContentHandler.
void	setConnection(java.sql.Connection connection)
void	setContentHandler(org.xml.sax.ContentHandler contentHandler)
void	setProcessRestrictionFilter(ProcessRestrictionFilter processFilter)
void	setSchema(java.lang.String schema)
void	setTimeZone(java.util.TimeZone timeZone)

Methods inherited from class java.lang.Object

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

Constructor Detail

JDBCToSAXWriter

public JDBCToSAXWriter()

Create an uninitialized instance. Use setConnection(Connection), setContentHandler(ContentHandler) and setTimeZone(TimeZone) in order to initialize this instance.

JDBCToSAXWriter

public JDBCToSAXWriter(java.sql.Connection connection,
                       java.util.TimeZone timeZone,
                       org.xml.sax.ContentHandler contentHandler)
                throws java.sql.SQLException

Parameters:

connection - The database connection to use.

timeZone - The time zone used to process date values.

contentHandler - The SAX content handler which drives the XML output.

Throws:

java.sql.SQLException - Upon errors when inspecting the database.

JDBCToSAXWriter

public JDBCToSAXWriter(SchemaEngine schemaEngine,
                       org.xml.sax.ContentHandler contentHandler)
                throws java.sql.SQLException

Parameters:

schemaEngine - The initialized SchemaEngine carrying the database connection and default time zone.

contentHandler - The SAX content handler which drives the XML output.

Throws:

java.sql.SQLException - Upon errors when inspecting the database.

Method Detail

initPrettyParams

protected void initPrettyParams()

doPrettyParagraph

protected void doPrettyParagraph()
                          throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

getConnection

public java.sql.Connection getConnection()

Returns:

the connection

setConnection

public void setConnection(java.sql.Connection connection)
                   throws java.sql.SQLException

Parameters:

connection - the connection to set

Throws:

java.sql.SQLException

getContentHandler

public org.xml.sax.ContentHandler getContentHandler()

Returns:

the contentHandler

setContentHandler

public void setContentHandler(org.xml.sax.ContentHandler contentHandler)

Parameters:

contentHandler - the contentHandler to set

getTimeZone

public java.util.TimeZone getTimeZone()

Returns:

The default time zone for parsing date values.

setTimeZone

public void setTimeZone(java.util.TimeZone timeZone)

Parameters:

timeZone - the timeZone to set

getSchema

public java.lang.String getSchema()

Returns:

The schema to which the written tables belong.

setSchema

public void setSchema(java.lang.String schema)

Parameters:

schema - The schema to which the written tables belong to set.

addTables

public void addTables(java.util.Collection<java.lang.String> tables)
               throws java.sql.SQLException

Add the given list of database tables to the data being dumped.

Parameters:

tables - A list of database table names.

Throws:

java.sql.SQLException

addTable

public void addTable(java.lang.String table)
              throws java.sql.SQLException

Add the given database table to the data being dumped.

Parameters:

table - A database table name.

Throws:

java.sql.SQLException

addTable

public void addTable(TableInfo tableInfo)
              throws java.sql.SQLException

Add the given database table to the data being dumped. The caller is responsible for assuring, that the passed table description is actually in sync with the database.

Parameters:

tableInfo - A database table description.

Throws:

java.sql.SQLException

addRestrictedTable

public void addRestrictedTable(java.lang.String table,
                               java.lang.String sql)
                        throws java.sql.SQLException

Add the given database table and a query, which selects a subset of the table data to the data being dumped.

Parameters:

table - A database table name.

sql - A query that selects data from this table, but restrict the returned row to a subset of the whole table. Typically, such a query looks like

   select a.* from account a, person p where a.person_id=p.id and person.name='Me';
 

assuming that table account has a foreign key to table person.

Throws:

java.sql.SQLException

addQueries

public void addQueries(java.util.Collection<java.lang.String> queries)

Add the given list of queries to the data being dumped.

Parameters:

queries - A list of SQL queries.

addQuery

public void addQuery(java.lang.String sql)

Add the given SQL select query to the data being dumped.

Parameters:

sql - An SQL query statement.

processData

public void processData()
                 throws java.sql.SQLException,
                        org.xml.sax.SAXException

Proceed by executing all SQL statement and writing the resulting data to the ContentHandler.

Throws:

java.sql.SQLException

org.xml.sax.SAXException

getProcessRestrictionFilter

public ProcessRestrictionFilter getProcessRestrictionFilter()

Returns:

The processRestrictionFilter, which carries all configurable settings for the data export.

setProcessRestrictionFilter

public void setProcessRestrictionFilter(ProcessRestrictionFilter processFilter)

Parameters:

processFilter - The processRestrictionFilter to set.