stream.counter.StaticFrequentItemModel 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 elements counted in the stream
 * which exceeded a given frequency threshold.
 * 
 *
 * 
 * There are two versions of the threshold stream counting interface. In the
 * {@link DynamicFrequentItemModel} interface the user can specify the
 * threshold on method invokation. In this version, the {@link StaticFrequentItemModel}
 * you have to specify the threshold on instantiation.
 * 
 *
 * @author Marcin Skirzynski, Benedikt Kulmann
 *
 * @param 	Generic class of the elements which should be counted
 */
public interface StaticFrequentItemModel extends Counter {

    /**
     * 
     * Returns all elements counted in the stream which exceed the
     * threshold which has been defined at instantiation time.
     * 
     *
     * @return all elements which exceed the threshold
     */
    public Collection getFrequentItems();
}