org.pharmgkb.common.comparator.AbstractComparator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pgkb-common Show documentation

Common code shared among all PharmGKB projects.

The newest version!

package org.pharmgkb.common.comparator;

import java.util.Comparator;
import com.google.common.base.Preconditions;


/**
 * Abstract comparator allowing sort order to be specified.
 *
 * @author Mark Woon
 */
public abstract class AbstractComparator implements Comparator{
  private SortOrder m_order = SortOrder.NATURAL;


  /**
   * Gets the order in which results should be returned.

   * @return the order in which results should be returned
   */
  public final SortOrder getOrder() {
    return m_order;
  }

  /**
   * Sets the order in which results should be returned.

   * @param order the order in which results should be returned
   */
  protected final void setOrder(SortOrder order) {
    Preconditions.checkNotNull(order);
    m_order = order;
  }


  /**
   * Modifies the return value appropriately based on sort direction.
   *
   * @param val the value to modify
   * @return the value based on sort direction
   */
  protected final int modReturn(int val) {
    if (m_order == SortOrder.REVERSE) {
      return reverse(val);
    }
    return val;
  }

  /**
   * Reverses the return value.
   *
   * @param val the value to modify
   * @return the reversed value
   */
  protected final int reverse(int val) {
    if (val > 0) {
      return -1;
    } else if (val < 0) {
      return 1;
    }
    return 0;
  }
}