SearchMatch.java

/*
 * Copyright (c) 2013, the Dart project authors.
 * 
 * Licensed under the Eclipse Public License v1.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 * 
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
package com.google.dart.engine.search;

import com.google.common.base.Objects;
import com.google.dart.engine.element.Element;
import com.google.dart.engine.utilities.source.SourceRange;

import java.text.Collator;
import java.util.Comparator;

/**
 * Instances of the class <code>SearchMatch</code> represent a match found by a search engine.
 * 
 * @coverage dart.engine.search
 */
public class SearchMatch {
  /**
   * The quality of the match.
   */
  private final MatchQuality quality;

  /**
   * The kind of the match.
   */
  private final MatchKind kind;

  /**
   * The element containing the source range that was matched.
   */
  private final Element element;

  /**
   * The source range that was matched.
   */
  private final SourceRange sourceRange;

  /**
   * Is {@code true} if field or method access is done using qualifier.
   */
  private boolean qualified;

  /**
   * A comparator that can be used to sort the matches based on the names of the matched elements.
   */
  public static final Comparator<SearchMatch> SORT_BY_ELEMENT_NAME = new Comparator<SearchMatch>() {
    @Override
    public int compare(SearchMatch firstMatch, SearchMatch secondMatch) {
      String firstName = firstMatch.getElement().getDisplayName();
      String secondName = secondMatch.getElement().getDisplayName();
      return Collator.getInstance().compare(firstName, secondName);
    }
  };

  /**
   * Initialize a newly created search match.
   * 
   * @param quality the quality of the match
   * @param kind the kind of the match
   * @param element the element containing the source range that was matched
   * @param sourceRange the source range of the match within the element's resource
   */
  public SearchMatch(MatchQuality quality, MatchKind kind, Element element, SourceRange sourceRange) {
    this.quality = quality;
    this.kind = kind;
    this.element = element;
    this.sourceRange = sourceRange;
  }

  @Override
  public boolean equals(Object obj) {
    if (!(obj instanceof SearchMatch)) {
      return false;
    }
    if (obj == this) {
      return true;
    }
    SearchMatch o = (SearchMatch) obj;
    return kind == o.kind && quality == o.quality && qualified == o.qualified
        && Objects.equal(sourceRange, o.sourceRange) && Objects.equal(element, o.element);
  }

  /**
   * Return the element containing the source range that was matched.
   * 
   * @return the element containing the source range that was matched
   */
  public Element getElement() {
    return element;
  }

  /**
   * Return the kind of the match. The kind is only used with reference matches and is an indication
   * of the kind of reference that was found.
   * 
   * @return the kind of the match
   */
  public MatchKind getKind() {
    return kind;
  }

  /**
   * Return the quality of the match. The quality is an indication of how closely the match matches
   * the original search criteria.
   * 
   * @return the quality of the match
   */
  public MatchQuality getQuality() {
    return quality;
  }

  /**
   * Return the source range that was matched.
   * 
   * @return the source range that was matched
   */
  public SourceRange getSourceRange() {
    return sourceRange;
  }

  @Override
  public int hashCode() {
    return Objects.hashCode(element, sourceRange, kind);
  }

  /**
   * @return the {@code true} if field or method access is done using qualifier.
   */
  public boolean isQualified() {
    return qualified;
  }

  /**
   * Specifies if field or method access is done using qualifier.
   */
  public void setQualified(boolean qualified) {
    this.qualified = qualified;
  }

  @Override
  public String toString() {
    StringBuilder builder = new StringBuilder();
    builder.append("SearchMatch(kind="); //$NON-NLS-1$
    builder.append(kind);
    builder.append(", quality="); //$NON-NLS-1$
    builder.append(quality);
    builder.append(", element="); //$NON-NLS-1$
    builder.append(element.getDisplayName());
    builder.append(", range="); //$NON-NLS-1$
    builder.append(sourceRange);
    builder.append(", qualified="); //$NON-NLS-1$
    builder.append(qualified);
    builder.append(")"); //$NON-NLS-1$
    return builder.toString();
  }
}