# PropertyReader.java

    /*
    ** Module   : PropertyReader.java
    ** Abstract : Functional interface for reading a (possibly multiple column) property from a SQL
    **            result set.
    **
    ** Copyright (c) 2020-2022, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ---------------------------------Description---------------------------------
    ** 001 OM  20200212 Created initial version.
    ** 002 CA  20221109 Added 'propertySize' method which returns the number of columns in the result-set for this
    **                  property type.
    */

    /*
    ** 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.orm;

    import java.sql.*;

    /**
     * This functional interface exposes a method for reading a (possibly multiple column) property
     * from a SQL result set.
     */
    @FunctionalInterface
    public interface PropertyReader
    {
       /**
        * Reads data from one or more positions from the {@code ResultSet}, eventually converting it
        * to a proper type and storing the result directly to the {@code Record}'s data structure.
        *
        * @param   rs
        *          The {@code ResultSet} to read from.
        * @param   rsOffset
        *          The index/position in current row of {@code rs} to start reading.
        * @param   data
        *          The destination. Ie. the record's {@code data} field member.
        * @param   propIndex
        *          The destination offset. Ie. the property index.
        *
        * @return  the number of positions read for this property to be fully read.
        *
        * @throws  SQLException
        *          when an error is encountered while setting the value.
        */
       public int readProperty(ResultSet rs, int rsOffset, Object[] data, int propIndex)
       throws SQLException;

       /**
        * Get the size (number of columns in the result-set) required by this property.
        *
        * @return   Defaults to 1.
        */
       public default int propertySize()
       {
          return 1;
       }
    }