org.apache.mahout.cf.taste.recommender.RecommendedItem.java Source code

Introduction

Here is the source code for org.apache.mahout.cf.taste.recommender.RecommendedItem.java

Source

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.mahout.cf.taste.recommender;

/**
 * <p>
 * Implementations encapsulate items that are recommended, and include the item recommended and a value
 * expressing the strength of the preference.
 * </p>
 */
public interface RecommendedItem {

    /** @return the recommended item ID */
    long getItemID();

    /**
     * <p>
     * A value expressing the strength of the preference for the recommended item. The range of the values
     * depends on the implementation. Implementations must use larger values to express stronger preference.
     * </p>
     * 
     * @return strength of the preference
     */
    float getValue();

}