/**
 * Copyright (c) 2008--2015 Red Hat, Inc.
 *
 * This software is licensed to you under the GNU General Public License,
 * version 2 (GPLv2). There is NO WARRANTY for this software, express or
 * implied, including the implied warranties of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. You should have received a copy of GPLv2
 * along with this software; if not, see
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
 *
 * Red Hat trademarks are not licensed under GPLv2. No permission is
 * granted to use or replicate Red Hat trademarks that are incorporated
 * in this software or its documentation.
 */

package com.redhat.satellite.search.index;


/**
 * PackageResult
 * @version $Rev$
 */
public class Result {
    private int rank = 0;
    private String id = "";
    private String name = "";
    private float score = 0.0f;

    /** TODO:
     * matchingField could be used to possibly give more info into what made
     * lucene think this was a good match..
     */
    private String matchingField = "";
    private String matchingFieldValue = "";
    /**
     * Constructor
     */
    public Result() {
        rank = -1;
        id = "";
        name = "";
        score = 0;
    }

    /**
     * Constructs a pre populated
     * @param r rank
     * @param idIn package id
     * @param nameIn package name
     */
    public Result(int r, String idIn, String nameIn, float scoreIn) {
        rank = r;
        id = idIn;
        name = nameIn;
        score = scoreIn;
    }

    /**
     * Sets the rank
     * @param rankIn rank
     */
    public void setRank(int rankIn) {
        rank = rankIn;
    }
    /**
     * Returns the rank.
     * @return the rank.
     */
    public int getRank() {
        return rank;
    }

    /**
     * Sets the id
     * @param idIn id
     */
    public void setId(String idIn) {
        id = idIn;
    }

    /**
     * Returns the package id.
     * @return the package id.
     */
    public String getId() {
        return id;
    }

    /**
     * Sets the name
     * @param nameIn name
     */
    public void setName(String nameIn) {
        name = nameIn;
    }
    /**
     * Returns the package name.
     * @return the package name.
     */
    public String getName() {
        return name;
    }

    /**
     * Sets the score from lucene
     * @param scoreIn score
     */
    public void setScore(float scoreIn) {
        score = scoreIn;
    }
    /**
     * Returns the score.
     * @return the score.
     */
    public float getScore() {
        return score;
    }

    /**
     * @return the matchingField
     */
    public String getMatchingField() {
        return matchingField;
    }

    /**
     * @param matchingFieldIn the matchingField to set
     */
    public void setMatchingField(String matchingFieldIn) {
        this.matchingField = matchingFieldIn;
    }
    /**
     * @return the matchingFieldValue
     */
    public String getMatchingFieldValue() {
        return matchingFieldValue;
    }
    /**
     * @param matchingFieldValueIn the matchingFieldValue to set
     */
    public void setMatchingFieldValue(String matchingFieldValueIn) {
        this.matchingFieldValue = matchingFieldValueIn;
    }
    /**
     * @return the string representation of this object
    **/
    public String toString() {
        return "Name = " + getName() + ", Id = " + getId() + ", Score = " + getScore() +
            ", Rank = " + getRank();
    }

}