stream.counter.StaticTopKModel Maven / Gradle / Ivy

Go to download
package stream.counter;

import java.util.Collection;

/**
 * 
 * Interface which extends the {@link Counter} interface by an
 * output method. This output method is intended for all stream counting
 * algorithms which return a collection of TopK elements counted in the stream
 * 
 * There are two versions of this interface, {@link DynamicTopKModel} provides
 * a method where the parameter k has to be provided on method invokation
 * while {@link StaticTopKModel} requires this parameter on object instantiation.
 *
 * @author Marcin Skirzynski, Benedikt Kulmann
 *
 * @param  Generic class of the elements which should be counted
 */
public interface StaticTopKModel extends Counter {

    /**
     * Returns a collection with all Top K Elements. 
     * @return all Elements which fit the Top K condition.
     */
    public Collection getTopK();
}