# WordsTrigger.java

    /*
    ** Module   : WordsTrigger.java
    ** Abstract : Base class for triggers populating word table
    **
    ** Copyright (c) 2021, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- --------------------------------Description----------------------------------
    ** 001 IAS 20210104 Created initial version.
    **     IAS 20210219 Word tables support for custom extents
    */

    /*
    ** This program is free software: you can redistribute it and/or modify
    ** it under the terms of the GNU Affero General Public License as
    ** published by the Free Software Foundation, either version 3 of the
    ** License, or (at your option) any later version.
    **
    ** This program 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 Affero General Public License for more details.
    **
    ** You may find a copy of the GNU Affero GPL version 3 at the following
    ** location: https://www.gnu.org/licenses/agpl-3.0.en.html
    **
    ** Additional terms under GNU Affero GPL version 3 section 7:
    **
    **   Under Section 7 of the GNU Affero GPL version 3, the following additional
    **   terms apply to the works covered under the License.  These additional terms
    **   are non-permissive additional terms allowed under Section 7 of the GNU
    **   Affero GPL version 3 and may not be removed by you.
    **
    **   0. Attribution Requirement.
    **
    **     You must preserve all legal notices or author attributions in the covered
    **     work or Appropriate Legal Notices displayed by works containing the covered
    **     work.  You may not remove from the covered work any author or developer
    **     credit already included within the covered work.
    **
    **   1. No License To Use Trademarks.
    **
    **     This license does not grant any license or rights to use the trademarks
    **     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
    **     of Golden Code Development Corporation. You are not authorized to use the
    **     name Golden Code, FWD, or the names of any author or contributor, for
    **     publicity purposes without written authorization.
    **
    **   2. No Misrepresentation of Affiliation.
    **
    **     You may not represent yourself as Golden Code Development Corporation or FWD.
    **
    **     You may not represent yourself for publicity purposes as associated with
    **     Golden Code Development Corporation, FWD, or any author or contributor to
    **     the covered work, without written authorization.
    **
    **   3. No Misrepresentation of Source or Origin.
    **
    **     You may not represent the covered work as solely your work.  All modified
    **     versions of the covered work must be marked in a reasonable way to make it
    **     clear that the modified work is not originating from Golden Code Development
    **     Corporation or FWD.  All modified versions must contain the notices of
    **     attribution required in this license.
    */

    package com.goldencode.p2j.persist.h2;

    import java.sql.*;

    import org.h2.tools.*;

    import com.goldencode.p2j.persist.pl.*;

    /**
     * Base class for triggers populating word table
     */
    public abstract class WordsTrigger
    extends TriggerAdapter
    {
       /** Index field name in the extent table */
       protected static final String IDX = "list__index";
       /** the name of the primary key of the master table */
       protected final String pkName;
       /** the name of the field of the master table */
       protected final String fieldName;
       /** the word table name */
       protected final String wordTableName;
       /** the flag indicating that the field is case sensitive */
       protected final boolean caseSensitive;
       /** field position ( != 0 only for the custom extents) */
       protected final int pos;

       /**
        * Constructor
        * @param init
        *        initialization string. Contains the following values
        *        separated by semicolon:
        *        - the name of the primary key of the master table
        *        - the name of the field of the master table
        *        - the word table name
        *        - the flag indicating that the field is case sensitive ('true'/'false')
        *        - the extent field position ( != 0 only for the custom extents)
        */
       public WordsTrigger(String init)
       {
          super();
          String[] params = init.split(";");
          this.pkName = params[0];
          this.fieldName = params[1];
          this.wordTableName = params[2];
          this.caseSensitive = Boolean.parseBoolean(params[3]);
          this.pos = params.length > 4 && params[4] != null ? Integer.parseInt(params[4]) : 0;
       }

       /**
        * Populate the word table associated with a field of the master table
        * @param conn
        *        a connection to the database.
        * @param pk
        *        the value of the primary key of the master table record
        * @param field
        *        the value of the field the word table is associated with
        * @throws SQLException
        *         if the operation must be undone
        */
       protected void insertWords(Connection conn, long pk, String field)
       throws SQLException
       {
          // NB: uppercase at the database side
          String[] words = Functions.words(field, false, !caseSensitive);
          if (words == null || words.length == 0)
          {
             return;
          }
          StringBuilder sql = new StringBuilder("INSERT INTO ").
                                  append(wordTableName).append(" VALUES");
          for (int i = 0; i < words.length; i++)
          {
             // NB: uppercase at the database side
             sql.append(i == 0 ? "" : ",").append(caseSensitive ? "(?,?)" : "(?,UPPER(?))");
          }
          try(PreparedStatement pstmt = conn.prepareStatement(sql.toString()))
          {
             int i = 1;
             for(String word: words)
             {
                pstmt.setLong(i++, pk);
                pstmt.setString(i++, word);
             }
             pstmt.executeUpdate();
          };
       }
       /**
        * Populate the word table associated with an extent field of the master table
        * @param conn
        *        a connection to the database.
        * @param pk
        *        the value of the primary key of the master table record
        * @param index
        *        the value of the index key of the extent table record
        * @param field
        *        the value of the field the word table is associated with
        * @throws SQLException
        *         if the operation must be undone
        */
       protected void insertWords(Connection conn, long pk, int index, String field)
       throws SQLException
       {
          // NB: uppercase at the database side
          String[] words = Functions.words(field, false, !caseSensitive);
          if (words == null || words.length == 0)
          {
             return;
          }
          StringBuilder sql = new StringBuilder("INSERT INTO ").
                                  append(wordTableName).append(" VALUES");
          for (int i = 0; i < words.length; i++)
          {
             // NB: uppercase at the database side
             sql.append(i == 0 ? "" : ",").append(caseSensitive ? "(?,?,?)" : "(?,?,UPPER(?))");
          }
          try(PreparedStatement pstmt = conn.prepareStatement(sql.toString()))
          {
             int i = 1;
             for(String word: words)
             {
                pstmt.setLong(i++, pk);
                pstmt.setInt(i++, index);
                pstmt.setString(i++, word);
             }
             pstmt.executeUpdate();
          };
       }
    }