From f96daafce0467a72cfc2fbfa8f22e76a288421f4 Mon Sep 17 00:00:00 2001
From: Nils Christian Ehmke <nie@informatik.uni-kiel.de>
Date: Sun, 1 Feb 2015 10:15:10 +0100
Subject: [PATCH] Added some comments
---
.../java/kieker/gui/common/domain/StatisticType.java | 2 +-
.../common/model/importer/stages/AbstractStage.java | 10 ++++++++++
.../model/importer/stages/FailedTraceFilter.java | 8 ++++++++
.../importer/stages/FailureContainingTraceFilter.java | 8 ++++++++
.../common/model/importer/stages/ReadingComposite.java | 5 +++++
.../common/model/importer/stages/TraceAggregator.java | 2 +-
.../model/importer/stages/TraceReconstructor.java | 4 ++--
7 files changed, 35 insertions(+), 4 deletions(-)
diff --git a/src/main/java/kieker/gui/common/domain/StatisticType.java b/src/main/java/kieker/gui/common/domain/StatisticType.java
index 8064b1b9..43f152b8 100644
--- a/src/main/java/kieker/gui/common/domain/StatisticType.java
+++ b/src/main/java/kieker/gui/common/domain/StatisticType.java
@@ -17,7 +17,7 @@
package kieker.gui.common.domain;
/**
- * This enumeration shows the available statistics (and their datatype) which can be added for example to traces or operation calls.
+ * This enumeration shows the available statistics (and their datatype) which can be added for example to traces or operation calls.
*
* @author Nils Christian Ehmke
*/
diff --git a/src/main/java/kieker/gui/common/model/importer/stages/AbstractStage.java b/src/main/java/kieker/gui/common/model/importer/stages/AbstractStage.java
index 7912d8ba..c72adbef 100644
--- a/src/main/java/kieker/gui/common/model/importer/stages/AbstractStage.java
+++ b/src/main/java/kieker/gui/common/model/importer/stages/AbstractStage.java
@@ -19,6 +19,16 @@ package kieker.gui.common.model.importer.stages;
import teetime.framework.AbstractConsumerStage;
import teetime.framework.OutputPort;
+/**
+ * This is a abstract base for {@code TeeTime} stages with exactly one input and one output port.
+ *
+ * @author Nils Christian Ehmke
+ *
+ * @param <I>
+ * The type of the input port.
+ * @param <O>
+ * The type of the output port.
+ */
public abstract class AbstractStage<I, O> extends AbstractConsumerStage<I> {
private final OutputPort<O> outputPort = super.createOutputPort();
diff --git a/src/main/java/kieker/gui/common/model/importer/stages/FailedTraceFilter.java b/src/main/java/kieker/gui/common/model/importer/stages/FailedTraceFilter.java
index cccbeedf..dd6da6ae 100644
--- a/src/main/java/kieker/gui/common/model/importer/stages/FailedTraceFilter.java
+++ b/src/main/java/kieker/gui/common/model/importer/stages/FailedTraceFilter.java
@@ -18,6 +18,14 @@ package kieker.gui.common.model.importer.stages;
import kieker.gui.common.domain.AbstractTrace;
+/**
+ * This stage filters incoming traces and forwards only those which are failed.
+ *
+ * @author Nils Christian Ehmke
+ *
+ * @param <T>
+ * The precise type of the incoming and outgoing traces.
+ */
public final class FailedTraceFilter<T extends AbstractTrace> extends AbstractStage<T, T> {
@Override
diff --git a/src/main/java/kieker/gui/common/model/importer/stages/FailureContainingTraceFilter.java b/src/main/java/kieker/gui/common/model/importer/stages/FailureContainingTraceFilter.java
index af3d0d74..be2c2b13 100644
--- a/src/main/java/kieker/gui/common/model/importer/stages/FailureContainingTraceFilter.java
+++ b/src/main/java/kieker/gui/common/model/importer/stages/FailureContainingTraceFilter.java
@@ -18,6 +18,14 @@ package kieker.gui.common.model.importer.stages;
import kieker.gui.common.domain.AbstractTrace;
+/**
+ * This stage filters incoming traces and forwards only those which are failed or contain a failure in the call tree.
+ *
+ * @author Nils Christian Ehmke
+ *
+ * @param <T>
+ * The precise type of the incoming and outgoing traces.
+ */
public final class FailureContainingTraceFilter<T extends AbstractTrace> extends AbstractStage<T, T> {
@Override
diff --git a/src/main/java/kieker/gui/common/model/importer/stages/ReadingComposite.java b/src/main/java/kieker/gui/common/model/importer/stages/ReadingComposite.java
index 1d7e5ac3..c6f16fc5 100644
--- a/src/main/java/kieker/gui/common/model/importer/stages/ReadingComposite.java
+++ b/src/main/java/kieker/gui/common/model/importer/stages/ReadingComposite.java
@@ -34,6 +34,11 @@ import teetime.stage.InitialElementProducer;
import teetime.stage.className.ClassNameRegistryRepository;
import teetime.stage.io.filesystem.Dir2RecordsFilter;
+/**
+ * This is a composite stage which deserializes monitoring records from a specific directory and forwards them to the output port.
+ *
+ * @author Nils Christian Ehmke
+ */
public final class ReadingComposite extends Stage {
private final InitialElementProducer<File> producer;
diff --git a/src/main/java/kieker/gui/common/model/importer/stages/TraceAggregator.java b/src/main/java/kieker/gui/common/model/importer/stages/TraceAggregator.java
index f0b442b6..baec85e9 100644
--- a/src/main/java/kieker/gui/common/model/importer/stages/TraceAggregator.java
+++ b/src/main/java/kieker/gui/common/model/importer/stages/TraceAggregator.java
@@ -25,7 +25,7 @@ import kieker.gui.common.domain.AggregatedTrace;
import kieker.gui.common.domain.Trace;
/**
- * Aggregates incoming traces into trace equivalence classes.
+ * This stage aggregates incoming traces into trace equivalence classes.
*
* @author Nils Christian Ehmke
*/
diff --git a/src/main/java/kieker/gui/common/model/importer/stages/TraceReconstructor.java b/src/main/java/kieker/gui/common/model/importer/stages/TraceReconstructor.java
index 01c2c626..50085547 100644
--- a/src/main/java/kieker/gui/common/model/importer/stages/TraceReconstructor.java
+++ b/src/main/java/kieker/gui/common/model/importer/stages/TraceReconstructor.java
@@ -31,8 +31,8 @@ import kieker.gui.common.domain.OperationCall;
import kieker.gui.common.domain.Trace;
/**
- * Reconstruct traces based on the incoming instances of {@code IFlowRecord}. Currently only {@link TraceMetadata}, {@link BeforeOperationEvent} and
- * {@link AfterOperationEvent} instances are supported.
+ * Reconstruct traces based on the incoming instances of {@code IFlowRecord}. Currently only {@link TraceMetadata}, {@link BeforeOperationEvent} and {@link AfterOperationEvent}
+ * instances are supported.
*
* @author Nils Christian Ehmke
*/
--
GitLab