io.github.repir.TestSet.Metric.QueryMetric Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of RepIR Show documentation

The newest version!

package io.github.repir.TestSet.Metric;

import io.github.repir.Retriever.Query;
import io.github.repir.TestSet.TestSet;
import io.github.repir.tools.lib.ClassTools;
import io.github.repir.tools.lib.Log;
import java.io.IOException;
import java.lang.reflect.Constructor;

/**
 * Computes a single metric for a query.
 * @author jer
 */
public abstract class QueryMetric {
   public static Log log = new Log(QueryMetric.class);
   int rank;

   public QueryMetric() {
   }
   
   /**
    * @param rank considers only the top-n positions for the metric. 
    */
   public QueryMetric(int rank) {
      this.rank = rank;
   }

   /**
    * @param testset
    * @param query
    * @return The metric for the given {@link Query}, given the relevance judgments
    * in the {@link TestSet}.
    */
   public abstract double calculate(TestSet testset, Query query) throws IOException ;
   
   public static QueryMetric create(String metricclass) {
        try {
            Class clazz = ClassTools.toClass(metricclass, QueryMetric.class.getPackage().getName());
            Constructor assignableConstructor = ClassTools.getAssignableConstructor(clazz, QueryMetric.class);
            return (QueryMetric)ClassTools.construct(assignableConstructor);
        } catch (ClassNotFoundException ex) {
            log.fatalexception(ex, "create() could not construct %s", metricclass);
        }
        return null;
   }
}