com.aliasi.classify.Classified 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 {@code Classified} represents an object that has been classified
 * with a first-best classification.  Classified objects are used for
 * training classifiers.
 *
 * @author  Bob Carpenter
 * @version 3.9.1
 * @since   LingPipe3.9.1
 * @param  the type of object classified
 */
public class Classified {

    private final E mObject;
    private final Classification mClassification;

    /**
     * Construct a classified object consisting of the specified
     * object and classification.
     *
     * @param object Object being classified.
     * @param c Classification of object.
     */
    public Classified(E object, Classification c) {
        mObject = object;
        mClassification = c;
    }

    /**
     * Return the object that is classified.
     *
     * @return The classified object.
     */
    public E getObject() {
        return mObject;
    }

    /**
     * Return the classification of the object.
     *
     * @return The classification.
     */
    public Classification getClassification() {
        return mClassification;
    }

    /**
     * Returns a string-based representation of the classified
     * object and best category.
     *
     * @return String-based representation of the classified object.
     */
    @Override
    public String toString() {
        return mObject + ":" + mClassification.bestCategory();
    }


}