Metacat

/**

 *  '$RCSfile$'

 *  Copyright: 2004 University of New Mexico and the 

 *                  Regents of the University of California

 *

 *   '$Author: jones $'

 *     '$Date: 2004-04-01 16:41:58 -0800 (Thu, 01 Apr 2004) $'

 * '$Revision: 2094 $'

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation; either version 2 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 General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

 */

package edu.ucsb.nceas.metacat.harvesterClient;

import java.io.PrintStream;

import java.sql.Connection;

import java.sql.ResultSet;

import java.sql.SQLException;

import java.sql.SQLWarning;

import java.sql.Statement;

import java.text.SimpleDateFormat;

import java.util.Date;

/**

 * Manages log entries to be inserted to the HARVEST_LOG table.

 *

 * @author  costa

 */

public class HarvestLog {

  private Harvester harvester;              // The parent Harvester object

  private int harvestLogID;

  private Date harvestDate;

  private int status;

  private final String marker =

"*****************************************************************************";

  private String message;

  private String harvestOperationCode;

  private int siteScheduleID;

  private String timestamp;

  private HarvestDetailLog harvestDetailLog;  // Associated detail log, if any

  /** 

   * Creates a new instance of HarvestLog. This constructor is used when

   * creating log entries that do not involve an error on a harvest document.

   * (For that type of log entry, use the alternate constructor below.)

   *

   * @param  harvester       the parent Harvester object

   * @param  harvestDate     the date of this harvest

   * @param  status          the status of the harvest operation

   * @param  message         the message text of the harvest operation

   * @param  harvestOperationCode  the harvest operation code

   * @param  siteScheduleID  the siteScheduleID for which this operation was

   *                         performed. 0 indicates that the operation did not

   *                         involve a particular harvest site.

   */

  public HarvestLog(Harvester  harvester,

                    Date       harvestDate,

                    int        status,

                    String     message, 

                    String     harvestOperationCode,

                    int        siteScheduleID

                   ) {

    Date now = new Date();

    timestamp = now.toString();

    this.harvester = harvester;

    this.harvestLogID = harvester.getHarvestLogID();

    this.harvestDate = harvestDate;

    this.status = status;

    this.message = message;

    this.harvestOperationCode = harvestOperationCode;

    this.siteScheduleID = siteScheduleID;

    dbInsertHarvestLogEntry();   // Insert this entry to the HARVEST_LOG table

  }

  /** 

   * Creates a new instance of HarvestLog and inserts this entry to the

   * HARVEST_LOG table. This version of the constructor also instantiates a 

   * HarvestDetailLog object and inserts it to the HARVEST_DETAIL_LOG table.

   *

   * @param  harvester       the parent Harvester object

   * @param  harvestDate     the date of this harvest

   * @param  status          the status of the harvest operation

   * @param  message         the message text of the harvest operation

   * @param  harvestOperationCode  the harvest operation code

   * @param  siteScheduleID  the siteScheduleID for which this operation was

   *                         performed. 0 indicates that the operation did not

   *                         involve a particular harvest site.

   */

  public HarvestLog(Harvester  harvester,

                    Date       harvestDate,

                    int        status,

                    String     message, 

                    String     harvestOperationCode,

                    int        siteScheduleID,

                    HarvestDocument harvestDocument,

                    String     errorMessage

                   ) {

    Date now = new Date();

    timestamp = now.toString();

    this.harvester = harvester;

    this.harvestLogID = harvester.getHarvestLogID();

    this.harvestDate = harvestDate;

    this.status = status;

    this.message = message;

    this.harvestOperationCode = harvestOperationCode;

    this.siteScheduleID = siteScheduleID;

    this.harvestDetailLog = new HarvestDetailLog(harvester, harvestLogID, 

                                                 harvestDocument, errorMessage);

    dbInsertHarvestLogEntry();               // Insert to the HARVEST_LOG table

    harvestDetailLog.dbInsertHarvestDetailLogEntry(); // and HARVEST_DETAIL_LOG

  }

  /**

   * Retrieves the value of the EXPLANATION field of the HARVEST_OPERATION

   * table based on the value of the HARVEST_OPERATION_CODE field. 

   * 

   * @param  harvestOperationCode  string value of the harvest operation code

   * @return the explanation for this harvest operation, a String

   */

  String dbGetExplanation(String harvestOperationCode) {

    String explanation;

    String fieldName = "EXPLANATION";

    explanation = dbQueryHarvestOperation(fieldName, harvestOperationCode);

    return explanation;

  }

  /**

   * Retrieves the value of the HARVEST_OPERATION_CODE_LEVEL field of the

   * HARVEST_OPERATION table based on the value of the HARVEST_OPERATION_CODE 

   * field.

   * 

   * @param  harvestOperationCode  string value of the harvest operation code

   * @return the code level value, a String, one of the following:

   *         "error", "warning", "notice", "info", or "debug"

   */

  String dbGetHarvestOperationCodeLevel(String harvestOperationCode) {

    String harvestOperationCodeLevel;

    String fieldName = "HARVEST_OPERATION_CODE_LEVEL";

    harvestOperationCodeLevel = 

            dbQueryHarvestOperation(fieldName, harvestOperationCode);

    return harvestOperationCodeLevel;

  }

  /**

   * Inserts a new entry into the HARVEST_LOG table, based on the contents of

   * this HarvestLog object. Not yet implemented.

   */

  void dbInsertHarvestLogEntry() {

    String dequotedMessage = harvester.dequoteText(message);

    String insertString;

    SimpleDateFormat simpleDateFormat = new SimpleDateFormat("dd-MMM-yyyy");

		Statement stmt;

    insertString = "INSERT INTO HARVEST_LOG " +

                   "(HARVEST_LOG_ID, HARVEST_DATE, STATUS, MESSAGE," +

                   " HARVEST_OPERATION_CODE, SITE_SCHEDULE_ID) " +

                   "values(" +

                   harvestLogID + ", " +

                   "'" + simpleDateFormat.format(harvestDate) + "', " +

                   status + ", " +

                   "'" + timestamp + ": " + dequotedMessage + "', " +

                   "'" + harvestOperationCode + "', " +

                   siteScheduleID +

                   ")";

		try {

			stmt = harvester.conn.createStatement();							

			stmt.executeUpdate(insertString);

			stmt.close();

		}

    catch(SQLException e) {

			System.out.println("SQLException: " + e.getMessage());

		}

  }

  /**

   * Retrieves the value of the either the EXPLANATION field or the

   * HARVEST_OPERATION_CODE_LEVEL field of the HARVEST_OPERATION table based on

   * the value of the HARVEST_OPERATION_CODE field.

   *

   * @param  fieldName  the field name to match, e.g. "EXPLANATION"

   * @param  harvestOperationCode  string value of the harvest operation code

   * @return the explanation string or the harvestOperationCodeLevel string

   */

  String dbQueryHarvestOperation(String fieldName,

                                 String harvestOperationCode

                                ) {

    String explanation = "No explanation available";

    String harvestOperationCodeLevel = "debug";

    String queryString;

    String returnString = "";

    ResultSet rs;

    Statement stmt;

    SQLWarning warn;

    queryString = "SELECT EXPLANATION, HARVEST_OPERATION_CODE_LEVEL " + 

                  "FROM HARVEST_OPERATION " +

                  "WHERE HARVEST_OPERATION_CODE=" +

                  "'" + harvestOperationCode + "'";

    try {                           // Query the HARVEST_OPERATION table

      stmt = harvester.conn.createStatement();

      rs = stmt.executeQuery(queryString);

      warn = rs.getWarnings();

      if (warn != null) {

        System.out.println("\n---Warning---\n");

        while (warn != null) {

          System.out.println("Message: " + warn.getMessage());

          System.out.println("SQLState: " + warn.getSQLState());

          System.out.print("Vendor error code: ");

          System.out.println(warn.getErrorCode());

          System.out.println("");

          warn = warn.getNextWarning();

        }

      }

      while (rs.next()) {

        explanation = rs.getString("EXPLANATION");

        harvestOperationCodeLevel = rs.getString("HARVEST_OPERATION_CODE_LEVEL");

        warn = rs.getWarnings();

        if (warn != null) {

          System.out.println("\n---Warning---\n");

          while (warn != null) {

            System.out.println("Message: " + warn.getMessage());

            System.out.println("SQLState: " + warn.getSQLState());

            System.out.print("Vendor error code: ");

            System.out.println(warn.getErrorCode());

            System.out.println("");

            warn = warn.getNextWarning();

          }

        }

      }

      rs.close();

      stmt.close();

    }

    catch (SQLException e) {

      System.out.println("SQLException: Database access failed: " + e);

    }

    if (fieldName.equals("EXPLANATION")) {

      returnString = explanation;

    }

    else if (fieldName.equals("HARVEST_OPERATION_CODE_LEVEL")) {

      returnString = harvestOperationCodeLevel;

    }

    return returnString;

  }

  /**

   * Prints the contents of this HarvestLog object. Used in generating reports.

   * 

   * @param out   the PrintStream to write to

   */

  void printOutput(PrintStream out) {

    out.println("");

    out.println(marker);

    out.println("*");

    out.println("* harvestLogID:         " + harvestLogID);

    out.println("* harvestDate:          " + harvestDate);

    out.println("* status:               " + status);

    out.println("* message:              " + message);

    out.println("* harvestOperationCode: " + harvestOperationCode);

    if (harvestOperationCode.equals("GetDocListSuccess") ||

        harvestOperationCode.equals("GetDocListError")) {

      if (siteScheduleID != 0) {

        harvester.printHarvestSiteSchedule(out, siteScheduleID);

      }

    }

    if (harvestDetailLog != null) {

      harvestDetailLog.printOutput(out);

    }

    out.println("*");

    out.println(marker);

  }

}