[
https://issues.apache.org/jira/browse/FLINK-6198?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16032947#comment-16032947
]
ASF GitHub Bot commented on FLINK-6198:
---------------------------------------
Github user tzulitai commented on a diff in the pull request:
https://github.com/apache/flink/pull/4041#discussion_r119607645
--- Diff: docs/dev/libs/cep.md ---
@@ -659,37 +913,45 @@ val patternStream: PatternStream[Event] =
CEP.pattern(input, pattern)
</div>
</div>
+The input stream can be *keyed* or *non-keyed* depending on your use-case.
+
+<span class="label label-danger">Attention</span> Applying your pattern on
a non-keyed stream will result is a job with
+parallelism equal to 1.
+
### Selecting from Patterns
+
Once you have obtained a `PatternStream` you can select from detected
event sequences via the `select` or `flatSelect` methods.
<div class="codetabs" markdown="1">
<div data-lang="java" markdown="1">
The `select` method requires a `PatternSelectFunction` implementation.
A `PatternSelectFunction` has a `select` method which is called for each
matching event sequence.
-It receives a map of string/event pairs of the matched events.
-The string is defined by the name of the state to which the event has been
matched.
-The `select` method can return exactly one result.
+It receives a match in the form of `Map<String, List<IN>>` where the key
is the name of each state in your pattern
+sequence and the value is a list of all accepted events for that state
(`IN` is the type of your input elements).
--- End diff --
Perhaps add information about the ordering of the list of matched events?
> Update the documentation of the CEP library to include all the new features.
> ----------------------------------------------------------------------------
>
> Key: FLINK-6198
> URL: https://issues.apache.org/jira/browse/FLINK-6198
> Project: Flink
> Issue Type: Sub-task
> Components: CEP
> Affects Versions: 1.3.0
> Reporter: Kostas Kloudas
> Assignee: Kostas Kloudas
> Priority: Critical
> Fix For: 1.3.0
>
>
> New features to include:
> * Iterative Functions
> * Quantifiers
> * Time handling
> * Migration from FilterFunction to IterativeCondition
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
