You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streampipes.apache.org by ze...@apache.org on 2020/04/11 22:07:41 UTC
[incubator-streampipes-extensions] branch dev updated (efd15b6 ->
1e16b34)
This is an automated email from the ASF dual-hosted git repository.
zehnder pushed a change to branch dev
in repository https://gitbox.apache.org/repos/asf/incubator-streampipes-extensions.git.
from efd15b6 Fix documantation for time keeping component
new f88ac8c Add documentation for statistiics processors
new adb01f6 Add icon and description for spatial grid enricher
new 05682ff Add icon and description for transform to boolean
new be810af Add documentation to detect value change
new 1e16b34 Add icon to nome finder and chunker
The 5 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../documentation.md | 19 ----------------
.../SpatialGridEnrichmentController.java | 2 +-
.../documentation.md | 21 ++++++++---------
.../icon.png | Bin 0 -> 9425 bytes
.../documentation.md | 22 ++++++++++--------
.../documentation.md | 25 ++++++---------------
.../jvm/processor/chunker/ChunkerController.java | 2 +-
.../processor/namefinder/NameFinderController.java | 2 +-
.../documentation.md | 4 ++--
.../TransformToBooleanController.java | 2 +-
.../documentation.md | 2 +-
.../documentation.md | 14 +++---------
.../documentation.md | 17 ++++++--------
13 files changed, 46 insertions(+), 86 deletions(-)
create mode 100644 streampipes-processors-geo-flink/src/main/resources/org.apache.streampipes.processor.geo.flink/icon.png
copy {streampipes-processors-enricher-flink/src/main/resources/org.apache.streampipes.processors.enricher.flink.processor.urldereferencing => streampipes-processors-statistics-flink/src/main/resources/org.apache.streampipes.processors.statistics.flink.statistics-summary-window}/documentation.md (69%)
[incubator-streampipes-extensions] 01/05: Add documentation for
statistiics processors
Posted by ze...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
zehnder pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/incubator-streampipes-extensions.git
commit f88ac8c13708165e90da7877f4b763737649214c
Author: Philipp Zehnder <ze...@fzi.de>
AuthorDate: Sat Apr 11 23:02:20 2020 +0200
Add documentation for statistiics processors
---
.../documentation.md | 29 +++++++++++-----------
.../documentation.md | 25 ++++++-------------
2 files changed, 22 insertions(+), 32 deletions(-)
diff --git a/streampipes-processors-statistics-flink/src/main/resources/org.apache.streampipes.processors.statistics.flink.statistics-summary/documentation.md b/streampipes-processors-statistics-flink/src/main/resources/org.apache.streampipes.processors.statistics.flink.statistics-summary-window/documentation.md
similarity index 69%
copy from streampipes-processors-statistics-flink/src/main/resources/org.apache.streampipes.processors.statistics.flink.statistics-summary/documentation.md
copy to streampipes-processors-statistics-flink/src/main/resources/org.apache.streampipes.processors.statistics.flink.statistics-summary-window/documentation.md
index 5b99a47..bd20e46 100644
--- a/streampipes-processors-statistics-flink/src/main/resources/org.apache.streampipes.processors.statistics.flink.statistics-summary/documentation.md
+++ b/streampipes-processors-statistics-flink/src/main/resources/org.apache.streampipes.processors.statistics.flink.statistics-summary-window/documentation.md
@@ -16,7 +16,7 @@
~
-->
-## Statistics Summary
+## Sliding Statistics Summary
<p align="center">
<img src="icon.png" width="150px;" class="pe-image-documentation"/>
@@ -26,23 +26,24 @@
## Description
-Calculate simple descriptive summary statistics
-Add a detailed description here
+Calculate simple descriptive summary statistics for a selected property over a defined time interval.
***
## Required input
-
-
-***
+Requires a numerical property
## Configuration
-Describe the configuration parameters here
-
-### 1st parameter
-
-
-### 2nd parameter
-
-## Output
\ No newline at end of file
+* Define a value to observe
+* Select the time field
+* Group the event streams by an identifier
+* Set the time window size and scale (Seconds, Minutes, Hours)
+
+## Output
+The statistics are appended to the event and contain:
+* Minimum
+* Maximum
+* Sum
+* Standard Deviation
+* Variance
diff --git a/streampipes-processors-statistics-flink/src/main/resources/org.apache.streampipes.processors.statistics.flink.statistics-summary/documentation.md b/streampipes-processors-statistics-flink/src/main/resources/org.apache.streampipes.processors.statistics.flink.statistics-summary/documentation.md
index 5b99a47..59e9dbe 100644
--- a/streampipes-processors-statistics-flink/src/main/resources/org.apache.streampipes.processors.statistics.flink.statistics-summary/documentation.md
+++ b/streampipes-processors-statistics-flink/src/main/resources/org.apache.streampipes.processors.statistics.flink.statistics-summary/documentation.md
@@ -26,23 +26,12 @@
## Description
-Calculate simple descriptive summary statistics
-Add a detailed description here
+Calculate simple descriptive summary statistics for each selected list property.
-***
-
-## Required input
-
-
-***
-
-## Configuration
-
-Describe the configuration parameters here
-
-### 1st parameter
-
-
-### 2nd parameter
+The statistics contain:
+* Minimum
+* Maximum
+* Sum
+* Standard Deviation
+* Variance
-## Output
\ No newline at end of file
[incubator-streampipes-extensions] 04/05: Add documentation to
detect value change
Posted by ze...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
zehnder pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/incubator-streampipes-extensions.git
commit be810afb9accfc782fca71ca54d2477867078cc3
Author: Philipp Zehnder <ze...@fzi.de>
AuthorDate: Sat Apr 11 23:58:32 2020 +0200
Add documentation to detect value change
---
.../documentation.md | 2 +-
.../documentation.md | 14 +++-----------
2 files changed, 4 insertions(+), 12 deletions(-)
diff --git a/streampipes-processors-transformation-jvm/src/main/resources/org.apache.streampipes.processors.transformation.jvm.booloperator.inverter/documentation.md b/streampipes-processors-transformation-jvm/src/main/resources/org.apache.streampipes.processors.transformation.jvm.booloperator.inverter/documentation.md
index 4b36dc5..d4bbb51 100644
--- a/streampipes-processors-transformation-jvm/src/main/resources/org.apache.streampipes.processors.transformation.jvm.booloperator.inverter/documentation.md
+++ b/streampipes-processors-transformation-jvm/src/main/resources/org.apache.streampipes.processors.transformation.jvm.booloperator.inverter/documentation.md
@@ -16,7 +16,7 @@
~
-->
-## Value Changed
+## Boolean Inverter
<p align="center">
<img src="icon.png" width="150px;" class="pe-image-documentation"/>
diff --git a/streampipes-processors-transformation-jvm/src/main/resources/org.apache.streampipes.processors.transformation.jvm.changed-value/documentation.md b/streampipes-processors-transformation-jvm/src/main/resources/org.apache.streampipes.processors.transformation.jvm.changed-value/documentation.md
index e8d341b..ccd5b01 100644
--- a/streampipes-processors-transformation-jvm/src/main/resources/org.apache.streampipes.processors.transformation.jvm.changed-value/documentation.md
+++ b/streampipes-processors-transformation-jvm/src/main/resources/org.apache.streampipes.processors.transformation.jvm.changed-value/documentation.md
@@ -30,18 +30,10 @@ This processor sends out an event everytime a specific object changes. It also a
***
-## Required input
-
-
-***
-
## Configuration
+Select property to monitor for changes
Describe the configuration parameters here
-### 1st parameter
-
-
-### 2nd parameter
-
-## Output
\ No newline at end of file
+## Output
+Emit an event on change and append a timestamp when the change occured
\ No newline at end of file
[incubator-streampipes-extensions] 05/05: Add icon to nome finder
and chunker
Posted by ze...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
zehnder pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/incubator-streampipes-extensions.git
commit 1e16b34a084d1a122ebad141272230f6ad7348ed
Author: Philipp Zehnder <ze...@fzi.de>
AuthorDate: Sun Apr 12 00:07:22 2020 +0200
Add icon to nome finder and chunker
---
.../textmining/jvm/processor/chunker/ChunkerController.java | 2 +-
.../textmining/jvm/processor/namefinder/NameFinderController.java | 2 +-
.../documentation.md | 4 ++--
3 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/streampipes-processors-text-mining-jvm/src/main/java/org/apache/streampipes/processors/textmining/jvm/processor/chunker/ChunkerController.java b/streampipes-processors-text-mining-jvm/src/main/java/org/apache/streampipes/processors/textmining/jvm/processor/chunker/ChunkerController.java
index e7d5d14..c649471 100644
--- a/streampipes-processors-text-mining-jvm/src/main/java/org/apache/streampipes/processors/textmining/jvm/processor/chunker/ChunkerController.java
+++ b/streampipes-processors-text-mining-jvm/src/main/java/org/apache/streampipes/processors/textmining/jvm/processor/chunker/ChunkerController.java
@@ -42,7 +42,7 @@ public class ChunkerController extends StandaloneEventProcessingDeclarer<Chunker
public DataProcessorDescription declareModel() {
return ProcessingElementBuilder.create("org.apache.streampipes.processors.textmining.jvm.chunker")
.category(DataProcessorType.ENRICH_TEXT)
- .withAssets(Assets.DOCUMENTATION)
+ .withAssets(Assets.DOCUMENTATION, Assets.ICON)
.withLocales(Locales.EN)
.requiredStream(StreamRequirementsBuilder
.create()
diff --git a/streampipes-processors-text-mining-jvm/src/main/java/org/apache/streampipes/processors/textmining/jvm/processor/namefinder/NameFinderController.java b/streampipes-processors-text-mining-jvm/src/main/java/org/apache/streampipes/processors/textmining/jvm/processor/namefinder/NameFinderController.java
index 433830f..67898d2 100644
--- a/streampipes-processors-text-mining-jvm/src/main/java/org/apache/streampipes/processors/textmining/jvm/processor/namefinder/NameFinderController.java
+++ b/streampipes-processors-text-mining-jvm/src/main/java/org/apache/streampipes/processors/textmining/jvm/processor/namefinder/NameFinderController.java
@@ -49,7 +49,7 @@ public class NameFinderController extends StandaloneEventProcessingDeclarer<Name
public DataProcessorDescription declareModel() {
return ProcessingElementBuilder.create("org.apache.streampipes.processors.textmining.jvm.namefinder")
.category(DataProcessorType.ENRICH_TEXT)
- .withAssets(Assets.DOCUMENTATION)
+ .withAssets(Assets.DOCUMENTATION, Assets.ICON)
.withLocales(Locales.EN)
.requiredStream(StreamRequirementsBuilder
.create()
diff --git a/streampipes-processors-text-mining-jvm/src/main/resources/org.apache.streampipes.processors.textmining.jvm.namefinder/documentation.md b/streampipes-processors-text-mining-jvm/src/main/resources/org.apache.streampipes.processors.textmining.jvm.namefinder/documentation.md
index 8d98327..f78dc2b 100644
--- a/streampipes-processors-text-mining-jvm/src/main/resources/org.apache.streampipes.processors.textmining.jvm.namefinder/documentation.md
+++ b/streampipes-processors-text-mining-jvm/src/main/resources/org.apache.streampipes.processors.textmining.jvm.namefinder/documentation.md
@@ -28,8 +28,8 @@
Loads a trained model which finds names like locations or organizations.
-A list of trained models can be found [here](http://opennlp.sourceforge.net/models-1.5/).\
-A guide on how to train a new model can be found [here](https://opennlp.apache.org/docs/1.9.1/manual/opennlp.html#tools.namefind.training).
+A list of trained models can be found here: http://opennlp.sourceforge.net/models-1.5/.\
+A guide on how to train a new model can be found here: https://opennlp.apache.org/docs/1.9.1/manual/opennlp.html#tools.namefind.training.
***
[incubator-streampipes-extensions] 03/05: Add icon and description
for transform to boolean
Posted by ze...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
zehnder pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/incubator-streampipes-extensions.git
commit 05682ffd003e5bd3322a45a47d606da6c09cba90
Author: Philipp Zehnder <ze...@fzi.de>
AuthorDate: Sat Apr 11 23:42:12 2020 +0200
Add icon and description for transform to boolean
---
.../TransformToBooleanController.java | 2 +-
.../documentation.md | 17 +++++++----------
2 files changed, 8 insertions(+), 11 deletions(-)
diff --git a/streampipes-processors-transformation-jvm/src/main/java/org/apache/streampipes/processors/transformation/jvm/processor/transformtoboolean/TransformToBooleanController.java b/streampipes-processors-transformation-jvm/src/main/java/org/apache/streampipes/processors/transformation/jvm/processor/transformtoboolean/TransformToBooleanController.java
index 3967f96..94f4705 100644
--- a/streampipes-processors-transformation-jvm/src/main/java/org/apache/streampipes/processors/transformation/jvm/processor/transformtoboolean/TransformToBooleanController.java
+++ b/streampipes-processors-transformation-jvm/src/main/java/org/apache/streampipes/processors/transformation/jvm/processor/transformtoboolean/TransformToBooleanController.java
@@ -48,7 +48,7 @@ public class TransformToBooleanController
public DataProcessorDescription declareModel() {
return ProcessingElementBuilder.create("org.apache.streampipes.processors.transformation.jvm.transform-to-boolean")
.withLocales(Locales.EN)
- .withAssets(Assets.DOCUMENTATION)
+ .withAssets(Assets.DOCUMENTATION, Assets.ICON)
.requiredStream(StreamRequirementsBuilder.create()
.requiredPropertyWithNaryMapping(
EpRequirements.anyProperty(), // anyProperty? Would be nice, to exclude
diff --git a/streampipes-processors-transformation-jvm/src/main/resources/org.apache.streampipes.processors.transformation.jvm.transform-to-boolean/documentation.md b/streampipes-processors-transformation-jvm/src/main/resources/org.apache.streampipes.processors.transformation.jvm.transform-to-boolean/documentation.md
index a6a5268..50c7441 100644
--- a/streampipes-processors-transformation-jvm/src/main/resources/org.apache.streampipes.processors.transformation.jvm.transform-to-boolean/documentation.md
+++ b/streampipes-processors-transformation-jvm/src/main/resources/org.apache.streampipes.processors.transformation.jvm.transform-to-boolean/documentation.md
@@ -1,4 +1,4 @@
-## Value Changed
+## Transform to Boolean
<p align="center">
<img src="icon.png" width="150px;" class="pe-image-documentation"/>
@@ -7,23 +7,20 @@
***
## Description
+This processors transforms numbers and strings to boolean values.
-This processor inverts a specific boolean
***
## Required input
-
+A string with the values "true", "True", "false", "False" or a number with value 1.0, 1, 0, or 0.0
***
## Configuration
-Describe the configuration parameters here
-
-### 1st parameter
-
-
-### 2nd parameter
+Select fields that should be converted to boolean.
-## Output
\ No newline at end of file
+## Output
+Selected properties of input events are transformed to booleans.
+When the value is not valid an error message is logged and the event is discarde.
\ No newline at end of file
[incubator-streampipes-extensions] 02/05: Add icon and description
for spatial grid enricher
Posted by ze...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
zehnder pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/incubator-streampipes-extensions.git
commit adb01f68b13825d655833edcd45324a6626fe5d0
Author: Philipp Zehnder <ze...@fzi.de>
AuthorDate: Sat Apr 11 23:21:32 2020 +0200
Add icon and description for spatial grid enricher
---
.../documentation.md | 19 -------------------
.../SpatialGridEnrichmentController.java | 2 +-
.../documentation.md | 21 +++++++++------------
.../icon.png | Bin 0 -> 9425 bytes
4 files changed, 10 insertions(+), 32 deletions(-)
diff --git a/streampipes-processors-filters-siddhi/src/main/resources/org.apache.streampipes.processors.siddhi.sequence/documentation.md b/streampipes-processors-filters-siddhi/src/main/resources/org.apache.streampipes.processors.siddhi.sequence/documentation.md
index 91fcbf9..e76f827 100644
--- a/streampipes-processors-filters-siddhi/src/main/resources/org.apache.streampipes.processors.siddhi.sequence/documentation.md
+++ b/streampipes-processors-filters-siddhi/src/main/resources/org.apache.streampipes.processors.siddhi.sequence/documentation.md
@@ -27,22 +27,3 @@
## Description
Merges events from two event streams, when the top event arrives first and then the bottom event
-Add a detailed description here
-
-***
-
-## Required input
-
-
-***
-
-## Configuration
-
-Describe the configuration parameters here
-
-### 1st parameter
-
-
-### 2nd parameter
-
-## Output
\ No newline at end of file
diff --git a/streampipes-processors-geo-flink/src/main/java/org/apache/streampipes/processor/geo/flink/processor/gridenricher/SpatialGridEnrichmentController.java b/streampipes-processors-geo-flink/src/main/java/org/apache/streampipes/processor/geo/flink/processor/gridenricher/SpatialGridEnrichmentController.java
index d1d7550..a722047 100644
--- a/streampipes-processors-geo-flink/src/main/java/org/apache/streampipes/processor/geo/flink/processor/gridenricher/SpatialGridEnrichmentController.java
+++ b/streampipes-processors-geo-flink/src/main/java/org/apache/streampipes/processor/geo/flink/processor/gridenricher/SpatialGridEnrichmentController.java
@@ -45,7 +45,7 @@ public class SpatialGridEnrichmentController extends FlinkDataProcessorDeclarer<
public DataProcessorDescription declareModel() {
return ProcessingElementBuilder.create("org.apache.streampipes.processor.geo.flink")
.withLocales(Locales.EN)
- .withAssets(Assets.DOCUMENTATION)
+ .withAssets(Assets.DOCUMENTATION, Assets.ICON)
.requiredStream(StreamRequirementsBuilder
.create()
.requiredPropertyWithUnaryMapping(EpRequirements.domainPropertyReq(Geo.lat)
diff --git a/streampipes-processors-geo-flink/src/main/resources/org.apache.streampipes.processor.geo.flink/documentation.md b/streampipes-processors-geo-flink/src/main/resources/org.apache.streampipes.processor.geo.flink/documentation.md
index d43213b..0ad1714 100644
--- a/streampipes-processors-geo-flink/src/main/resources/org.apache.streampipes.processor.geo.flink/documentation.md
+++ b/streampipes-processors-geo-flink/src/main/resources/org.apache.streampipes.processor.geo.flink/documentation.md
@@ -26,23 +26,20 @@
## Description
-Groups spatial events into cells of a given size
-Add a detailed description here
+Groups spatial events into cells of a given size.
+The result is like a chessboard pattern in which the geo coordinates are inserted. The user can define the coordinates of the first field.
***
## Required input
-
-
-***
+Requires a latitude and longitude in the data stream.
## Configuration
-Describe the configuration parameters here
-
-### 1st parameter
-
-
-### 2nd parameter
+* Latitude property
+* Longitude property
+* The size of the cell
+* Latitude and longitude of the first cell
-## Output
\ No newline at end of file
+## Output
+Appends the grid cell coordinates to the input event
\ No newline at end of file
diff --git a/streampipes-processors-geo-flink/src/main/resources/org.apache.streampipes.processor.geo.flink/icon.png b/streampipes-processors-geo-flink/src/main/resources/org.apache.streampipes.processor.geo.flink/icon.png
new file mode 100644
index 0000000..f7411da
Binary files /dev/null and b/streampipes-processors-geo-flink/src/main/resources/org.apache.streampipes.processor.geo.flink/icon.png differ