edu.cmu.tetradapp.ui.model.ScoreModel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tetrad-gui Show documentation
The newest version!
/*
 * Copyright (C) 2017 University of Pittsburgh.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301  USA
 */
package edu.cmu.tetradapp.ui.model;

import edu.cmu.tetrad.annotation.AnnotatedClass;
import edu.cmu.tetrad.annotation.Score;
import edu.cmu.tetrad.util.ScoreDescriptions;

import java.io.Serial;
import java.io.Serializable;

/**
 * Dec 1, 2017 11:37:56 AM
 *
 * @author Kevin V. Bui ([email protected])
 * @version $Id: $Id
 */
public class ScoreModel implements Serializable, Comparable {

    @Serial
    private static final long serialVersionUID = 2755370016466432455L;

    /**
     * The annotated class of the score.
     */
    private final AnnotatedClass score;

    /**
     * The name and description of the score.
     */
    private final String name;

    /**
     * The description of the score.
     */
    private final String description;

    /**
     * Constructor for ScoreModel.
     *
     * @param score a {@link edu.cmu.tetrad.annotation.AnnotatedClass} object
     */
    public ScoreModel(AnnotatedClass score) {
        this.score = score;
        this.name = score.annotation().name();
        this.description = ScoreDescriptions.getInstance().get(score.annotation().command());
    }

    /**
     * Compares this ScoreModel object with the specified ScoreModel object for order. Returns a negative integer, zero,
     * or a positive integer as this ScoreModel object is less than, equal to, or greater than the specified object.
     *
     * @param other the object to be compared.
     * @return a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than
     * the specified object.
     */
    @Override
    public int compareTo(ScoreModel other) {
        return this.score.annotation().name().compareTo(other.score.annotation().name());
    }

    /**
     * Returns a string representation of the ScoreModel.
     *
     * @return the name of the score.
     */
    @Override
    public String toString() {
        return this.name;
    }

    /**
     * Getter for the field score.
     *
     * @return a {@link edu.cmu.tetrad.annotation.AnnotatedClass} object
     */
    public AnnotatedClass getScore() {
        return this.score;
    }

    /**
     * Getter for the field name.
     *
     * @return a {@link java.lang.String} object
     */
    public String getName() {
        return this.name;
    }

    /**
     * Getter for the field description.
     *
     * @return a {@link java.lang.String} object
     */
    public String getDescription() {
        return this.description;
    }

}