KFSPTS-33582 Implement Part 3 of Sprintax 1042-S handling (#1705)

Author: cah292

src/main/java/edu/cornell/kfs/sys/util/CuSqlQueryPlatformAwareDaoBaseJdbc.java

@@ -2,11 +2,13 @@
 
 import java.text.MessageFormat;
 import java.util.List;
+import java.util.function.Function;
 import java.util.stream.Collectors;
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.kuali.kfs.core.framework.persistence.jdbc.dao.PlatformAwareDaoBaseJdbc;
+import org.springframework.jdbc.core.ResultSetExtractor;
 import org.springframework.jdbc.core.RowMapper;
 import org.springframework.jdbc.core.SqlParameterValue;
 
@@ -48,6 +50,42 @@ protected int executeUpdate(final CuSqlQuery sqlQuery, boolean logSQLOnError) {
         }
     }
 
+    protected <T> T queryForResults(final CuSqlQuery sqlQuery, ResultSetExtractor<T> resultSetExtractor) {
+        return queryForResults(sqlQuery, resultSetExtractor, true);
+    }
+    
+    protected <T> T queryForResults(final CuSqlQuery sqlQuery, ResultSetExtractor<T> resultSetExtractor,
+            boolean logSQLOnError) {
+        return queryForResults(sqlQuery, resultSetExtractor,
+                CuSqlQueryPreparedStatementCreatorAndSetter::forReadOnlyResults, logSQLOnError);
+    }
+    
+    protected <T> T queryForUpdatableResults(final CuSqlQuery sqlQuery, ResultSetExtractor<T> resultSetExtractor) {
+        return queryForUpdatableResults(sqlQuery, resultSetExtractor, true);
+    }
+    
+    protected <T> T queryForUpdatableResults(final CuSqlQuery sqlQuery, ResultSetExtractor<T> resultSetExtractor,
+            boolean logSQLOnError) {
+        return queryForResults(sqlQuery, resultSetExtractor,
+                CuSqlQueryPreparedStatementCreatorAndSetter::forUpdatableResults, logSQLOnError);
+    }
+    
+    protected <T> T queryForResults(final CuSqlQuery sqlQuery, final ResultSetExtractor<T> resultSetExtractor,
+            final Function<CuSqlQuery, CuSqlQueryPreparedStatementCreatorAndSetter> statementHandlerFactory,
+            final boolean logSQLOnError) {
+        try {
+            final CuSqlQueryPreparedStatementCreatorAndSetter statementHandler =
+                    statementHandlerFactory.apply(sqlQuery);
+            return getJdbcTemplate().query(statementHandler, statementHandler, resultSetExtractor);
+        } catch (RuntimeException e) {
+            if (logSQLOnError || LOG.isDebugEnabled()) {
+                logSQL(sqlQuery);
+            }
+            LOG.error("queryForResults, Unexpected error encountered while running query!", e);
+            throw e;
+        }
+    }
+    
     protected void logSQL(CuSqlQuery sqlQuery) {
         LOG.info("logSQL, queryString: " + sqlQuery.getQueryString());
         LOG.info("logSQL, parameters: " + buildParametersMessage(sqlQuery));

src/main/java/edu/cornell/kfs/sys/util/CuSqlQueryPreparedStatementCreatorAndSetter.java

@@ -0,0 +1,52 @@
+package edu.cornell.kfs.sys.util;
+
+import java.sql.Connection;
+import java.sql.PreparedStatement;
+import java.sql.ResultSet;
+import java.sql.SQLException;
+
+import org.springframework.jdbc.core.ArgumentTypePreparedStatementSetter;
+import org.springframework.jdbc.core.PreparedStatementCreator;
+import org.springframework.jdbc.core.SqlProvider;
+
+/**
+ * Convenience CuSqlQuery-to-JDBC-query class that can be used as both a PreparedStatementCreator
+ * and a PreparedStatementSetter by a JdbcTemplate. Furthermore, it also allows specifying the desired
+ * type and concurrency for the generated ResultSet.
+ */
+public class CuSqlQueryPreparedStatementCreatorAndSetter extends ArgumentTypePreparedStatementSetter
+        implements PreparedStatementCreator, SqlProvider {
+
+    private final CuSqlQuery query;
+    private final int resultSetType;
+    private final int resultSetConcurrency;
+
+    public CuSqlQueryPreparedStatementCreatorAndSetter(final CuSqlQuery query, final int resultSetType,
+            final int resultSetConcurrency) {
+        super(query.getParameterValuesArray(), query.getParameterTypesArray());
+        this.query = query;
+        this.resultSetType = resultSetType;
+        this.resultSetConcurrency = resultSetConcurrency;
+    }
+
+    public static CuSqlQueryPreparedStatementCreatorAndSetter forReadOnlyResults(final CuSqlQuery query) {
+        return new CuSqlQueryPreparedStatementCreatorAndSetter(
+                query, ResultSet.TYPE_FORWARD_ONLY, ResultSet.CONCUR_READ_ONLY);
+    }
+
+    public static CuSqlQueryPreparedStatementCreatorAndSetter forUpdatableResults(final CuSqlQuery query) {
+        return new CuSqlQueryPreparedStatementCreatorAndSetter(
+                query, ResultSet.TYPE_FORWARD_ONLY, ResultSet.CONCUR_UPDATABLE);
+    }
+
+    @Override
+    public String getSql() {
+        return query.getQueryString();
+    }
+
+    @Override
+    public PreparedStatement createPreparedStatement(final Connection con) throws SQLException {
+        return con.prepareStatement(getSql(), resultSetType, resultSetConcurrency);
+    }
+
+}

src/main/java/edu/cornell/kfs/tax/batch/CUTaxBatchConstants.java

@@ -71,7 +71,16 @@ public enum Tax1099FilerAddressField {
 
     public enum TaxOutputFieldType {
         STATIC,
-        DERIVED;
+        STRING,
+        NORMALIZED_STRING,
+        SENSITIVE_STRING,
+        INTEGER,
+        BOOLEAN,
+        DATE,
+        AMOUNT,
+        NEGATED_AMOUNT,
+        PERCENT,
+        PLAIN_DECIMAL;
     }
 
     /**
@@ -523,6 +532,12 @@ private DerivedFieldNames() {
         }
     }
 
+    public static final class TaxFileSections {
+        public static final String SPRINTAX_BIOGRAPHIC_ROW_1042S = "Sprintax_Bio_Row_1042S";
+        public static final String SPRINTAX_PAYMENT_ROW_1042S = "Sprintax_Payment_Row_1042S";
+        public static final String PLAIN_TRANSACTION_DETAIL_ROW = "Plain_Transaction_Detail_Row";
+    }
+
 
 
     private CUTaxBatchConstants() {

src/main/java/edu/cornell/kfs/tax/batch/TaxBatchConfig.java

@@ -2,8 +2,16 @@
 
 import org.apache.commons.lang3.Validate;
 
+import edu.cornell.kfs.tax.util.TaxUtils;
+
 public final class TaxBatchConfig {
 
+    public enum Mode {
+        CREATE_TAX_FILES,
+        CREATE_TRANSACTION_LIST_FILE;
+    }
+
+    private final Mode mode;
     private final String taxType;
     private final int reportYear;
     private final java.util.Date processingStartDate;
@@ -12,15 +20,30 @@ public final class TaxBatchConfig {
 
     public TaxBatchConfig(final String taxType, final int reportYear,
             final java.util.Date processingStartDate, final java.sql.Date startDate, final java.sql.Date endDate) {
+        this(Mode.CREATE_TAX_FILES, taxType, reportYear, processingStartDate, startDate, endDate);
+    }
+
+    public TaxBatchConfig(final Mode mode, final String taxType, final int reportYear,
+            final java.util.Date processingStartDate, final java.sql.Date startDate, final java.sql.Date endDate) {
+        Validate.notNull(mode, "mode cannot be null");
         Validate.notBlank(taxType, "taxType cannot be blank");
         Validate.notNull(processingStartDate, "processingStartDate cannot be null");
         Validate.notNull(startDate, "startDate cannot be null");
         Validate.notNull(endDate, "endDate cannot be null");
+        this.mode = mode;
         this.taxType = taxType;
         this.reportYear = reportYear;
-        this.processingStartDate = processingStartDate;
-        this.startDate = startDate;
-        this.endDate = endDate;
+        this.processingStartDate = TaxUtils.copyDate(processingStartDate);
+        this.startDate = TaxUtils.copyDate(startDate);
+        this.endDate = TaxUtils.copyDate(endDate);
+    }
+
+    public TaxBatchConfig withMode(final Mode newMode) {
+        return new TaxBatchConfig(newMode, taxType, reportYear, processingStartDate, startDate, endDate);
+    }
+
+    public Mode getMode() {
+        return mode;
     }
 
     public String getTaxType() {
@@ -32,15 +55,15 @@ public int getReportYear() {
     }
 
     public java.util.Date getProcessingStartDate() {
-        return new java.util.Date(processingStartDate.getTime());
+        return TaxUtils.copyDate(processingStartDate);
     }
 
     public java.sql.Date getStartDate() {
-        return new java.sql.Date(startDate.getTime());
+        return TaxUtils.copyDate(startDate);
     }
 
     public java.sql.Date getEndDate() {
-        return new java.sql.Date(endDate.getTime());
+        return TaxUtils.copyDate(endDate);
     }
 
 }

src/main/java/edu/cornell/kfs/tax/batch/TaxStatistics.java

@@ -0,0 +1,8 @@
+package edu.cornell.kfs.tax.batch;
+
+/**
+ * This object will be fully implemented by one of the follow-up Sprintax user stories.
+ */
+public class TaxStatistics {
+
+}

src/main/java/edu/cornell/kfs/tax/batch/dataaccess/TaxDtoFieldEnum.java

@@ -15,6 +15,14 @@ default String getFieldName() {
         return name();
     }
 
+    default boolean needsExplicitAlias() {
+        return false;
+    }
+
+    default boolean needsEncryptedStorage() {
+        return false;
+    }
+
     Class<? extends BusinessObject> getMappedBusinessObjectClass();
 
 }

src/main/java/edu/cornell/kfs/tax/batch/dataaccess/TaxDtoRowMapper.java

@@ -8,15 +8,16 @@
  * 
  * The "T" type represents the DTO type that will be extracted from the ResultSet.
  * 
- * The "U" type represents the DTO type that will be used for updating the ResultSet (if supported);
- * it can be the same as the "T" type if desired.
+ * A DTO type other than the "T" type may be used when calling the updateStringFieldsOnCurrentRow() method,
+ * as long as the DTO fields being accessed have the same names as those on the "T" DTO.
  */
-public interface TaxDtoRowMapper<T, U> {
+public interface TaxDtoRowMapper<T> {
 
     boolean moveToNextRow() throws SQLException;
 
     T readCurrentRow() throws SQLException;
 
-    void prepareCurrentRowForUpdate(final U dtoContainingUpdates) throws SQLException;
+    void updateStringFieldsOnCurrentRow(final Object dtoContainingUpdates,
+            final TaxDtoFieldEnum... fieldsToUpdate) throws SQLException;
 
 }

src/main/java/edu/cornell/kfs/tax/batch/dataaccess/TransactionDetailHandler.java

@@ -0,0 +1,13 @@
+package edu.cornell.kfs.tax.batch.dataaccess;
+
+import edu.cornell.kfs.tax.batch.TaxBatchConfig;
+import edu.cornell.kfs.tax.batch.TaxStatistics;
+import edu.cornell.kfs.tax.businessobject.TransactionDetail;
+
+@FunctionalInterface
+public interface TransactionDetailHandler {
+
+    TaxStatistics performProcessing(final TaxBatchConfig config,
+            final TaxDtoRowMapper<TransactionDetail> rowMapper) throws Exception;
+
+}

src/main/java/edu/cornell/kfs/tax/batch/dataaccess/TransactionDetailProcessorDao.java

@@ -0,0 +1,26 @@
+package edu.cornell.kfs.tax.batch.dataaccess;
+
+import java.util.List;
+
+import edu.cornell.kfs.tax.batch.TaxBatchConfig;
+import edu.cornell.kfs.tax.batch.TaxStatistics;
+import edu.cornell.kfs.tax.batch.dto.NoteLite;
+import edu.cornell.kfs.tax.batch.dto.VendorAddressLite;
+import edu.cornell.kfs.tax.batch.dto.VendorQueryResults;
+
+public interface TransactionDetailProcessorDao {
+
+    TaxStatistics processTransactionDetails(final TaxBatchConfig config,
+            final TransactionDetailHandler handler);
+
+    VendorQueryResults getVendor(final Integer vendorHeaderId, final Integer vendorDetailId);
+
+    VendorAddressLite getHighestPriorityUSVendorAddress(final Integer vendorHeaderId,
+            final Integer vendorDetailId);
+
+    VendorAddressLite getHighestPriorityForeignVendorAddress(final Integer vendorHeaderId,
+            final Integer vendorDetailId);
+
+    List<NoteLite> getNotesByDocumentNumber(final String documentNumber);
+
+}