com.screenscraper.datamanager.sql

Class SqlDataWriter

java.lang.Object

com.screenscraper.datamanager.sql.SqlDataWriter

All Implemented Interfaces:

DataWriter

Direct Known Subclasses:

HSqlDataWriter

public class SqlDataWriter
extends java.lang.Object
implements DataWriter

A DataWriter for a generic sql database. MySql is currently the only fully tested database engine but it should support PostgreSql, Oracle, and SqLite

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	autoIncrementSupported
protected SqlDataManager	dm

Constructor Summary

Constructors

Constructor and Description
SqlDataWriter(SqlDataManager dm, java.util.Map lastAutoIncrementValues) Creates a generic SqlDataWriter that *should* work for most Sql databases

Method Summary

Modifier and Type	Method and Description
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
protected java.util.Map<java.lang.String,DataObject>	retrieveLastKey(java.sql.PreparedStatement ps, DataNode n)
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) writes the nodes

Methods inherited from class java.lang.Object

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

Field Detail

dm

@NotNull
protected final SqlDataManager dm

autoIncrementSupported

protected boolean autoIncrementSupported

Constructor Detail

SqlDataWriter

public SqlDataWriter(@NotNull
                     SqlDataManager dm,
                     java.util.Map lastAutoIncrementValues)

Creates a generic SqlDataWriter that *should* work for most Sql databases

Parameters:

dm - The data manager this writer will write to

lastAutoIncrementValues - The last auto increment values for this writer

Method Detail

write

public boolean write(@NotNull
                     RootNode root)

Description copied from interface: DataWriter

writes the nodes

Specified by:

write in interface DataWriter

Parameters:

root - The root node to write

Returns:

true if the write was successful

retrieveLastKey

@NotNull
protected java.util.Map<java.lang.String,DataObject> retrieveLastKey(@NotNull
                                                                               java.sql.PreparedStatement ps,
                                                                               @NotNull
                                                                               DataNode n)
                                                                        throws java.sql.SQLException

Throws:

java.sql.SQLException

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