LavTuple.java

/*
 * #!
 * %
 * Copyright (C) 2014 - 2016 Humboldt-Universität zu Berlin
 * %
 * 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 de.hub.cs.dbis.lrb.types.internal;

import backtype.storm.tuple.Fields;
import backtype.storm.tuple.Values;
import de.hub.cs.dbis.lrb.queries.utils.TopologyControl;
import de.hub.cs.dbis.lrb.types.util.ISegmentIdentifier;
import de.hub.cs.dbis.lrb.util.Time;





/**
 * {@link LavTuple} represents an intermediate result tuple; the "latest average velocity" (LAV) of a segment within the
 * last 5 minutes (ie, 'minute number'; see {@link Time#getMinute(short)}).<br />
 * <br />
 * It has the following attributes: TIME, XWAY, SEGMENT, DIR, LAV
 * <ul>
 * <li>TIME: the 'minute number' (in LRB seconds) of the LAV value</li>
 * <li>XWAY: the expressway for the LAV value</li>
 * <li>SEGMENT: the segment number for the LAV value</li>
 * <li>DIR: the direction for the LAV value</li>
 * <li>LAV: the latest average velocity of the segment identified by XWAY, SEGMENT, DIR</li>
 * </ul>
 * 
 * @author mjsax
 */
public final class LavTuple extends Values implements ISegmentIdentifier {
	private static final long serialVersionUID = 1726682629621494657L;
	
	// attribute indexes
	/** The index of the TIME attribute. */
	public final static int TIME_IDX = 0;
	
	/** The index of the XWAY attribute. */
	public final static int XWAY_IDX = 1;
	
	/** The index of the SEGMENT attribute. */
	public final static int SEG_IDX = 2;
	
	/** The index of the DIR attribute. */
	public final static int DIR_IDX = 3;
	
	/** The index of the LAV attribute. */
	public final static int LAV_IDX = 4;
	
	
	
	public LavTuple() {}
	
	/**
	 * Instantiates a new {@link LavTuple} for the given attributes.
	 * 
	 * @param time
	 *            the 'minute number' (in LRB seconds) of the speed average
	 * @param xway
	 *            the expressway the vehicle is on
	 * @param segment
	 *            the segment number the vehicle is in
	 * @param direction
	 *            the vehicle's driving direction
	 * @param lav
	 *            the latest average velocity of a segment
	 */
	public LavTuple(Short time, Integer xway, Short segment, Short direction, Integer lav) {
		assert (time != null);
		assert (xway != null);
		assert (segment != null);
		assert (direction != null);
		assert (lav != null);
		
		super.add(TIME_IDX, time);
		super.add(XWAY_IDX, xway);
		super.add(SEG_IDX, segment);
		super.add(DIR_IDX, direction);
		super.add(LAV_IDX, lav);
		
		assert (super.size() == 5);
	}
	
	
	
	/**
	 * Returns the timestamp of this {@link LavTuple}.
	 * 
	 * @return the timestamp of this tuple
	 */
	public final Short getTime() {
		return (Short)super.get(TIME_IDX);
	}
	
	/**
	 * Returns the 'minute number' of this {@link LavTuple}.
	 * 
	 * @return the 'minute number' of this tuple
	 */
	public final short getMinuteNumber() {
		return Time.getMinute(this.getTime().shortValue());
	}
	
	/**
	 * Returns the expressway ID of this {@link LavTuple}.
	 * 
	 * @return the expressway of this tuple
	 */
	@Override
	public final Integer getXWay() {
		return (Integer)super.get(XWAY_IDX);
	}
	
	/**
	 * Returns the segment of this {@link LavTuple}.
	 * 
	 * @return the segment of this tuple
	 */
	@Override
	public final Short getSegment() {
		return (Short)super.get(SEG_IDX);
	}
	
	/**
	 * Returns the vehicle's direction of this {@link LavTuple}.
	 * 
	 * @return the direction of this tuple
	 */
	@Override
	public final Short getDirection() {
		return (Short)super.get(DIR_IDX);
	}
	
	/**
	 * Returns the latest average velocity (LAV) of this {@link LavTuple}.
	 * 
	 * @return the latest average velocity (LAV) of this tuple
	 */
	public final Integer getLav() {
		return (Integer)super.get(LAV_IDX);
	}
	
	/**
	 * Returns the schema of a {@link LavTuple}.
	 * 
	 * @return the schema of a {@link LavTuple}
	 */
	public static Fields getSchema() {
		return new Fields(TopologyControl.MINUTE_FIELD_NAME, TopologyControl.XWAY_FIELD_NAME,
			TopologyControl.SEGMENT_FIELD_NAME, TopologyControl.DIRECTION_FIELD_NAME,
			TopologyControl.LAST_AVERAGE_SPEED_FIELD_NAME);
	}
	
}