KeyValuePairRecord.java

/* ====================================================================
 * Limited Evaluation License:
 *
 * This software is open source, but licensed. The license with this package
 * is an evaluation license, which may not be used for productive systems. If
 * you want a full license, please contact us.
 *
 * The exclusive owner of this work is the OpenRate project.
 * This work, including all associated documents and components
 * is Copyright of the OpenRate project 2006-2015.
 *
 * The following restrictions apply unless they are expressly relaxed in a
 * contractual agreement between the license holder or one of its officially
 * assigned agents and you or your organisation:
 *
 * 1) This work may not be disclosed, either in full or in part, in any form
 *    electronic or physical, to any third party. This includes both in the
 *    form of source code and compiled modules.
 * 2) This work contains trade secrets in the form of architecture, algorithms
 *    methods and technologies. These trade secrets may not be disclosed to
 *    third parties in any form, either directly or in summary or paraphrased
 *    form, nor may these trade secrets be used to construct products of a
 *    similar or competing nature either by you or third parties.
 * 3) This work may not be included in full or in part in any application.
 * 4) You may not remove or alter any proprietary legends or notices contained
 *    in or on this work.
 * 5) This software may not be reverse-engineered or otherwise decompiled, if
 *    you received this work in a compiled form.
 * 6) This work is licensed, not sold. Possession of this software does not
 *    imply or grant any right to you.
 * 7) You agree to disclose any changes to this work to the copyright holder
 *    and that the copyright holder may include any such changes at its own
 *    discretion into the work
 * 8) You agree not to derive other works from the trade secrets in this work,
 *    and that any such derivation may make you liable to pay damages to the
 *    copyright holder
 * 9) You agree to use this software exclusively for evaluation purposes, and
 *    that you shall not use this software to derive commercial profit or
 *    support your business or personal activities.
 *
 * This software is provided "as is" and any expressed or impled warranties,
 * including, but not limited to, the impled warranties of merchantability
 * and fitness for a particular purpose are disclaimed. In no event shall
 * The OpenRate Project or its officially assigned agents be liable to any
 * direct, indirect, incidental, special, exemplary, or consequential damages
 * (including but not limited to, procurement of substitute goods or services;
 * Loss of use, data, or profits; or any business interruption) however caused
 * and on theory of liability, whether in contract, strict liability, or tort
 * (including negligence or otherwise) arising in any way out of the use of
 * this software, even if advised of the possibility of such damage.
 * This software contains portions by The Apache Software Foundation, Robert
 * Half International.
 * ====================================================================
 */
package OpenRate.record;

import java.util.ArrayList;
import java.util.Map;

/**
 * Flat record is the basic type of record used by the file adapters, and
 * returns the data as a single string, which can then be split and processed as
 * required.
 */
public class KeyValuePairRecord extends AbstractRecord {

  private static final long serialVersionUID = -1506405981820429430L;

  // the original data we received
  private Map<String, String> originalData;

  /**
   * Creates a new instance of FlatRecord
   *
   * @param data The data to map
   * @param RecordNumber The record number
   */
  public KeyValuePairRecord(Map<String, String> data, int RecordNumber) {
    super();

    this.originalData = data;
    this.recordNumber = RecordNumber;
  }

  /**
   * Creates a new instance of FlatRecord
   *
   * @param data The data to map
   */
  public KeyValuePairRecord(Map<String, String> data) {
    super();

    this.originalData = data;
  }

  /**
   * Overloaded constructor for derived classes
   */
  public KeyValuePairRecord() {
    super();
  }

  /**
   * Get the original data
   *
   * @return The original data
   */
  public Map<String, String> getData() {
    return this.originalData;
  }

  /**
   * Set the original data
   *
   * @param dataToSet The data to store
   */
  public void setData(Map<String, String> dataToSet) {
    this.originalData = dataToSet;
  }

  /**
   * This returns the dump information. Should be overwritten by the final
   * implementation class
   *
   * @return
   */
  @Override
  public ArrayList<String> getDumpInfo() {
    RecordError tmpError;
    int i;
    int tmpErrorCount;
    ArrayList<String> tmpDumpList;

    tmpDumpList = new ArrayList<>();

    // Get the error count
    tmpErrorCount = this.getErrors().size();

    // Format the fields
    tmpDumpList.add("============== KVP RECORD =============");
    for (String key : originalData.keySet()) {
      tmpDumpList.add("  KVP             = <" + key + ":" + originalData.get(key) + ">");
    }

    tmpDumpList.add("  Errors          = <" + this.getErrors().size() + ">");
    if (tmpErrorCount > 0) {
      tmpDumpList.add("-------------- ERRORS ----------------");
      for (i = 0; i < this.getErrors().size(); i++) {
        tmpError = (RecordError) this.getErrors().get(i);
        tmpDumpList.add("    Error           = <" + tmpError.getMessage() + ">");
      }
    }

    return tmpDumpList;
  }
}