kieker.tools.opad.timeseries.TimeSeries Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kieker Show documentation
Kieker: Application Performance Monitoring and Dynamic Software Analysis
There is a newer version: 2.0.2
/***************************************************************************
 * Copyright 2015 Kieker Project (http://kieker-monitoring.net)
 *
 * 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 kieker.tools.opad.timeseries;

import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.TimeUnit;

/**
 * @author Andre van Hoorn, Tobias Rudolph, Andreas Eberlein
 *
 * @since 1.10
 *
 * @param 
 *            The type of the time series.
 */
public class TimeSeries implements ITimeSeries {

	private volatile long startTime;
	private final TimeUnit timeSeriesTimeUnit;
	private long nextTime;
	private final long deltaTime;
	private final TimeUnit deltaTimeUnit;
	private final int frequency;
	private final int capacity;
	private final TimeSeriesPointsBuffer> points;
	private final long timeSeriesStepSize;

	/**
	 * @param startTime
	 *            start time of Timeseries
	 * @param timeSeriesTimeUnit
	 *            time unit of the startTime
	 * @param deltaTime
	 *            time of timeseries
	 * @param deltaTimeUnit
	 *            Time unit
	 * @param capacity
	 *            length of timeseries
	 */
	public TimeSeries(final long startTime, final TimeUnit timeSeriesTimeUnit, final long deltaTime, final TimeUnit deltaTimeUnit, final int frequency,
			final int capacity) {
		this.startTime = startTime;
		this.timeSeriesTimeUnit = timeSeriesTimeUnit;
		this.deltaTime = deltaTime;
		this.deltaTimeUnit = deltaTimeUnit;
		this.frequency = frequency;
		this.capacity = capacity;
		this.timeSeriesStepSize = timeSeriesTimeUnit.convert(this.deltaTime, this.deltaTimeUnit);

		if (ITimeSeries.INFINITE_CAPACITY == capacity) {
			this.points = new TimeSeriesPointsBuffer>();
		} else {
			this.points = new TimeSeriesPointsBuffer>(this.capacity);
		}

		this.nextTime = this.startTime;
	}

	/**
	 * @param startTime
	 *            start time of Timeseries
	 * @param timeSeriesTimeUnit
	 *            time unit of the startTime
	 * @param deltaTime
	 *            time of timeseries
	 * @param deltaTimeUnit
	 *            Time unit
	 * @param capacity
	 *            length of timeseries
	 */
	public TimeSeries(final long startTime, final TimeUnit timeSeriesTimeUnit, final long deltaTime, final TimeUnit deltaTimeUnit, final int capacity) {
		// frequency = 24 best practice
		this(startTime, timeSeriesTimeUnit, deltaTime, deltaTimeUnit, 24, capacity);
	}

	/**
	 * @param startTime
	 *            start time of Timeseries
	 * @param timeSeriesTimeUnit
	 *            time unit of the startTime
	 * @param deltaTime
	 *            time of timeseries
	 * @param deltaTimeUnit
	 *            Time unit
	 */
	public TimeSeries(final long startTime, final TimeUnit timeSeriesTimeUnit, final long deltaTime, final TimeUnit deltaTimeUnit) {
		this(startTime, timeSeriesTimeUnit, deltaTime, deltaTimeUnit, ITimeSeries.INFINITE_CAPACITY);
	}

	/**
	 * Constructor using the timeunit as unit for internal usage and deltatime time unit.
	 * Furthermore using infinite capacity and a frequency of 24 by default.
	 */
	public TimeSeries(final long startTime, final TimeUnit timeUnit, final long deltaTime) {
		this(startTime, timeUnit, deltaTime, timeUnit);
	}

	/**
	 * Constructor using the timeunit as unit for internal usage and deltatime time unit.
	 */
	public TimeSeries(final long startTime, final TimeUnit timeUnit, final long deltaTime, final int frequency,
			final int capacity) {
		this(startTime, timeUnit, deltaTime, timeUnit, frequency, capacity);
	}

	public TimeSeries(final long startTime, final TimeUnit timeUnit, final long deltaTime, final int frequency) {
		this(startTime, timeUnit, deltaTime, timeUnit, frequency, ITimeSeries.INFINITE_CAPACITY);
	}

	@Override
	public long getStartTime() {
		return this.startTime;
	}

	@Override
	public TimeUnit getTimeSeriesTimeUnit() {
		return this.timeSeriesTimeUnit;
	}

	@Override
	public long getDeltaTime() {
		return this.deltaTime;
	}

	@Override
	public TimeUnit getDeltaTimeUnit() {
		return this.deltaTimeUnit;
	}

	/**
	 * Returns the step size between each item in the timeseries. The {@link TimeUnit} of the stepSize is equal to the {@link #timeSeriesTimeUnit}.
	 *
	 * @return step size
	 */
	public long getStepSize() {
		return this.timeSeriesStepSize;
	}

	/**
	 * @param value
	 *            value which should append to timeseries
	 *
	 * @return tspoint
	 */
	@Override
	public ITimeSeriesPoint append(final T value) {
		final ITimeSeriesPoint point;

		synchronized (value) {
			point = new TimeSeriesPoint(this.nextTime, value);
			this.points.add(point);
			this.startTime = this.points.peek().getTime(); // we have a bounded buffer so the first element might be gone
			this.nextTime = this.nextTime + this.timeSeriesStepSize;
		}
		return point;
	}

	@Override
	public List> getPoints() {
		return new ArrayList>(this.points);
	}

	@Override
	public List getValues() {
		final List> pointsCopy = this.getPoints();
		final List retVals = new ArrayList(pointsCopy.size());
		for (final ITimeSeriesPoint curPoint : pointsCopy) {
			retVals.add(curPoint.getValue());
		}
		return retVals;
	}

	@Override
	public int getCapacity() {
		return this.capacity;
	}

	@Override
	public int size() {
		return this.points.getSize();
	}

	@Override
	public long getEndTime() {
		if (this.getPoints().isEmpty()) {
			throw new IllegalStateException("The TimeSeries is empty, so no end time can be returned.");
		} else {
			return this.getStartTime() + (this.timeSeriesStepSize * (this.getPoints().size() - 1));
		}
	}

	@Override
	public List> appendAll(final T[] values) {
		final List> retVals = new ArrayList>(values.length);
		for (final T value : values) {
			retVals.add(this.append(value));
		}
		return retVals;
	}

	@Override
	public String toString() {
		final StringBuffer buf = new StringBuffer();
		buf.append("Time Series with delta: " + this.deltaTime + " " + this.deltaTimeUnit + " starting at: " + this.getStartTime() + " " + this.timeSeriesTimeUnit);
		for (final ITimeSeriesPoint curPoint : this.getPoints()) {
			buf.append(curPoint);
		}
		return buf.toString();
	}

	@Override
	public int getFrequency() {
		return this.frequency;
	}
}