org.graphstream.stream.sync.SourceTime Maven / Gradle / Ivy

/*
 * This file is part of GraphStream .
 * 
 * GraphStream is a library whose purpose is to handle static or dynamic
 * graph, create them from scratch, file or any source and display them.
 * 
 * This program is free software distributed under the terms of two licenses, the
 * CeCILL-C license that fits European law, and the GNU Lesser General Public
 * License. You can  use, modify and/ or redistribute the software under the terms
 * of the CeCILL-C license as circulated by CEA, CNRS and INRIA at the following
 * URL  or under the terms of the GNU LGPL as published by
 * the Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 * 
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL-C and LGPL licenses and that you accept their terms.
 */

/**
 * @since 2009-04-17
 * 
 * @author Yoann Pigné 
 * @author Antoine Dutot 
 * @author Guilhelm Savin 
 */
package org.graphstream.stream.sync;

public class SourceTime {
	protected String sourceId;
	/**
	 * Current value of the time for this source.
	 */
	protected long currentTimeId;
	/**
	 * 
	 */
	protected SinkTime sinkTime;

	/**
	 * Create a new SourceTime for a given id. Current time id is set to 0.
	 */
	public SourceTime() {
		this(0);
	}

	/**
	 * Create a new SourceTime for a given id and a given time.
	 * 
	 * @param currentTimeId
	 */
	public SourceTime(long currentTimeId) {
		this(null, currentTimeId, null);
	}

	public SourceTime(String sourceId) {
		this(sourceId, 0, null);
	}

	public SourceTime(String sourceId, SinkTime sinkTime) {
		this(sourceId, 0, sinkTime);
	}

	/**
	 * Create a new SourceTime for a given id and a given time.
	 * 
	 * @param currentTimeId
	 */
	public SourceTime(String sourceId, long currentTimeId) {
		this(sourceId, currentTimeId, null);
	}

	public SourceTime(String sourceId, long currentTimeId, SinkTime sinkTime) {
		this.sourceId = sourceId;
		this.currentTimeId = currentTimeId;
		this.sinkTime = sinkTime;
	}

	public SinkTime getSinkTime() {
		return sinkTime;
	}

	public String getSourceId() {
		return sourceId;
	}

	public void setSourceId(String sourceId) {
		this.sourceId = sourceId;
	}

	public void setSinkTime(SinkTime st) {
		this.sinkTime = st;
	}

	public long newEvent() {
		currentTimeId++;

		if (sinkTime != null)
			sinkTime.setTimeFor(sourceId, currentTimeId);

		return currentTimeId;
	}
}