querqy.rewrite.commonrules.model.Action Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of querqy-core Show documentation
Querqy library for query rewriting: Querqy Core
There is a newer version: 3.18.1
/**
 *
 */
package querqy.rewrite.commonrules.model;

import java.util.Objects;

/**
 * An Action represents all Instructions triggered for specific input positions.
 * It references the sequence of query terms that matched the rule. If there is
 * more than one term in a single position it's possible that more than one
 * sequence matched the input. In that case a separate Action could be created
 * for the same position.
 *
 * @author rene
 *
 */
public class Action {

   final Instructions instructions;
   final TermMatches termMatches;
   final int startPosition;
   final int endPosition; // exclusive

   public Action(final Instructions instructions, final TermMatches termMatches, final int startPosition,
                 final int endPosition) {
      this.instructions = Objects.requireNonNull(instructions, "instructions must not be null");
      this.termMatches = termMatches;
      this.startPosition = startPosition;
      this.endPosition = endPosition;
   }

   @Override
   public int hashCode() {
      final int prime = 31;
      int result = 1;
      result = prime * result + endPosition;
      result = prime * result
            + ((instructions == null) ? 0 : instructions.hashCode());
      result = prime * result + startPosition;
      result = prime * result + ((termMatches == null) ? 0 : termMatches.hashCode());
      return result;
   }

   @Override
   public boolean equals(Object obj) {
      if (this == obj)
         return true;
      if (obj == null)
         return false;
      if (getClass() != obj.getClass())
         return false;
      Action other = (Action) obj;
      if (endPosition != other.endPosition)
         return false;
      if (instructions == null) {
         if (other.instructions != null)
            return false;
      } else if (!instructions.equals(other.instructions))
         return false;
      if (startPosition != other.startPosition)
         return false;
      if (termMatches == null) {
         if (other.termMatches != null)
            return false;
      } else if (!termMatches.equals(other.termMatches))
         return false;
      return true;
   }

   @Override
   public String toString() {
      return "Action [instructions=" + instructions + ", terms=" + termMatches
            + ", startPosition=" + startPosition + ", endPosition="
            + endPosition + "]";
   }

   public Instructions getInstructions() {
      return instructions;
   }

   public TermMatches getTermMatches() {
      return termMatches;
   }

   public int getStartPosition() {
      return startPosition;
   }

   public int getEndPosition() {
      return endPosition;
   }

}