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.experiment.evaluation.retrieval;
031
032import java.util.List;
033import java.util.Map;
034import java.util.Set;
035
036import org.openimaj.data.identity.Identifiable;
037import org.openimaj.experiment.evaluation.AnalysisResult;
038
039/**
040 * A {@link RetrievalAnalyser} is used to analyse the raw search results from a
041 * {@link RetrievalEngine} in the context of a {@link RetrievalEvaluator} and to
042 * produce an {@link AnalysisResult} describing the performance of the
043 * {@link RetrievalEngine}.
044 * 
045 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
046 * 
047 * @param <RESULT>
048 *            the type of {@link AnalysisResult} produced.
049 * @param <QUERY>
050 *            the type of the queries
051 * @param <DOCUMENT>
052 *            the type of the documents
053 */
054public interface RetrievalAnalyser<RESULT extends AnalysisResult, QUERY, DOCUMENT extends Identifiable>
055{
056        /**
057         * Analyse ranked results from a {@link RetrievalEngine} against a
058         * ground-truth set of relevant results and produce an
059         * {@link AnalysisResult} which can be read by a human.
060         * 
061         * @param results
062         *            the results per query from the {@link RetrievalEngine}.
063         * @param relevant
064         *            the ground-truth relevant documents per query.
065         * @return the results of the analysis
066         */
067        public RESULT analyse(Map<QUERY, List<DOCUMENT>> results, Map<QUERY, Set<DOCUMENT>> relevant);
068}