001/*-------------------------------------------------------------------------+
002|                                                                          |
003| Copyright 2005-2011 the ConQAT Project                                   |
004|                                                                          |
005| Licensed under the Apache License, Version 2.0 (the "License");          |
006| you may not use this file except in compliance with the License.         |
007| You may obtain a copy of the License at                                  |
008|                                                                          |
009|    http://www.apache.org/licenses/LICENSE-2.0                            |
010|                                                                          |
011| Unless required by applicable law or agreed to in writing, software      |
012| distributed under the License is distributed on an "AS IS" BASIS,        |
013| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
014| See the License for the specific language governing permissions and      |
015| limitations under the License.                                           |
016+-------------------------------------------------------------------------*/
017package org.conqat.lib.commons.datamining;
018
019import org.conqat.lib.commons.assertion.CCSMAssert;
020
021/**
022 * A recommendation produced by a recommender, encapsulating an item and a
023 * confidence level.
024 */
025public class Recommendation<T> {
026
027        /** The recommended item */
028        private T item;
029
030        /** The confidence of this recommendation */
031        private double confidence;
032
033        /** Constructor */
034        public Recommendation(T item, double confidence) {
035                CCSMAssert.isNotNull(item);
036                CCSMAssert.isTrue(confidence >= 0 && confidence <= 1, "Confidence must be in [0,1]");
037                this.item = item;
038                this.confidence = confidence;
039        }
040
041        /** Returns the item. */
042        public T getItem() {
043                return item;
044
045        }
046
047        /** Returns the confidence. */
048        public double getConfidence() {
049                return confidence;
050        }
051
052        /** {@inheritDoc} */
053        @Override
054        public String toString() {
055                return item + " (" + confidence + ")";
056        }
057}