[FLINK-2550] Change Window API constructs to use Time instead of long

This covers assigners/triggers/evictors.
apache · Oct 5, 2015 · 8c2c769 · 8c2c769
1 parent 833b347
commit 8c2c769
Show file tree

Hide file tree

Showing 18 changed files with 144 additions and 115 deletions.
diff --git a/...nk-streaming-core/src/main/java/org/apache/flink/streaming/api/datastream/DataStream.java b/...nk-streaming-core/src/main/java/org/apache/flink/streaming/api/datastream/DataStream.java
@@ -741,9 +741,9 @@ public AllWindowedStream<T, TimeWindow> timeWindowAll(AbstractTime size) {
 		AbstractTime actualSize = size.makeSpecificBasedOnTimeCharacteristic(environment.getStreamTimeCharacteristic());
 
 		if (actualSize instanceof EventTime) {
-			return windowAll(TumblingTimeWindows.of(actualSize.toMilliseconds()));
+			return windowAll(TumblingTimeWindows.of(actualSize));
 		} else {
-			return windowAll(TumblingProcessingTimeWindows.of(actualSize.toMilliseconds()));
+			return windowAll(TumblingProcessingTimeWindows.of(actualSize));
 		}
 	}
 
@@ -763,11 +763,9 @@ public AllWindowedStream<T, TimeWindow> timeWindowAll(AbstractTime size, Abstrac
 		AbstractTime actualSlide = slide.makeSpecificBasedOnTimeCharacteristic(environment.getStreamTimeCharacteristic());
 
 		if (actualSize instanceof EventTime) {
-			return windowAll(SlidingTimeWindows.of(actualSize.toMilliseconds(),
+			return windowAll(SlidingTimeWindows.of(size, slide));
-					actualSlide.toMilliseconds()));
 		} else {
-			return windowAll(SlidingProcessingTimeWindows.of(actualSize.toMilliseconds(),
+			return windowAll(SlidingProcessingTimeWindows.of(actualSize, actualSlide));
-					actualSlide.toMilliseconds()));
 		}
 	}
 

diff --git a/...k-streaming-core/src/main/java/org/apache/flink/streaming/api/datastream/KeyedStream.java b/...k-streaming-core/src/main/java/org/apache/flink/streaming/api/datastream/KeyedStream.java
@@ -125,9 +125,9 @@ public WindowedStream<T, KEY, TimeWindow> timeWindow(AbstractTime size) {
 		AbstractTime actualSize = size.makeSpecificBasedOnTimeCharacteristic(environment.getStreamTimeCharacteristic());
 
 		if (actualSize instanceof EventTime) {
-			return window(TumblingTimeWindows.of(actualSize.toMilliseconds()));
+			return window(TumblingTimeWindows.of(actualSize));
 		} else {
-			return window(TumblingProcessingTimeWindows.of(actualSize.toMilliseconds()));
+			return window(TumblingProcessingTimeWindows.of(actualSize));
 		}
 	}
 
@@ -147,9 +147,9 @@ public WindowedStream<T, KEY, TimeWindow> timeWindow(AbstractTime size, Abstract
 		AbstractTime actualSlide = slide.makeSpecificBasedOnTimeCharacteristic(environment.getStreamTimeCharacteristic());
 
 		if (actualSize instanceof EventTime) {
-			return window(SlidingTimeWindows.of(actualSize.toMilliseconds(), actualSlide.toMilliseconds()));
+			return window(SlidingTimeWindows.of(actualSize, actualSlide));
 		} else {
-			return window(SlidingProcessingTimeWindows.of(actualSize.toMilliseconds(), actualSlide.toMilliseconds()));
+			return window(SlidingProcessingTimeWindows.of(actualSize, actualSlide));
 		}
 	}
 

diff --git a/...java/org/apache/flink/streaming/api/windowing/assigners/SlidingProcessingTimeWindows.java b/...java/org/apache/flink/streaming/api/windowing/assigners/SlidingProcessingTimeWindows.java
@@ -18,6 +18,7 @@
 package org.apache.flink.streaming.api.windowing.assigners;
 
 import com.google.common.collect.Lists;
+import org.apache.flink.streaming.api.windowing.time.AbstractTime;
 import org.apache.flink.streaming.api.windowing.triggers.ProcessingTimeTrigger;
 import org.apache.flink.streaming.api.windowing.triggers.Trigger;
 import org.apache.flink.streaming.api.windowing.windows.TimeWindow;
@@ -86,7 +87,7 @@ public String toString() {
 	 * @param slide The slide interval of the generated windows.
 	 * @return The time policy.
 	 */
-	public static SlidingProcessingTimeWindows of(long size, long slide) {
+	public static SlidingProcessingTimeWindows of(AbstractTime size, AbstractTime slide) {
-		return new SlidingProcessingTimeWindows(size, slide);
+		return new SlidingProcessingTimeWindows(size.toMilliseconds(), slide.toMilliseconds());
 	}
 }
diff --git a/.../src/main/java/org/apache/flink/streaming/api/windowing/assigners/SlidingTimeWindows.java b/.../src/main/java/org/apache/flink/streaming/api/windowing/assigners/SlidingTimeWindows.java
@@ -17,6 +17,7 @@
  */
 package org.apache.flink.streaming.api.windowing.assigners;
 
+import org.apache.flink.streaming.api.windowing.time.AbstractTime;
 import org.apache.flink.streaming.api.windowing.triggers.Trigger;
 import org.apache.flink.streaming.api.windowing.triggers.WatermarkTrigger;
 import org.apache.flink.streaming.api.windowing.windows.TimeWindow;
@@ -75,7 +76,7 @@ public String toString() {
 	 * @param slide The slide interval of the generated windows.
 	 * @return The time policy.
 	 */
-	public static SlidingTimeWindows of(long size, long slide) {
+	public static SlidingTimeWindows of(AbstractTime size, AbstractTime slide) {
-		return new SlidingTimeWindows(size, slide);
+		return new SlidingTimeWindows(size.toMilliseconds(), slide.toMilliseconds());
 	}
 }
diff --git a/...ava/org/apache/flink/streaming/api/windowing/assigners/TumblingProcessingTimeWindows.java b/...ava/org/apache/flink/streaming/api/windowing/assigners/TumblingProcessingTimeWindows.java
@@ -17,6 +17,7 @@
  */
 package org.apache.flink.streaming.api.windowing.assigners;
 
+import org.apache.flink.streaming.api.windowing.time.AbstractTime;
 import org.apache.flink.streaming.api.windowing.triggers.ProcessingTimeTrigger;
 import org.apache.flink.streaming.api.windowing.triggers.Trigger;
 import org.apache.flink.streaming.api.windowing.windows.TimeWindow;
@@ -61,7 +62,7 @@ public String toString() {
 	 * @param size The size of the generated windows.
 	 * @return The time policy.
 	 */
-	public static TumblingProcessingTimeWindows of(long size) {
+	public static TumblingProcessingTimeWindows of(AbstractTime size) {
-		return new TumblingProcessingTimeWindows(size);
+		return new TumblingProcessingTimeWindows(size.toMilliseconds());
 	}
 }
diff --git a/...src/main/java/org/apache/flink/streaming/api/windowing/assigners/TumblingTimeWindows.java b/...src/main/java/org/apache/flink/streaming/api/windowing/assigners/TumblingTimeWindows.java
@@ -17,6 +17,7 @@
  */
 package org.apache.flink.streaming.api.windowing.assigners;
 
+import org.apache.flink.streaming.api.windowing.time.AbstractTime;
 import org.apache.flink.streaming.api.windowing.triggers.Trigger;
 import org.apache.flink.streaming.api.windowing.triggers.WatermarkTrigger;
 import org.apache.flink.streaming.api.windowing.windows.TimeWindow;
@@ -60,8 +61,8 @@ public String toString() {
 	 * @param size The size of the generated windows.
 	 * @return The time policy.
 	 */
-	public static TumblingTimeWindows of(long size) {
+	public static TumblingTimeWindows of(AbstractTime size) {
-		return new TumblingTimeWindows(size);
+		return new TumblingTimeWindows(size.toMilliseconds());
 	}
 
 }
diff --git a/...ing-core/src/main/java/org/apache/flink/streaming/api/windowing/evictors/TimeEvictor.java b/...ing-core/src/main/java/org/apache/flink/streaming/api/windowing/evictors/TimeEvictor.java
@@ -18,6 +18,7 @@
 package org.apache.flink.streaming.api.windowing.evictors;
 
 import com.google.common.annotations.VisibleForTesting;
+import org.apache.flink.streaming.api.windowing.time.AbstractTime;
 import org.apache.flink.streaming.api.windowing.windows.Window;
 import org.apache.flink.streaming.runtime.streamrecord.StreamRecord;
 
@@ -54,7 +55,7 @@ public long getWindowSize() {
 		return windowSize;
 	}
 
-	public static <W extends Window> TimeEvictor<W> of(long windowSize) {
+	public static <W extends Window> TimeEvictor<W> of(AbstractTime windowSize) {
-		return new TimeEvictor<>(windowSize);
+		return new TimeEvictor<>(windowSize.toMilliseconds());
 	}
 }
diff --git a/...eaming-core/src/main/java/org/apache/flink/streaming/api/windowing/time/AbstractTime.java b/...eaming-core/src/main/java/org/apache/flink/streaming/api/windowing/time/AbstractTime.java
@@ -24,6 +24,9 @@
 
 import static com.google.common.base.Preconditions.checkNotNull;
 
+/**
+ * Base class for {@link Time} implementations.
+ */
 public abstract class AbstractTime {
 
 	/** The time unit for this policy's time interval */

diff --git a/...va/org/apache/flink/streaming/api/windowing/triggers/ContinuousProcessingTimeTrigger.java b/...va/org/apache/flink/streaming/api/windowing/triggers/ContinuousProcessingTimeTrigger.java
@@ -18,32 +18,33 @@
 package org.apache.flink.streaming.api.windowing.triggers;
 
 import com.google.common.annotations.VisibleForTesting;
+import org.apache.flink.streaming.api.windowing.time.AbstractTime;
 import org.apache.flink.streaming.api.windowing.windows.Window;
 
 public class ContinuousProcessingTimeTrigger<W extends Window> implements Trigger<Object, W> {
 	private static final long serialVersionUID = 1L;
 
-	private long granularity;
+	private long interval;
 
 	private long nextFireTimestamp = 0;
 
-	private ContinuousProcessingTimeTrigger(long granularity) {
+	private ContinuousProcessingTimeTrigger(long interval) {
-		this.granularity = granularity;
+		this.interval = interval;
 	}
 
 	@Override
 	public TriggerResult onElement(Object element, long timestamp, W window, TriggerContext ctx) {
 		long currentTime = System.currentTimeMillis();
 		if (nextFireTimestamp == 0) {
-			long start = currentTime - (currentTime % granularity);
+			long start = currentTime - (currentTime % interval);
-			nextFireTimestamp = start + granularity;
+			nextFireTimestamp = start + interval;
 
 			ctx.registerProcessingTimeTimer(nextFireTimestamp);
 			return TriggerResult.CONTINUE;
 		}
 		if (currentTime > nextFireTimestamp) {
-			long start = currentTime - (currentTime % granularity);
+			long start = currentTime - (currentTime % interval);
-			nextFireTimestamp = start + granularity;
+			nextFireTimestamp = start + interval;
 
 			ctx.registerProcessingTimeTimer(nextFireTimestamp);
 
@@ -57,29 +58,29 @@ public TriggerResult onTime(long time, TriggerContext ctx) {
 		// only fire if an element didn't already fire
 		long currentTime = System.currentTimeMillis();
 		if (currentTime > nextFireTimestamp) {
-			long start = currentTime - (currentTime % granularity);
+			long start = currentTime - (currentTime % interval);
-			nextFireTimestamp = start + granularity;
+			nextFireTimestamp = start + interval;
 			return TriggerResult.FIRE;
 		}
 		return TriggerResult.CONTINUE;
 	}
 
 	@Override
 	public Trigger<Object, W> duplicate() {
-		return new ContinuousProcessingTimeTrigger<>(granularity);
+		return new ContinuousProcessingTimeTrigger<>(interval);
 	}
 
 	@VisibleForTesting
-	public long getGranularity() {
+	public long getInterval() {
-		return granularity;
+		return interval;
 	}
 
 	@Override
 	public String toString() {
-		return "ContinuousProcessingTimeTrigger(" + granularity + ")";
+		return "ContinuousProcessingTimeTrigger(" + interval + ")";
 	}
 
-	public static <W extends Window> ContinuousProcessingTimeTrigger<W> of(long granularity) {
+	public static <W extends Window> ContinuousProcessingTimeTrigger<W> of(AbstractTime interval) {
-		return new ContinuousProcessingTimeTrigger<>(granularity);
+		return new ContinuousProcessingTimeTrigger<>(interval.toMilliseconds());
 	}
 }
diff --git a/...in/java/org/apache/flink/streaming/api/windowing/triggers/ContinuousWatermarkTrigger.java b/...in/java/org/apache/flink/streaming/api/windowing/triggers/ContinuousWatermarkTrigger.java
@@ -18,24 +18,25 @@
 package org.apache.flink.streaming.api.windowing.triggers;
 
 import com.google.common.annotations.VisibleForTesting;
+import org.apache.flink.streaming.api.windowing.time.AbstractTime;
 import org.apache.flink.streaming.api.windowing.windows.Window;
 
 public class ContinuousWatermarkTrigger<W extends Window> implements Trigger<Object, W> {
 	private static final long serialVersionUID = 1L;
 
-	private long granularity;
+	private long interval;
 
 	private boolean first = true;
 
-	private ContinuousWatermarkTrigger(long granularity) {
+	private ContinuousWatermarkTrigger(long interval) {
-		this.granularity = granularity;
+		this.interval = interval;
 	}
 
 	@Override
 	public TriggerResult onElement(Object element, long timestamp, W window, TriggerContext ctx) {
 		if (first) {
-			long start = timestamp - (timestamp % granularity);
+			long start = timestamp - (timestamp % interval);
-			long nextFireTimestamp = start + granularity;
+			long nextFireTimestamp = start + interval;
 
 			ctx.registerWatermarkTimer(nextFireTimestamp);
 			first = false;
@@ -46,26 +47,26 @@ public TriggerResult onElement(Object element, long timestamp, W window, Trigger
 
 	@Override
 	public TriggerResult onTime(long time, TriggerContext ctx) {
-		ctx.registerWatermarkTimer(time + granularity);
+		ctx.registerWatermarkTimer(time + interval);
 		return TriggerResult.FIRE;
 	}
 
 	@Override
 	public Trigger<Object, W> duplicate() {
-		return new ContinuousWatermarkTrigger<>(granularity);
+		return new ContinuousWatermarkTrigger<>(interval);
 	}
 
 	@Override
 	public String toString() {
-		return "ContinuousProcessingTimeTrigger(" + granularity + ")";
+		return "ContinuousProcessingTimeTrigger(" + interval + ")";
 	}
 
 	@VisibleForTesting
-	public long getGranularity() {
+	public long getInterval() {
-		return granularity;
+		return interval;
 	}
 
-	public static <W extends Window> ContinuousWatermarkTrigger<W> of(long granularity) {
+	public static <W extends Window> ContinuousWatermarkTrigger<W> of(AbstractTime interval) {
-		return new ContinuousWatermarkTrigger<>(granularity);
+		return new ContinuousWatermarkTrigger<>(interval.toMilliseconds());
 	}
 }
diff --git a/...java/org/apache/flink/streaming/runtime/operators/windowing/AllWindowTranslationTest.java b/...java/org/apache/flink/streaming/runtime/operators/windowing/AllWindowTranslationTest.java
@@ -28,6 +28,7 @@
 import org.apache.flink.streaming.api.windowing.assigners.TumblingProcessingTimeWindows;
 import org.apache.flink.streaming.api.windowing.evictors.CountEvictor;
 import org.apache.flink.streaming.api.windowing.evictors.TimeEvictor;
+import org.apache.flink.streaming.api.windowing.time.Time;
 import org.apache.flink.streaming.api.windowing.triggers.CountTrigger;
 import org.apache.flink.streaming.api.windowing.triggers.ProcessingTimeTrigger;
 import org.apache.flink.streaming.api.windowing.windows.TimeWindow;
@@ -39,6 +40,8 @@
 import org.junit.Ignore;
 import org.junit.Test;
 
+import java.util.concurrent.TimeUnit;
+
 /**
  * These tests verify that the api calls on
  * {@link org.apache.flink.streaming.api.datastream.AllWindowedStream} instantiate
@@ -62,15 +65,15 @@ public void testFastTimeWindows() throws Exception {
 		DummyReducer reducer = new DummyReducer();
 
 		DataStream<Tuple2<String, Integer>> window1 = source
-				.windowAll(SlidingProcessingTimeWindows.of(1000, 100))
+				.windowAll(SlidingProcessingTimeWindows.of(Time.of(1, TimeUnit.SECONDS), Time.of(100, TimeUnit.MILLISECONDS)))
 				.reduceWindow(reducer);
 
 		OneInputTransformation<Tuple2<String, Integer>, Tuple2<String, Integer>> transform1 = (OneInputTransformation<Tuple2<String, Integer>, Tuple2<String, Integer>>) window1.getTransformation();
 		OneInputStreamOperator<Tuple2<String, Integer>, Tuple2<String, Integer>> operator1 = transform1.getOperator();
 		Assert.assertTrue(operator1 instanceof AggregatingProcessingTimeWindowOperator);
 
 		DataStream<Tuple2<String, Integer>> window2 = source
-				.windowAll(SlidingProcessingTimeWindows.of(1000, 100))
+				.windowAll(SlidingProcessingTimeWindows.of(Time.of(1, TimeUnit.SECONDS), Time.of(100, TimeUnit.MILLISECONDS)))
 				.apply(new AllWindowFunction<Tuple2<String, Integer>, Tuple2<String, Integer>, TimeWindow>() {
 					private static final long serialVersionUID = 1L;
 
@@ -98,7 +101,7 @@ public void testNonEvicting() throws Exception {
 		DummyReducer reducer = new DummyReducer();
 
 		DataStream<Tuple2<String, Integer>> window1 = source
-				.windowAll(SlidingProcessingTimeWindows.of(1000, 100))
+				.windowAll(SlidingProcessingTimeWindows.of(Time.of(1, TimeUnit.SECONDS), Time.of(100, TimeUnit.MILLISECONDS)))
 				.trigger(CountTrigger.of(100))
 				.reduceWindow(reducer);
 
@@ -111,7 +114,7 @@ public void testNonEvicting() throws Exception {
 		Assert.assertTrue(winOperator1.getWindowBufferFactory() instanceof PreAggregatingHeapWindowBuffer.Factory);
 
 		DataStream<Tuple2<String, Integer>> window2 = source
-				.windowAll(TumblingProcessingTimeWindows.of(1000))
+				.windowAll(TumblingProcessingTimeWindows.of(Time.of(1, TimeUnit.SECONDS)))
 				.trigger(CountTrigger.of(100))
 				.apply(new AllWindowFunction<Tuple2<String, Integer>, Tuple2<String, Integer>, TimeWindow>() {
 					private static final long serialVersionUID = 1L;
@@ -144,7 +147,7 @@ public void testEvicting() throws Exception {
 		DummyReducer reducer = new DummyReducer();
 
 		DataStream<Tuple2<String, Integer>> window1 = source
-				.windowAll(SlidingProcessingTimeWindows.of(1000, 100))
+				.windowAll(SlidingProcessingTimeWindows.of(Time.of(1, TimeUnit.SECONDS), Time.of(100, TimeUnit.MILLISECONDS)))
 				.evictor(CountEvictor.of(100))
 				.reduceWindow(reducer);
 
@@ -158,9 +161,9 @@ public void testEvicting() throws Exception {
 		Assert.assertTrue(winOperator1.getWindowBufferFactory() instanceof HeapWindowBuffer.Factory);
 
 		DataStream<Tuple2<String, Integer>> window2 = source
-				.windowAll(TumblingProcessingTimeWindows.of(1000))
+				.windowAll(TumblingProcessingTimeWindows.of(Time.of(1, TimeUnit.SECONDS)))
 				.trigger(CountTrigger.of(100))
-				.evictor(TimeEvictor.of(100))
+				.evictor(TimeEvictor.of(Time.of(100, TimeUnit.MILLISECONDS)))
 				.apply(new AllWindowFunction<Tuple2<String, Integer>, Tuple2<String, Integer>, TimeWindow>() {
 					private static final long serialVersionUID = 1L;