# H2ChildSet.java

    /*
    ** Module   : H2ChildSet.java
    ** Abstract : A set used as value in a db-backed map.
    **
    ** Copyright (c) 2020, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ---------------------------------Description----------------------------------
    ** 001 CA  20200412 Created initial version, for incremental conversion support.
    */
    /*
    ** 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.convert.db;

    import java.sql.*;

    import com.goldencode.p2j.convert.db.LoggedCollection.AstKey;

    /**
     * Define a set which is used as a value in a db-backed map.
     * <p>
     * This set will be stored in a separate table, and will be linked to its key in the main table
     * via a foreign-key field.
     */
    public class H2ChildSet
    extends H2Set
    {
       /** The foreign key ID from the main table. */
       private final Object fkId;

       /**
        * Create a new set and associate it with the specified key in the main table.
        *
        * @param    fkId
        *           The foreign key ID from the main table.
        */
       public H2ChildSet(Object fkId)
       {
          this.fkId = fkId;
       }

       /**
        * Persist this collection to database.
        * <p>
        * This is a no-op, as the main table will take care of persisting the values, in a single
        * batch insert.
        */
       @Override
       public void persist()
       {
          // no-op
       }

       /**
        * Persist the changes for this child set, using the specified insert statement.
        *
        * @param    ps
        *           The insert statement.
        *
        * @throws   SQLException
        *           For SQL-related errors when setting the statement arguments.
        */
       void persistChanges(PreparedStatement ps)
       throws SQLException
       {
          // ensure the changes are in sync with the main collection
          changes.retainAll(this);

          changes.persist(ps, (AstKey key, Object val) ->
                              new Object[] { key.fileId, key.astId, fkId, key.key });
       }

       /**
        * Perform an add operation in this set, avoiding logging this change.
        *
        * @param    key
        *           The map key.
        */
       void addSuper(Object key)
       {
          super.add(key);
       }

       /**
        * Log this change being made to the collection.
        *
        * @param    fileId
        *           The AST file ID.
        * @param    astId
        *           The source AST ID.
        * @param    key
        *           The collection key.
        */
       void logChange(long fileId, long astId, Object key)
       {
          if (inPersist())
          {
             return;
          }

          changes.log(fileId, astId, key);
       }
    }