beam-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From k...@apache.org
Subject [1/3] beam git commit: update JavaDoc for BoundedWindow
Date Mon, 22 May 2017 19:05:57 GMT
Repository: beam
Updated Branches:
  refs/heads/master b68f46cb8 -> e83fcece5


update JavaDoc for BoundedWindow

update JavaDoc

rephrase JavaDoc.


Project: http://git-wip-us.apache.org/repos/asf/beam/repo
Commit: http://git-wip-us.apache.org/repos/asf/beam/commit/de0fdbc1
Tree: http://git-wip-us.apache.org/repos/asf/beam/tree/de0fdbc1
Diff: http://git-wip-us.apache.org/repos/asf/beam/diff/de0fdbc1

Branch: refs/heads/master
Commit: de0fdbc1ee7f233e9ae363c7162171135d3b7403
Parents: 33078d2
Author: mingmxu <mingmxu@ebay.com>
Authored: Sat Apr 29 18:51:21 2017 -0700
Committer: mingmxu <mingmxu@ebay.com>
Committed: Tue May 2 14:25:16 2017 -0700

----------------------------------------------------------------------
 .../beam/sdk/transforms/windowing/BoundedWindow.java  | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/beam/blob/de0fdbc1/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/windowing/BoundedWindow.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/windowing/BoundedWindow.java
b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/windowing/BoundedWindow.java
index 74223b5..506753d 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/windowing/BoundedWindow.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/windowing/BoundedWindow.java
@@ -21,11 +21,15 @@ import java.util.concurrent.TimeUnit;
 import org.joda.time.Instant;
 
 /**
- * A {@code BoundedWindow} represents a finite grouping of elements, with an
- * upper bound (larger timestamps represent more recent data) on the timestamps
- * of elements that can be placed in the window. This finiteness means that for
- * every window, at some point in time, all data for that window will have
- * arrived and can be processed together.
+ * A {@code BoundedWindow} represents window information assigned to data elements.
+ *
+ * <p>It has one method {@link #maxTimestamp()} to define an upper bound(included)
of element
+ * timestamp. Elements within the timestamp range are placed in this window.
+ * Technically a window may not have a lower bound. Upper bound is mandatory as watermark,
+ * which also controls discarding data and expiring the window, is based on event timestamp.
+ *
+ * <p>At some point in time, usually when watermark passes,
+ * all data with the same window will arrive and can be processed together.
  *
  * <p>Windows must also implement {@link Object#equals} and
  * {@link Object#hashCode} such that windows that are logically equal will


Mime
View raw message