com.aliasi.classify.Classification Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aliasi-lingpipe Show documentation

This is the original Lingpipe: http://alias-i.com/lingpipe/web/download.html There were not made any changes to the source code.

There is a newer version: 4.1.2-JL1.0

Show newest version

/*
 * LingPipe v. 4.1.0
 * Copyright (C) 2003-2011 Alias-i
 *
 * This program is licensed under the Alias-i Royalty Free License
 * Version 1 WITHOUT ANY WARRANTY, without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the Alias-i
 * Royalty Free License Version 1 for more details.
 * 
 * You should have received a copy of the Alias-i Royalty Free License
 * Version 1 along with this program; if not, visit
 * http://alias-i.com/lingpipe/licenses/lingpipe-license-1.txt or contact
 * Alias-i, Inc. at 181 North 11th Street, Suite 401, Brooklyn, NY 11211,
 * +1 (718) 290-9170.
 */

package com.aliasi.classify;

/**
 * A Classification provides a first-best category.
 * Subclasses provide n-best results with numerical scores of
 * various interpretations.
 *
 * @author Bob Carpenter
 * @version 3.8
 * @since   LingPipe2.0
 */
public class Classification {

    private final String mBestCategory;

    /**
     * Construct a classification with the specified first-best
     * category.  
     *
     * @param bestCategory Category of this classification.
     * @throws IllegalArgumentException If the category is null.
     */
    public Classification(String bestCategory) {
        if (bestCategory == null) {
            String msg = "Category cannot be null for classifiers.";
            throw new IllegalArgumentException(msg);
        }
        mBestCategory = bestCategory;
    }

    /**
     * Returns the best-scoring category.
     *
     * @return Best category for this classification.
     */
    public String bestCategory() {
        return mBestCategory;
    }

    /**
     * Returns a string-based representation of the first-best
     * category of this classification.
     *
     * @return A string-based representation of this classification.
     */
    @Override
    public String toString() {
        return "Rank    Category\n1=" + bestCategory();
    }

}