cz.cuni.mff.d3s.spl.data.readers.RevisionReader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spl-evaluation-java Show documentation

Stochastice Performance Logic is a formalism for capturing performance assumptions. It is, for example, possible to capture assumption that newer version of a function bar is faster than the previous version or that library foobar is faster than library barfoo when rendering antialiased text. The purpose of this framework is to allow evaluation of SPL formulas inside Java applications.

There is a newer version: 1.0.4

Show newest version

package cz.cuni.mff.d3s.spl.data.readers;

import cz.cuni.mff.d3s.spl.data.DataInfo;
import cz.cuni.mff.d3s.spl.data.DataSource;

import java.io.File;
import java.util.Map;


/**
 * Provides unified interface to read data revision from files.
 *
 * Each implementation will specify it's semantics in detail,
 * but common idea is that each reader processes data from
 * given file(s) and returns them as a map with method/benchmark
 * name as a key and data as a value.
 */
public interface RevisionReader {

	/**
	 * Read one revision of data from given files. There shouldn't be
	 * more revisions of the same benchmark/method/... data in one file
	 * or you shouldn't pass multiple files containing the same data with
	 * different revisions.
	 *
	 * @param files Input files with raw data
	 * @return Processed data as a map grouped by benchmark/method/...
	 *          If there is no info about name in the data, "default"
	 *          identifier is used instead.
	 */
	Map readRevision(File... files) throws DataReader.ReaderException;
}