com.hfg.sql.SQLDelete Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com_hfg Show documentation
com.hfg xml, html, svg, and bioinformatics utility library
There is a newer version: 20240423
package com.hfg.sql;

import com.hfg.sql.jdbc.JDBCException;
import com.hfg.sql.table.DatabaseCol;
import com.hfg.sql.table.DatabaseRow;
import com.hfg.sql.table.DatabaseTable;
import com.hfg.sql.table.field.DatabaseField;
import com.hfg.util.StringBuilderPlus;
import com.hfg.util.StringUtil;

import java.sql.Connection;
import java.sql.SQLException;

//------------------------------------------------------------------------------
/**
 Container for building a SQL delete statement.
 
 @author J. Alex Taylor, hairyfatguy.com
 
 */
//------------------------------------------------------------------------------
// com.hfg XML/HTML Coding Library
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
// J. Alex Taylor, President, Founder, CEO, COO, CFO, OOPS hairyfatguy.com
// [email protected]
//------------------------------------------------------------------------------

public class SQLDelete extends SQLCmd
{
   private DatabaseTable mTable;

   //###########################################################################
   // CONSTRUCTORS
   //###########################################################################

   //---------------------------------------------------------------------------
   public SQLDelete()
   {
   }

   //---------------------------------------------------------------------------
   public SQLDelete(DatabaseRow inRow)
   {
      setTable(inRow.getDatabaseTable());

      DatabaseCol idCol = inRow.getIdCol();
      if (null == idCol)
      {
         throw new JDBCException(inRow.getDatabaseTable() + " doesn't have an id column to use for deletion!");
      }

      addClause(new WhereClause(idCol + " = " + inRow.getField(idCol).getSQLValue()));
   }

   //###########################################################################
   // PUBLIC METHODS
   //###########################################################################

   //---------------------------------------------------------------------------
   public SQLDelete setTable(DatabaseTable inValue)
   {
      mTable = inValue;

      return this;
   }

   //---------------------------------------------------------------------------
   public boolean execute(Connection inConn)
         throws SQLException
   {
      return SQLUtil.execute(inConn, toSQL());
   }

   //---------------------------------------------------------------------------
   public String toSQL()
   {
      if (null == mTable)
      {
         throw new JDBCException("No table has been specified for deletion!");
      }

      String whereClause = generateWhereClause();
      if (! StringUtil.isSet(whereClause))
      {
         throw new JDBCException("No where clause has been specified!");
      }

      StringBuilderPlus sql = new StringBuilderPlus("DELETE FROM ");
      sql.appendln(mTable.getQualifiedName()
                   + (mTable.getAlias() != null ? " " + mTable.getAlias() : ""));

      sql.appendln(whereClause);

      return sql.toString();
   }

   //---------------------------------------------------------------------------
   @Override
   public String toString()
   {
      return toSQL();
   }

   //---------------------------------------------------------------------------
   public SQLDelete addClause(SQLClause inValue)
   {
      super.addClause(inValue);

      return this;
   }

   //---------------------------------------------------------------------------
   public SQLDelete addWhereClause(String inValue)
   {
      super.addClause(new WhereClause(inValue));

      return this;
   }

   //---------------------------------------------------------------------------
   public SQLDelete addWhereClause(DatabaseField inValue)
   {
      super.addClause(new WhereClause(inValue));

      return this;
   }

   //---------------------------------------------------------------------------
   public SQLDelete addWhereClauseGroup(WhereClauseGroup inValue)
   {
      return (SQLDelete) super.addWhereClauseGroup(inValue);
   }

}