SuggestionLogEntry.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: SuggestionLogEntry.java
 * Description: Class representing suggested annotation with informations about
 *              suggestion
 */

/**
 * @file SuggestionLogEntry.java
 *
 * @brief Suggested annotation with informations about suggestion
 */

package cz.vutbr.fit.knot.annotations.comet;

import cz.vutbr.fit.knot.annotations.entity.Annotation;

/**
 * Class representing suggested annotation with informations about suggestion
 *
 * @brief Suggested annotation with informations about suggestion
 * @author idytrych
 */
public class SuggestionLogEntry {
  /** Temporary id of suggested annotation */
  String tmpId;
  /** Suggested annotation */
  Annotation suggestion;
  /** Confirmed version of suggested annotation */
  Annotation confirmedVersion;
  /** Number of refuse method (how annotation was refused) */
  Integer refuseMethod;
  /** Number of confirmation method (how annotation was confirmed) */
  Integer confirmMethod;
  /** Percentage of confidence with annotation */
  Integer confidence;

  /**
   * Constructor of reference objects for searching purposes - no initialization
   * needed
   *
   * @param tmpId Temporary id of suggested annotation
   */
  public SuggestionLogEntry(String tmpId) {
    this.tmpId = tmpId;
  }

  /**
   * Constructor which creates suggestion with annotation reference
   *
   * @param suggestion Suggested annotation
   * @param confidence Percentage of confidence with annotation
   */
  public SuggestionLogEntry(Annotation suggestion, int confidence) {
    this.suggestion = suggestion;
    this.confidence = confidence;
  }

  /**
   * Constructor
   *
   * @param tmpId Temporary id of suggested annotation
   * @param suggestion Suggested annotation
   * @param confidence Percentage of confidence with annotation
   */
  public SuggestionLogEntry(String tmpId, Annotation suggestion, int confidence) {
    this.tmpId = tmpId;
    this.suggestion = suggestion;
    this.confidence = confidence;
  }

  /**
   * Gets temporary id of annotation
   *
   * @return Returns temporary id of annotation
   */
  public String getTmpId() {
    return tmpId;
  }

  /**
   * Sets temporary id of annotation
   *
   * @param tmpId Temporary id of annotation
   */
  public void setTmpId(String tmpId) {
    this.tmpId = tmpId;
  }

  /**
   * Gets number of confirmation method (how annotation was confirmed)
   *
   * @return Returns number of confirmation method (how annotation was confirmed), or null, if annotation wasn't confirmed
   */
  public Integer getConfirmMethod() {
    return confirmMethod;
  }

  /**
   * Sets number of confirmation method (how annotation was confirmed)
   *
   * @param confirmMethod Number of confirmation method (how annotation was confirmed)
   */
  public void setConfirmMethod(Integer confirmMethod) {
    this.confirmMethod = confirmMethod;
  }

  /**
   * Gets confirmed version of annotation
   *
   * @return Returns confirmed version of annotation
   */
  public Annotation getConfirmedVersion() {
    return confirmedVersion;
  }

  /**
   * Sets confirmed version of annotation
   *
   * @param confirmedVersion Confirmed version of annotation
   */
  public void setConfirmedVersion(Annotation confirmedVersion) {
    this.confirmedVersion = confirmedVersion;
  }

  /**
   * Gets number of refuse method (how annotation was refused)
   *
   * @return Returns number of refuse method (how annotation was confirmed), or null, if annotation wasn't refused
   */
  public Integer getRefuseMethod() {
    return refuseMethod;
  }

  /**
   * Sets number of refuse method (how annotation was refused)
   *
   * @param refuseMethod Number of refuse method (how annotation was refused)
   */
  public void setRefuseMethod(Integer refuseMethod) {
    this.refuseMethod = refuseMethod;
  }

  /**
   * Gets suggested annotation
   *
   * @return Returns suggested annotation
   */
  public Annotation getSuggestion() {
    return suggestion;
  }

  /**
   * Sets suggested annotation
   *
   * @param suggestion Suggested annotation
   */
  public void setSuggestion(Annotation suggestion) {
    this.suggestion = suggestion;
  }

  /**
   * Gets percentage of confidence with annotation
   *
   * @return Returns percentage of confidence with annotation
   */
  public Integer getConfidence() {
    return confidence;
  }

  /**
   * Sets percentage of confidence with annotation
   *
   * @param confidence Percentage of confidence with annotation
   */
  public void setConfidence(Integer confidence) {
    this.confidence = confidence;
  }

  /**
   * Compares this with other object and returns, whether objects are same type
   * and have same temporary id.
   *
   * @param obj Object to compare with
   * @return If object is same type and have same temporary id, returns true, false otherwise
   */
  @Override
  public boolean equals(Object obj) {
    if (obj == null) {
      return false;
    }
    if (getClass() != obj.getClass()) {
      return false;
    }
    final SuggestionLogEntry other = (SuggestionLogEntry) obj;
    if (this.tmpId != other.tmpId && (this.tmpId == null || !this.tmpId.equals(other.tmpId))) {
      return false;
    }
    return true;
  }

  /**
   * Returns hash code of this object.
   * 
   * @return Hash code
   */
  @Override
  public int hashCode() {
    int hash = 7;
    hash = 59 * hash + (this.tmpId != null ? this.tmpId.hashCode() : 0);
    return hash;
  }

  /**
   * Converts this object to string.
   * 
   * @return String with this object.
   */
  @Override
  public String toString() {
    return "SuggestionLogEntry{" + "tmpId=" + tmpId + "suggestion=" + suggestion + "confirmedVersion=" + confirmedVersion + "refuseMethod=" + refuseMethod + "confirmMethod=" + confirmMethod + "confidence=" + confidence + '}';
  }

  /**
   * Returns serialized informations about suggested annotation in XML
   *
   * @param proto11 If true, protocol version is greather then 1.0
   * @return Returns serialized informations about suggested annotation in XML
   */
  public String toXMLString(boolean proto11) {
    String attrs = " tmpId=\"" + tmpId + "\" confidence=\"" + confidence + "\"";
    return suggestion.toXMLString(true, attrs, proto11, true);
  }

}  // class SuggestionLogEntry