edu.stanford.protege.webprotege.search.SearchResultMatchPosition Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of webprotege-backend-api Show documentation
The newest version!
package edu.stanford.protege.webprotege.search;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.auto.value.AutoValue;

import javax.annotation.Nonnull;
import java.util.Comparator;

/**
 * Matthew Horridge
 * Stanford Center for Biomedical Informatics Research
 * 2020-07-17
 */

@AutoValue
public abstract class SearchResultMatchPosition implements Comparable {

    private static final Comparator comparator
            = Comparator.comparing((SearchResultMatchPosition::getStart))
                        .thenComparing(SearchResultMatchPosition::getEnd);

    /**
     * The JSON property name for the match position start
     */
    public static final String START = "start";

    /**
     * The JSON property name for the match position end
     */
    public static final String END = "end";

    /**
     * Gets a search match position starting at the specified start index (inclusive)
     * and ending the specified end index (exclusive).  This works in the same way that
     * {@link String#substring(int, int)} works.
     *
     * @param start The start position of the match (inclusive)
     * @param end   The end position of the match (exclusive)
     * @return The match position.
     */
    @JsonCreator
    @Nonnull
    public static SearchResultMatchPosition get(@JsonProperty(START) int start, @JsonProperty(END) int end) {
        return new AutoValue_SearchResultMatchPosition(start, end);
    }

    /**
     * Gets the start of the search match.  This is the index of the first character that is matched (inclusive).
     *
     * @return The start of the search match.
     */
    @JsonProperty(START)
    public abstract int getStart();

    /**
     * Gets the end of the search match.  This is the index after the last index matched (exclusive), in the
     * same way that substring ({@link String#substring(int, int)}) positions work.
     *
     * @return The end of the search match
     */
    @JsonProperty(END)
    public abstract int getEnd();

    @Override
    public int compareTo(SearchResultMatchPosition o) {
        return comparator.compare(this, o);
    }
}