diff --git a/src/main/java/kieker/gui/common/domain/StatisticType.java b/src/main/java/kieker/gui/common/domain/StatisticType.java index 8064b1b986970f58195ed75b8084029142adaf3c..43f152b8205e66ce4aa69cbca582ae7be8c7435f 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 7912d8badc15555adb7fbe2a2b5b64c76a315b5a..c72adbefea15717f02183205dee0ad49a3f9418e 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 cccbeedfda6c56008a287478e576c6968f8f8e06..dd6da6aef882ed6c2260e501e9aded3a46245ca5 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 af3d0d7448c8d16da35da98085fc4dd651190a8e..be2c2b134e6e6200ca50e31dab6a385b3db7f06d 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 1d7e5ac3e55b11e72745587f76084ca9c4533890..c6f16fc55ef36f93a16401da70c8a4b4840e17ce 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 f0b442b615388c907b7bf93b7508ba2314a27726..baec85e92557ccdd2cde46f86423d7c6cd889a7c 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 01c2c626090b24e882860065db52dfddd841cf9e..50085547bf55697923c798207d3adac5e84b6b66 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 */