You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@plc4x.apache.org by jf...@apache.org on 2018/11/25 13:40:32 UTC
[incubator-plc4x] 02/04: [plc4j-scraper] Added javadoc.
This is an automated email from the ASF dual-hosted git repository.
jfeinauer pushed a commit to branch features/scraper-builder
in repository https://gitbox.apache.org/repos/asf/incubator-plc4x.git
commit 777829a1a0b93415967c25b170c9196d8be7c9f0
Author: Julian Feinauer <j....@pragmaticminds.de>
AuthorDate: Sun Nov 25 11:02:28 2018 +0100
[plc4j-scraper] Added javadoc.
---
.../main/java/org/apache/plc4x/java/scraper/ScrapeJob.java | 5 +++++
.../java/org/apache/plc4x/java/scraper/ScraperTask.java | 4 +++-
.../apache/plc4x/java/scraper/config/JobConfiguration.java | 14 ++++++++++----
.../plc4x/java/scraper/config/ScraperConfiguration.java | 6 +++++-
4 files changed, 23 insertions(+), 6 deletions(-)
diff --git a/plc4j/utils/scraper/src/main/java/org/apache/plc4x/java/scraper/ScrapeJob.java b/plc4j/utils/scraper/src/main/java/org/apache/plc4x/java/scraper/ScrapeJob.java
index 14502bb..d399c64 100644
--- a/plc4j/utils/scraper/src/main/java/org/apache/plc4x/java/scraper/ScrapeJob.java
+++ b/plc4j/utils/scraper/src/main/java/org/apache/plc4x/java/scraper/ScrapeJob.java
@@ -21,6 +21,11 @@ package org.apache.plc4x.java.scraper;
import java.util.Map;
+/**
+ * POJO Object to transport all Job informtation.
+ * Is generated from {@link org.apache.plc4x.java.scraper.config.ScraperConfiguration} by
+ * merging the sources and the {@link org.apache.plc4x.java.scraper.config.JobConfiguration}.
+ */
public class ScrapeJob {
private final String name;
diff --git a/plc4j/utils/scraper/src/main/java/org/apache/plc4x/java/scraper/ScraperTask.java b/plc4j/utils/scraper/src/main/java/org/apache/plc4x/java/scraper/ScraperTask.java
index 3175ee1..56f3f8b 100644
--- a/plc4j/utils/scraper/src/main/java/org/apache/plc4x/java/scraper/ScraperTask.java
+++ b/plc4j/utils/scraper/src/main/java/org/apache/plc4x/java/scraper/ScraperTask.java
@@ -42,7 +42,9 @@ import java.util.function.Function;
import java.util.stream.Collectors;
/**
- * Plc Scraper that scrapes one source.
+ * Plc Scraper Task that scrapes one source.
+ * One {@link ScrapeJob} gets split into multiple tasks.
+ * One task for each source that is defined in the {@link org.apache.plc4x.java.scraper.config.JobConfiguration}.
*/
public class ScraperTask implements Runnable {
diff --git a/plc4j/utils/scraper/src/main/java/org/apache/plc4x/java/scraper/config/JobConfiguration.java b/plc4j/utils/scraper/src/main/java/org/apache/plc4x/java/scraper/config/JobConfiguration.java
index 6cb2ede..2fd50f7 100644
--- a/plc4j/utils/scraper/src/main/java/org/apache/plc4x/java/scraper/config/JobConfiguration.java
+++ b/plc4j/utils/scraper/src/main/java/org/apache/plc4x/java/scraper/config/JobConfiguration.java
@@ -21,14 +21,13 @@ package org.apache.plc4x.java.scraper.config;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
-import org.apache.plc4x.java.api.exceptions.PlcRuntimeException;
-import java.io.IOException;
import java.util.List;
import java.util.Map;
+/**
+ * Configuration for one {@link org.apache.plc4x.java.scraper.ScrapeJob} in the @{@link ScraperConfiguration}.
+ */
public class JobConfiguration {
private final String name;
@@ -36,6 +35,13 @@ public class JobConfiguration {
private final List<String> sources;
private final Map<String, String> fields;
+ /**
+ * Default construcotr
+ * @param name Job Name / identifier
+ * @param scrapeRate Scrape rate in ms
+ * @param sources source alias (<b>not</b> connection string but the alias (from @{@link ScraperConfiguration}).
+ * @param fields Map from field alias (how it is named in the result map) to plc4x field query
+ */
@JsonCreator
JobConfiguration(@JsonProperty(value = "name", required = true) String name,
@JsonProperty(value = "scrapeRate", required = true) int scrapeRate,
diff --git a/plc4j/utils/scraper/src/main/java/org/apache/plc4x/java/scraper/config/ScraperConfiguration.java b/plc4j/utils/scraper/src/main/java/org/apache/plc4x/java/scraper/config/ScraperConfiguration.java
index 48d688c..785e01d 100644
--- a/plc4j/utils/scraper/src/main/java/org/apache/plc4x/java/scraper/config/ScraperConfiguration.java
+++ b/plc4j/utils/scraper/src/main/java/org/apache/plc4x/java/scraper/config/ScraperConfiguration.java
@@ -39,12 +39,16 @@ import java.util.stream.Collectors;
/**
* Configuration class for {@link Scraper}.
*/
-
public class ScraperConfiguration {
private final Map<String, String> sources;
private final List<JobConfiguration> jobConfigurations;
+ /**
+ * Default constructor.
+ * @param sources Map from connection alias to connection string
+ * @param jobConfigurations List of configurations one for each Job
+ */
@JsonCreator
ScraperConfiguration(@JsonProperty(value = "sources", required = true) Map<String, String> sources,
@JsonProperty(value = "jobs", required = true) List<JobConfiguration> jobConfigurations) {