DiscordRecord.java

package net.seninp.jmotif.sax.discord;

/**
 * The discord data record.
 * 
 * @author Pavel Senin
 * 
 */
public class DiscordRecord implements Comparable<DiscordRecord> {

  /** The discord id (used when wrapped by RRA). */
  private int ruleId;

  /** The discord position. */
  private int position;

  /** The discord length. */
  private int length;

  /** The NN distance. */
  private double nnDistance;

  /** The payload - auxiliary variable. */
  private String payload;

  /** The info string - auxiliary variable. */
  private String info;

  /**
   * Constructor.
   */
  public DiscordRecord() {
    this.position = -1;
    this.length = -1;
    this.nnDistance = -1.0D;
  }

  /**
   * Constructor.
   * 
   * @param index The index discord found at.
   * @param dist The distance from other sequences.
   */
  public DiscordRecord(int index, double dist) {
    this.position = index;
    this.nnDistance = dist;
    this.payload = "";
  }

  /**
   * Constructor.
   * 
   * @param index The index discord found at.
   * @param dist The distance from other sequences.
   * @param payload The payload.
   */
  public DiscordRecord(int index, double dist, String payload) {
    this.position = index;
    this.nnDistance = dist;
    this.payload = payload;
  }

  /**
   * Set the payload value.
   * 
   * @param payload The payload.
   */
  public void setPayload(String payload) {
    this.payload = payload;
  }

  /**
   * Get the payload.
   * 
   * @return The payload.
   */
  public String getPayload() {
    return payload;
  }

  /**
   * Set the position at the time series list.
   * 
   * @param position the position to set.
   */
  public void setPosition(int position) {
    this.position = position;
  }

  /**
   * Get the position.
   * 
   * @return the position at the time series list.
   */
  public int getPosition() {
    return this.position;
  }

  /**
   * Set the distance to the closest neighbor.
   * 
   * @param distance the distance to set.
   */
  public void setNNDistance(double distance) {
    this.nnDistance = distance;
  }

  /**
   * Get the distance to the closest neighbor.
   * 
   * @return the distance to the closest neighbor.
   */
  public double getNNDistance() {
    return this.nnDistance;
  }

  /**
   * Sets an auxiliary info string.
   * 
   * @param info the data to save.
   */
  public void setInfo(String info) {
    this.info = info;
  }

  /**
   * Get an auxiliary info string.
   * 
   * @return the saved data.
   */
  public String getInfo() {
    return info;
  }

  /**
   * Set the length.
   * 
   * @param length the length value.
   */
  public void setLength(int length) {
    this.length = length;
  }

  /**
   * Get the length.
   * 
   * @return the length.
   */
  public int getLength() {
    return this.length;
  }

  /**
   * The simple comparator based on the distance. Note that discord is "better" if the NN distance
   * is greater.
   * 
   * @param other The discord record this one is compared to.
   * @return True if equals.
   */
  @Override
  public int compareTo(DiscordRecord other) {
    if (null == other) {
      throw new NullPointerException("Unable compare to null!");
    }
    return Double.compare(other.getNNDistance(), this.nnDistance);
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public int hashCode() {
    final int prime = 31;
    int result = 1;
    long temp;
    temp = Double.doubleToLongBits(nnDistance);
    result = prime * result + (int) (temp ^ (temp >>> 32));
    result = prime * result + position;
    return result;
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public boolean equals(Object obj) {
    if (this == obj) {
      return true;
    }
    if (obj == null) {
      return false;
    }
    if (getClass() != obj.getClass()) {
      return false;
    }
    DiscordRecord other = (DiscordRecord) obj;
    if (Double.doubleToLongBits(nnDistance) != Double.doubleToLongBits(other.nnDistance)) {
      return false;
    }
    if (position != other.position) {
      return false;
    }
    return true;
  }

  public int getRuleId() {
    return ruleId;
  }

  public void setRuleId(int ruleId) {
    this.ruleId = ruleId;
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public String toString() {
    StringBuffer sb = new StringBuffer();
    sb.append("'").append(this.payload).append("'");
    sb.append(", distance: ");
    sb.append(this.nnDistance).append(", position: ").append(this.position);
    if (null != this.info && !(this.info.isEmpty())) {
      sb.append(", info: ").append(this.info);
    }
    return sb.toString();
  }

}