com.partnersoft.sql

Class SqlDeleter

java.lang.Object

com.partnersoft.sql.SqlDeleter

public class SqlDeleter
extends java.lang.Object

Tool to simplify basic key-type deletions from an SqlTable.

The SQL generated is of the form "delete from TABLE where THIS=? and THAT=? and..."; if you want anything more complex you should handle that yourself.

Creates and retains a prepared statement so you can hang onto it and use it over and over on the same connection for better performance.

Copyright 2008 Partner Software, Inc.

Author:

Paul Reavis

Constructor Summary

Constructors

Constructor and Description
SqlDeleter(SqlTable table)
SqlDeleter(SqlTable table, java.util.List<java.lang.String> keyNameList)
SqlDeleter(SqlTable table, java.lang.String... keyNames)

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(Cog record) Delete a row using the given Cog of values to get the keys from.
void	delete(java.util.List<java.lang.Object> keyValues) Deletes a row with the given list of key values.
void	delete(Naming<java.lang.Object> record) Delete a row using the given Naming of values to get the keys from.
void	delete(java.lang.Object... keyValues) Deletes a row with the given array of key values.
SqlTable	getTable()

Methods inherited from class java.lang.Object

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

Constructor Detail

SqlDeleter

public SqlDeleter(SqlTable table)
           throws java.sql.SQLException

Throws:

java.sql.SQLException

SqlDeleter

public SqlDeleter(SqlTable table,
          java.lang.String... keyNames)
           throws java.sql.SQLException

Throws:

java.sql.SQLException

SqlDeleter

public SqlDeleter(SqlTable table,
          java.util.List<java.lang.String> keyNameList)
           throws java.sql.SQLException

Throws:

java.sql.SQLException

Method Detail

delete

public void delete(Naming<java.lang.Object> record)
            throws java.sql.SQLException

Delete a row using the given Naming of values to get the keys from. These must have the same names as the key names given in the constructor.

Throws:

java.sql.SQLException

delete

public void delete(Cog record)
            throws java.sql.SQLException

Delete a row using the given Cog of values to get the keys from. These must have the same names as the key names given in the constructor.

Throws:

java.sql.SQLException

delete

public void delete(java.lang.Object... keyValues)
            throws java.sql.SQLException

Deletes a row with the given array of key values. These must have the same number and order as the key names given in the constructor.

Throws:

java.sql.SQLException

delete

public void delete(java.util.List<java.lang.Object> keyValues)
            throws java.sql.SQLException

Deletes a row with the given list of key values. These must have the same number and order as the key names given in the constructor.

Parameters:

keyValues -

Throws:

java.sql.SQLException

getTable

public SqlTable getTable()