You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@wayang.apache.org by be...@apache.org on 2021/09/22 15:21:42 UTC
[incubator-wayang] 01/15: [WAYANG-28] Add javadoc to tags package
This is an automated email from the ASF dual-hosted git repository.
bertty pushed a commit to branch WAYANG-28
in repository https://gitbox.apache.org/repos/asf/incubator-wayang.git
commit 12d9afa9e406195ae030ae7d0a009e1ade919bb7
Author: Bertty Contreras-Rojas <be...@scalytics.io>
AuthorDate: Tue May 4 12:14:05 2021 -0400
[WAYANG-28] Add javadoc to tags package
---
.../wayang/plugin/hackit/core/tags/CrashTag.java | 15 ++++++++++
.../wayang/plugin/hackit/core/tags/DebugTag.java | 15 ++++++++++
.../wayang/plugin/hackit/core/tags/DisplayTag.java | 16 ++++++++++
.../wayang/plugin/hackit/core/tags/HackitTag.java | 34 ++++++++++++++++++++++
.../plugin/hackit/core/tags/HackitTagBuilder.java | 1 +
.../wayang/plugin/hackit/core/tags/LogTag.java | 17 +++++++++++
.../wayang/plugin/hackit/core/tags/PauseTag.java | 16 ++++++++++
.../wayang/plugin/hackit/core/tags/SkipTag.java | 17 +++++++++++
.../wayang/plugin/hackit/core/tags/TraceTag.java | 16 ++++++++++
9 files changed, 147 insertions(+)
diff --git a/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/CrashTag.java b/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/CrashTag.java
index 94fd98e..dca602a 100644
--- a/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/CrashTag.java
+++ b/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/CrashTag.java
@@ -17,31 +17,46 @@
*/
package org.apache.wayang.plugin.hackit.core.tags;
+/**
+ * CrashTag is the {@link HackitTag} that identify the {@link org.apache.wayang.plugin.hackit.core.tuple.HackitTuple} that
+ * produce and exception that goes from UDF context and could make that the process stop.
+ */
public class CrashTag extends HackitTag {
+ /**
+ * seed is the element that allow to have small overhead in memory, is like use
+ * singleton.
+ */
private static CrashTag seed = null;
+ /**
+ * default construct
+ */
private CrashTag(){
super();
}
@Override
public boolean isSendOut() {
+ //TODO: set the correct value to this return
return false;
}
@Override
public boolean isSkip() {
+ //TODO: set the correct value to this return
return false;
}
@Override
public boolean isHaltJob() {
+ //TODO: set the correct value to this return
return false;
}
@Override
public boolean hasCallback() {
+ //TODO: set the correct value to this return
return false;
}
diff --git a/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/DebugTag.java b/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/DebugTag.java
index ec2ad70..7c7a834 100644
--- a/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/DebugTag.java
+++ b/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/DebugTag.java
@@ -17,31 +17,46 @@
*/
package org.apache.wayang.plugin.hackit.core.tags;
+/**
+ * DebugTag is the {@link HackitTag} that identify the {@link org.apache.wayang.plugin.hackit.core.tuple.HackitTuple}
+ * as an element that need to capture the timestamp and send it out to analyse the values
+ */
public class DebugTag extends HackitTag {
+ /**
+ * seed is the element that allow to have small overhead in memory, is like use
+ * singleton.
+ */
private static DebugTag seed = null;
+ /**
+ * default construct
+ */
private DebugTag(){
super();
}
@Override
public boolean isSendOut() {
+ //TODO: set the correct value to this return
return false;
}
@Override
public boolean isSkip() {
+ //TODO: set the correct value to this return
return false;
}
@Override
public boolean isHaltJob() {
+ //TODO: set the correct value to this return
return false;
}
@Override
public boolean hasCallback() {
+ //TODO: set the correct value to this return
return false;
}
diff --git a/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/DisplayTag.java b/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/DisplayTag.java
index 19a673d..d584159 100644
--- a/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/DisplayTag.java
+++ b/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/DisplayTag.java
@@ -17,30 +17,46 @@
*/
package org.apache.wayang.plugin.hackit.core.tags;
+/**
+ * Display is the {@link HackitTag} that identify the {@link org.apache.wayang.plugin.hackit.core.tuple.HackitTuple}
+ * as an element that need to be sent it out to just print the values
+ */
public class DisplayTag extends HackitTag {
+
+ /**
+ * seed is the element that allow to have small overhead in memory, is like use
+ * singleton.
+ */
private static DisplayTag seed = null;
+ /**
+ * default construct
+ */
private DisplayTag(){
super();
}
@Override
public boolean isSendOut() {
+ //TODO: set the correct value to this return
return false;
}
@Override
public boolean isSkip() {
+ //TODO: set the correct value to this return
return false;
}
@Override
public boolean isHaltJob() {
+ //TODO: set the correct value to this return
return false;
}
@Override
public boolean hasCallback() {
+ //TODO: set the correct value to this return
return false;
}
diff --git a/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/HackitTag.java b/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/HackitTag.java
index 6fdcdb4..9d4c813 100644
--- a/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/HackitTag.java
+++ b/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/HackitTag.java
@@ -26,16 +26,38 @@ import java.util.HashMap;
import java.util.List;
import java.util.Map;
+/**
+ * HackitTag extend from {@link ActionGroup} becuase is the element that allows to create
+ * an element that contains the flags for the {@link org.apache.wayang.plugin.hackit.core.tagger.HackitTagger}
+ * and {@link org.apache.wayang.plugin.hackit.core.sniffer.HackitSniffer} could perform the right logic
+ * to {@link org.apache.wayang.plugin.hackit.core.tuple.HackitTuple} that have the tag
+ *
+ * HachitTag implements {@link Serializable} because the element could be send it out.
+ */
public abstract class HackitTag implements Serializable, ActionGroup {
+ /**
+ * TODO: add comment, validate if apply for the use case
+ */
private List<TaggerFunction<?>> callbacks;
+
+ /**
+ * TODO: add comment, validate if apply for the use case
+ */
private Map<String, Object> callback_results;
+ /**
+ * Default Construct
+ */
protected HackitTag(){
+ //TODO: validate is is not better to go by delay option
this.callbacks = new ArrayList<>();
this.callback_results = new HashMap<>();
}
+ /**
+ * TODO: add comment, validate if apply for the use case
+ */
public void callback(){
if(hasCallback()) {
this.callbacks.stream().forEach(
@@ -43,10 +65,22 @@ public abstract class HackitTag implements Serializable, ActionGroup {
);
}
}
+
+ /**
+ * TODO: add comment, validate if apply for the use case
+ *
+ * @param name
+ * @param value
+ */
public void addValue(String name, Object value){
this.callback_results.put(name, value);
}
+ /**
+ * TODO: add comment, validate if apply for the use case
+ *
+ * @return
+ */
public abstract HackitTag getInstance();
@Override
diff --git a/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/HackitTagBuilder.java b/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/HackitTagBuilder.java
index e80a33d..3daffa0 100644
--- a/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/HackitTagBuilder.java
+++ b/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/HackitTagBuilder.java
@@ -17,6 +17,7 @@
*/
package org.apache.wayang.plugin.hackit.core.tags;
+//TODO: all the tags need to be generated by a builder
public class HackitTagBuilder {
//TODO check how to implement wildfly
}
diff --git a/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/LogTag.java b/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/LogTag.java
index fa1020b..d00805e 100644
--- a/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/LogTag.java
+++ b/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/LogTag.java
@@ -17,30 +17,47 @@
*/
package org.apache.wayang.plugin.hackit.core.tags;
+/**
+ * LogTag is the {@link HackitTag} that identify the {@link org.apache.wayang.plugin.hackit.core.tuple.HackitTuple}
+ * as part of logging status, this will produce to send out just the metadata
+ */
public class LogTag extends HackitTag {
+
+ /**
+ * seed is the element that allow to have small overhead in memory, is like use
+ * singleton.
+ */
private static LogTag seed = null;
+ /**
+ * default construct
+ */
public LogTag(){
super();
}
@Override
public boolean isSendOut() {
+ //TODO: set the correct value to this return
return false;
}
@Override
public boolean isSkip() {
+ //TODO: set the correct value to this return
return false;
}
@Override
public boolean isHaltJob() {
+
+ //TODO: set the correct value to this return
return false;
}
@Override
public boolean hasCallback() {
+ //TODO: set the correct value to this return
return false;
}
diff --git a/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/PauseTag.java b/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/PauseTag.java
index 21daab8..31e9515 100644
--- a/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/PauseTag.java
+++ b/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/PauseTag.java
@@ -17,30 +17,46 @@
*/
package org.apache.wayang.plugin.hackit.core.tags;
+/**
+ * PauseTag is the {@link HackitTag} that identify the {@link org.apache.wayang.plugin.hackit.core.tuple.HackitTuple}
+ * where is need to pause all the process and wait for a signal that tell what to do, either kill the process or continues
+ */
public class PauseTag extends HackitTag {
+
+ /**
+ * seed is the element that allow to have small overhead in memory, is like use
+ * singleton.
+ */
private static PauseTag seed = null;
+ /**
+ * default construct
+ */
private PauseTag(){
super();
}
@Override
public boolean isSendOut() {
+ //TODO: set the correct value to this return
return false;
}
@Override
public boolean isSkip() {
+ //TODO: set the correct value to this return
return false;
}
@Override
public boolean isHaltJob() {
+ //TODO: set the correct value to this return
return false;
}
@Override
public boolean hasCallback() {
+ //TODO: set the correct value to this return
return false;
}
diff --git a/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/SkipTag.java b/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/SkipTag.java
index 1e9dd1d..b8523f9 100644
--- a/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/SkipTag.java
+++ b/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/SkipTag.java
@@ -17,30 +17,47 @@
*/
package org.apache.wayang.plugin.hackit.core.tags;
+/**
+ * SkipTag is the {@link HackitTag} that identify the {@link org.apache.wayang.plugin.hackit.core.tuple.HackitTuple}
+ * that not need to be process by the {@link org.apache.wayang.plugin.hackit.core.sniffer.HackitSniffer} and
+ * also need to be removed and not continues with the process.
+ */
public class SkipTag extends HackitTag {
+
+ /**
+ * seed is the element that allow to have small overhead in memory, is like use
+ * singleton.
+ */
private static SkipTag seed = null;
+ /**
+ * default construct
+ */
private SkipTag(){
super();
}
@Override
public boolean isSendOut() {
+ //TODO: set the correct value to this return
return false;
}
@Override
public boolean isSkip() {
+ //TODO: set the correct value to this return
return false;
}
@Override
public boolean isHaltJob() {
+ //TODO: set the correct value to this return
return false;
}
@Override
public boolean hasCallback() {
+ //TODO: set the correct value to this return
return false;
}
diff --git a/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/TraceTag.java b/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/TraceTag.java
index 1482f52..47c1108 100644
--- a/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/TraceTag.java
+++ b/wayang-plugins/wayang-hackit/wayang-hackit-core/src/main/java/org/apache/wayang/plugin/hackit/core/tags/TraceTag.java
@@ -17,30 +17,46 @@
*/
package org.apache.wayang.plugin.hackit.core.tags;
+/**
+ * DebugTag is the {@link HackitTag} that identify the {@link org.apache.wayang.plugin.hackit.core.tuple.HackitTuple}
+ * as an element which will be identifier and also add the timestamp to be enable to follow it
+ */
public class TraceTag extends HackitTag {
+
+ /**
+ * seed is the element that allow to have small overhead in memory, is like use
+ * singleton.
+ */
private static TraceTag seed = null;
+ /**
+ * default construct
+ */
private TraceTag(){
super();
}
@Override
public boolean isSendOut() {
+ //TODO: set the correct value to this return
return false;
}
@Override
public boolean isSkip() {
+ //TODO: set the correct value to this return
return false;
}
@Override
public boolean isHaltJob() {
+ //TODO: set the correct value to this return
return false;
}
@Override
public boolean hasCallback() {
+ //TODO: set the correct value to this return
return false;
}