cz.cuni.mff.d3s.spl.data.DataSource 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

/*
 * Copyright 2015 Charles University in Prague
 * Copyright 2015 Vojtech Horky
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package cz.cuni.mff.d3s.spl.data;

/** Provides access to series of a performance data.
 * 
 * It is expected that the data are continuously changing (new samples
 * coming in), user gets a consistent snapshot only through use of the
 * makeSnapshot() call.
 */
public interface DataSource {

	/** Get consistent view on this data source.
	 * 
	 * @return Immutable snapshot of the data.
	 */
	DataSnapshot makeSnapshot();

	/** Get consistent view on this data source.
	 *
	 * @param skip Skip this number of samples from the beginning.
	 * @return Immutable snapshot of the data.
	 */
	DataSnapshot makeSnapshot(int skip);

	/** Get consistent view on this data source.
	 *
	 * @param skip Skip this percentage of samples from the beginning.
	 * @return Immutable snapshot of the data.
	 */
	DataSnapshot makeSnapshot(double skip);

	/** Get units of the data.
	 *
	 * @return String representation of data units.
	 */
	String getUnits();
}