001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.ml.annotation;
031
032/**
033 * An annotation that was produced automatically with a given confidence.
034 * 
035 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
036 * 
037 * @param <ANNOTATION>
038 *            Type of annotation
039 */
040public class ScoredAnnotation<ANNOTATION> implements Comparable<ScoredAnnotation<ANNOTATION>> {
041        /**
042         * The annotation
043         */
044        public ANNOTATION annotation;
045
046        /**
047         * The confidence of the annotation
048         */
049        public float confidence;
050
051        /**
052         * Construct with the given annotation and confidence
053         * 
054         * @param annotation
055         *            the annotation
056         * @param confidence
057         *            the confidence level
058         */
059        public ScoredAnnotation(ANNOTATION annotation, float confidence) {
060                this.annotation = annotation;
061                this.confidence = confidence;
062        }
063
064        @Override
065        public String toString() {
066                return "(" + annotation.toString() + ", " + confidence + ")";
067        }
068
069        @Override
070        public int compareTo(ScoredAnnotation<ANNOTATION> o) {
071                if (confidence < o.confidence)
072                        return -1;
073                if (confidence > o.confidence)
074                        return 1;
075                return 0;
076        }
077}