From 4fd559b70f2f90b512b2713134ce76758159ed1b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=B6ren=20Henning?= <stu114708@informatik.uni-kiel.de>
Date: Tue, 19 Apr 2016 15:25:08 +0200
Subject: [PATCH] refactored GraphML writer stages pipe and filter architecture
---
.../analysis/TraceAnalysisConfiguration.java | 6 +--
.../trace/graphoutput/GraphMLWriter.java | 4 +-
.../analysis/util/AbstractCombinerStage.java | 44 +++++++++++++++
.../kieker/analysis/util/FunctionStage.java | 30 +++++++++++
.../analysis/util/JAXBMarshalElement.java | 1 +
.../analysis/util/JAXBMarshalStage.java | 19 ++++---
.../analysis/util/JAXBMarshalStageOld.java | 53 +++++++++++++++++++
...osite.java => GraphMLFileWriterStage.java} | 6 +--
.../graphml/GraphMLTransformationStage.java | 40 --------------
.../GraphMLTypeTransformationStage.java | 20 +++++++
.../graphml/GraphMLWriterComposite.java | 34 ------------
.../export/graphml/GraphMLWriterStage.java | 45 ++++++++++++++++
.../graphml/GraphTypeTransformationStage.java | 21 ++++++++
.../graphml/JAXBElementWrapperStage.java | 22 ++++++++
14 files changed, 253 insertions(+), 92 deletions(-)
create mode 100644 src/main/java/kieker/analysis/util/AbstractCombinerStage.java
create mode 100644 src/main/java/kieker/analysis/util/FunctionStage.java
create mode 100644 src/main/java/kieker/analysis/util/JAXBMarshalStageOld.java
rename src/main/java/kieker/analysis/util/graph/export/graphml/{GraphMLFileWriterComposite.java => GraphMLFileWriterStage.java} (70%)
delete mode 100644 src/main/java/kieker/analysis/util/graph/export/graphml/GraphMLTransformationStage.java
create mode 100644 src/main/java/kieker/analysis/util/graph/export/graphml/GraphMLTypeTransformationStage.java
delete mode 100644 src/main/java/kieker/analysis/util/graph/export/graphml/GraphMLWriterComposite.java
create mode 100644 src/main/java/kieker/analysis/util/graph/export/graphml/GraphMLWriterStage.java
create mode 100644 src/main/java/kieker/analysis/util/graph/export/graphml/GraphTypeTransformationStage.java
create mode 100644 src/main/java/kieker/analysis/util/graph/export/graphml/JAXBElementWrapperStage.java
diff --git a/src/main/java/kieker/analysis/TraceAnalysisConfiguration.java b/src/main/java/kieker/analysis/TraceAnalysisConfiguration.java
index e6ede17b..8df56596 100644
--- a/src/main/java/kieker/analysis/TraceAnalysisConfiguration.java
+++ b/src/main/java/kieker/analysis/TraceAnalysisConfiguration.java
@@ -21,7 +21,7 @@ import kieker.analysis.trace.traversal.AggrTraceTraverserStage;
import kieker.analysis.trace.traversal.TraceTraverserStage;
import kieker.analysis.util.graph.Graph;
import kieker.analysis.util.graph.export.dot.DotFileWriterStage;
-import kieker.analysis.util.graph.export.graphml.GraphMLFileWriterComposite;
+import kieker.analysis.util.graph.export.graphml.GraphMLFileWriterStage;
import kieker.common.record.IMonitoringRecord;
import kieker.common.record.misc.KiekerMetadataRecord;
@@ -75,7 +75,7 @@ public class TraceAnalysisConfiguration extends Configuration {
TraceTraverserStage traceTraverserStage = new TraceTraverserStage();
final Distributor<Graph> graphDistributor = new Distributor<>(new CopyByReferenceStrategy());// TODO use clone
- GraphMLFileWriterComposite graphMLFileWriterComposite = new GraphMLFileWriterComposite(graphFilesOutputDir);
+ GraphMLFileWriterStage graphMLFileWriterComposite = new GraphMLFileWriterStage(graphFilesOutputDir);
// DotTraceStyleStage dotTraceStyleStage = new DotTraceStyleStage();
DotFileWriterStage dotFileWriterStage = new DotFileWriterStage(graphFilesOutputDir);
@@ -89,7 +89,7 @@ public class TraceAnalysisConfiguration extends Configuration {
final Distributor<AggregatedTrace> aggregatedTraceDistributor = new Distributor<>(new CopyByReferenceStrategy());
AggrTraceTraverserStage aggrTraceTraverser = new AggrTraceTraverserStage();
final Distributor<Graph> graphDistributor2 = new Distributor<>(new CopyByReferenceStrategy()); // TODO use clone
- GraphMLFileWriterComposite graphMLFileWriterComposite2 = new GraphMLFileWriterComposite(graphFilesOutputDir);
+ GraphMLFileWriterStage graphMLFileWriterComposite2 = new GraphMLFileWriterStage(graphFilesOutputDir);
// DotTraceStyleStage dotAggrTraceStyleStage = new DotTraceStyleStage();
DotFileWriterStage dotFileWriterStage2 = new DotFileWriterStage(graphFilesOutputDir);
diff --git a/src/main/java/kieker/analysis/trace/graphoutput/GraphMLWriter.java b/src/main/java/kieker/analysis/trace/graphoutput/GraphMLWriter.java
index 84a47670..8afe3d5c 100644
--- a/src/main/java/kieker/analysis/trace/graphoutput/GraphMLWriter.java
+++ b/src/main/java/kieker/analysis/trace/graphoutput/GraphMLWriter.java
@@ -5,12 +5,12 @@ import java.io.IOException;
import com.tinkerpop.blueprints.Graph;
import kieker.analysis.util.blueprintsgraph.NamedGraph;
-import kieker.analysis.util.graph.export.graphml.GraphMLFileWriterComposite;
+import kieker.analysis.util.graph.export.graphml.GraphMLFileWriterStage;
import teetime.framework.AbstractConsumerStage;
/**
- * @deprecated use {@link GraphMLFileWriterComposite} instead.
+ * @deprecated use {@link GraphMLFileWriterStage} instead.
*
* @author Sören Henning
*
diff --git a/src/main/java/kieker/analysis/util/AbstractCombinerStage.java b/src/main/java/kieker/analysis/util/AbstractCombinerStage.java
new file mode 100644
index 00000000..4fbd4739
--- /dev/null
+++ b/src/main/java/kieker/analysis/util/AbstractCombinerStage.java
@@ -0,0 +1,44 @@
+package kieker.analysis.util;
+
+import java.util.LinkedList;
+import java.util.Queue;
+
+import teetime.framework.AbstractStage;
+import teetime.framework.InputPort;
+
+public abstract class AbstractCombinerStage<I, J> extends AbstractStage {
+
+ protected final InputPort<I> inputPort1 = this.createInputPort();
+ protected final InputPort<J> inputPort2 = this.createInputPort();
+
+ private final Queue<I> elements1 = new LinkedList<>();
+ private final Queue<J> elements2 = new LinkedList<>();
+
+ public final InputPort<I> getInputPort1() {
+ return this.inputPort1;
+ }
+
+ public final InputPort<J> getInputPort2() {
+ return this.inputPort2;
+ }
+
+ @Override
+ protected void execute() {
+
+ final I element1 = this.getInputPort1().receive();
+ if (element1 != null) {
+ elements1.add(element1);
+ }
+ final J element2 = this.getInputPort2().receive();
+ if (element2 != null) {
+ elements2.add(element2);
+ }
+
+ if (elements1.size() > 0 && elements2.size() > 0) {
+ this.combine(elements1.poll(), elements2.poll());
+ }
+ }
+
+ protected abstract void combine(final I element1, final J element2);
+
+}
diff --git a/src/main/java/kieker/analysis/util/FunctionStage.java b/src/main/java/kieker/analysis/util/FunctionStage.java
new file mode 100644
index 00000000..a9e38173
--- /dev/null
+++ b/src/main/java/kieker/analysis/util/FunctionStage.java
@@ -0,0 +1,30 @@
+package kieker.analysis.util;
+
+import java.util.function.Function;
+
+import teetime.stage.basic.AbstractTransformation;
+
+public class FunctionStage<I, O> extends AbstractTransformation<I, O> {
+
+ private Function<I, O> function;
+
+ public FunctionStage(final Function<I, O> function) {
+ super();
+ this.function = function;
+ }
+
+ public Function<I, O> getFunction() {
+ return function;
+ }
+
+ public void setFunction(final Function<I, O> function) {
+ this.function = function;
+ }
+
+ @Override
+ protected void execute(final I element) {
+ final O transformedElement = function.apply(element);
+ this.getOutputPort().send(transformedElement);
+ }
+
+}
diff --git a/src/main/java/kieker/analysis/util/JAXBMarshalElement.java b/src/main/java/kieker/analysis/util/JAXBMarshalElement.java
index 7b5b88c2..c6541479 100644
--- a/src/main/java/kieker/analysis/util/JAXBMarshalElement.java
+++ b/src/main/java/kieker/analysis/util/JAXBMarshalElement.java
@@ -4,6 +4,7 @@ import java.io.OutputStream;
import javax.xml.bind.JAXBElement;
+@Deprecated
public class JAXBMarshalElement<T> {
private JAXBElement<T> element;
diff --git a/src/main/java/kieker/analysis/util/JAXBMarshalStage.java b/src/main/java/kieker/analysis/util/JAXBMarshalStage.java
index cf97904b..de13c24a 100644
--- a/src/main/java/kieker/analysis/util/JAXBMarshalStage.java
+++ b/src/main/java/kieker/analysis/util/JAXBMarshalStage.java
@@ -1,25 +1,23 @@
package kieker.analysis.util;
+import java.io.OutputStream;
+
import javax.xml.bind.JAXBContext;
+import javax.xml.bind.JAXBElement;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;
-import teetime.framework.AbstractConsumerStage;
-
/**
- * This stage marshals the content tree rooted at an incoming element into an
- * output stream.
+ * This stage marshals the content tree rooted at an incoming element at the
+ * first input port into an output stream at the second input port.
*
* A class object has to be passed at creation. Only elements of this type
* wrapped in a {@code JAXBElement} could be marshaled.
*
- * Incoming elements must be {@code JAXBMarshalElement} which stores the
- * {@code JAXBElement} and an output stream.
- *
* @author Sören Henning
*
*/
-public class JAXBMarshalStage<T> extends AbstractConsumerStage<JAXBMarshalElement<T>> {
+public class JAXBMarshalStage<T> extends AbstractCombinerStage<JAXBElement<T>, OutputStream> {
private static final Boolean FORMATTED_OUTPUT_DEFAULT = Boolean.TRUE;
@@ -40,9 +38,10 @@ public class JAXBMarshalStage<T> extends AbstractConsumerStage<JAXBMarshalElemen
}
@Override
- protected void execute(final JAXBMarshalElement<T> element) {
+ protected void combine(final JAXBElement<T> jaxbElement, final OutputStream outputStream) {
+
try {
- marshaller.marshal(element.getElement(), element.getOutputStream());
+ marshaller.marshal(jaxbElement, outputStream);
} catch (JAXBException e) {
// TODO Exception
throw new IllegalStateException("The received element could not be marshalled.", e);
diff --git a/src/main/java/kieker/analysis/util/JAXBMarshalStageOld.java b/src/main/java/kieker/analysis/util/JAXBMarshalStageOld.java
new file mode 100644
index 00000000..6251e1df
--- /dev/null
+++ b/src/main/java/kieker/analysis/util/JAXBMarshalStageOld.java
@@ -0,0 +1,53 @@
+package kieker.analysis.util;
+
+import javax.xml.bind.JAXBContext;
+import javax.xml.bind.JAXBException;
+import javax.xml.bind.Marshaller;
+
+import teetime.framework.AbstractConsumerStage;
+
+/**
+ * This stage marshals the content tree rooted at an incoming element into an
+ * output stream.
+ *
+ * A class object has to be passed at creation. Only elements of this type
+ * wrapped in a {@code JAXBElement} could be marshaled.
+ *
+ * Incoming elements must be {@code JAXBMarshalElement} which stores the
+ * {@code JAXBElement} and an output stream.
+ *
+ * @author Sören Henning
+ *
+ */
+@Deprecated
+public class JAXBMarshalStageOld<T> extends AbstractConsumerStage<JAXBMarshalElement<T>> {
+
+ private static final Boolean FORMATTED_OUTPUT_DEFAULT = Boolean.TRUE;
+
+ private final Marshaller marshaller;
+
+ public JAXBMarshalStageOld(final Class<T> elementsClass) {
+ this(elementsClass, FORMATTED_OUTPUT_DEFAULT);
+ }
+
+ public JAXBMarshalStageOld(final Class<T> elementsClass, final Boolean formattedOutput) {
+ try {
+ this.marshaller = JAXBContext.newInstance(elementsClass).createMarshaller();
+ marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, formattedOutput);
+ } catch (JAXBException e) {
+ // TODO Exception
+ throw new IllegalStateException(e);
+ }
+ }
+
+ @Override
+ protected void execute(final JAXBMarshalElement<T> element) {
+ try {
+ marshaller.marshal(element.getElement(), element.getOutputStream());
+ } catch (JAXBException e) {
+ // TODO Exception
+ throw new IllegalStateException("The received element could not be marshalled.", e);
+ }
+ }
+
+}
diff --git a/src/main/java/kieker/analysis/util/graph/export/graphml/GraphMLFileWriterComposite.java b/src/main/java/kieker/analysis/util/graph/export/graphml/GraphMLFileWriterStage.java
similarity index 70%
rename from src/main/java/kieker/analysis/util/graph/export/graphml/GraphMLFileWriterComposite.java
rename to src/main/java/kieker/analysis/util/graph/export/graphml/GraphMLFileWriterStage.java
index 52effa8d..692b2522 100644
--- a/src/main/java/kieker/analysis/util/graph/export/graphml/GraphMLFileWriterComposite.java
+++ b/src/main/java/kieker/analysis/util/graph/export/graphml/GraphMLFileWriterStage.java
@@ -8,9 +8,9 @@ import kieker.analysis.util.graph.Graph;
import kieker.analysis.util.graph.mapping.SimpleFileNameMapper;
import kieker.analysis.util.graph.util.FileExtension;
-public class GraphMLFileWriterComposite extends GraphMLWriterComposite {
+public class GraphMLFileWriterStage extends GraphMLWriterStage {
- public GraphMLFileWriterComposite(final Function<Graph, String> fileNameMapper) {
+ public GraphMLFileWriterStage(final Function<Graph, String> fileNameMapper) {
super(fileNameMapper.andThen(fileName -> {
try {
return new FileOutputStream(fileName);
@@ -20,7 +20,7 @@ public class GraphMLFileWriterComposite extends GraphMLWriterComposite {
}));
}
- public GraphMLFileWriterComposite(final String outputDirectory) {
+ public GraphMLFileWriterStage(final String outputDirectory) {
this(new SimpleFileNameMapper(outputDirectory, FileExtension.GRAPHML));
}
diff --git a/src/main/java/kieker/analysis/util/graph/export/graphml/GraphMLTransformationStage.java b/src/main/java/kieker/analysis/util/graph/export/graphml/GraphMLTransformationStage.java
deleted file mode 100644
index 5ab46db3..00000000
--- a/src/main/java/kieker/analysis/util/graph/export/graphml/GraphMLTransformationStage.java
+++ /dev/null
@@ -1,40 +0,0 @@
-package kieker.analysis.util.graph.export.graphml;
-
-import java.io.OutputStream;
-import java.util.function.Function;
-
-import javax.xml.bind.JAXBElement;
-
-import org.graphdrawing.graphml.GraphmlType;
-import org.graphdrawing.graphml.ObjectFactory;
-
-import kieker.analysis.util.JAXBMarshalElement;
-import kieker.analysis.util.graph.Graph;
-
-import teetime.stage.basic.AbstractTransformation;
-
-public class GraphMLTransformationStage extends AbstractTransformation<Graph, JAXBMarshalElement<GraphmlType>> {
-
- private final ObjectFactory objectFactory = new ObjectFactory();
- private final Function<Graph, OutputStream> outputStreamMapper;
-
- public GraphMLTransformationStage(final Function<Graph, OutputStream> outputStreamMapper) {
- this.outputStreamMapper = outputStreamMapper;
- }
-
- @Override
- protected void execute(final Graph graph) {
-
- final GraphTypeTransformer graphTypeTransformer = new GraphTypeTransformer(graph);
- final GraphmlType graphmlType = new GraphmlType();
- graphmlType.getGraphOrData().add(graphTypeTransformer.transform());
- final JAXBElement<GraphmlType> jaxbElement = objectFactory.createGraphml(graphmlType);
-
- final OutputStream outputStream = outputStreamMapper.apply(graph);
- final JAXBMarshalElement<GraphmlType> marshalElement = new JAXBMarshalElement<>(jaxbElement, outputStream);
-
- this.getOutputPort().send(marshalElement);
-
- }
-
-}
diff --git a/src/main/java/kieker/analysis/util/graph/export/graphml/GraphMLTypeTransformationStage.java b/src/main/java/kieker/analysis/util/graph/export/graphml/GraphMLTypeTransformationStage.java
new file mode 100644
index 00000000..004da480
--- /dev/null
+++ b/src/main/java/kieker/analysis/util/graph/export/graphml/GraphMLTypeTransformationStage.java
@@ -0,0 +1,20 @@
+package kieker.analysis.util.graph.export.graphml;
+
+import org.graphdrawing.graphml.GraphType;
+import org.graphdrawing.graphml.GraphmlType;
+
+import teetime.stage.basic.AbstractTransformation;
+
+public class GraphMLTypeTransformationStage extends AbstractTransformation<GraphType, GraphmlType> {
+
+ @Override
+ protected void execute(final GraphType graphType) {
+
+ final GraphmlType graphmlType = new GraphmlType();
+ graphmlType.getGraphOrData().add(graphType);
+
+ this.getOutputPort().send(graphmlType);
+
+ }
+
+}
diff --git a/src/main/java/kieker/analysis/util/graph/export/graphml/GraphMLWriterComposite.java b/src/main/java/kieker/analysis/util/graph/export/graphml/GraphMLWriterComposite.java
deleted file mode 100644
index 7ed9e673..00000000
--- a/src/main/java/kieker/analysis/util/graph/export/graphml/GraphMLWriterComposite.java
+++ /dev/null
@@ -1,34 +0,0 @@
-package kieker.analysis.util.graph.export.graphml;
-
-import java.io.OutputStream;
-import java.util.function.Function;
-
-import org.graphdrawing.graphml.GraphmlType;
-
-import kieker.analysis.util.JAXBMarshalStage;
-import kieker.analysis.util.graph.Graph;
-
-import teetime.framework.CompositeStage;
-import teetime.framework.InputPort;
-
-public class GraphMLWriterComposite extends CompositeStage {
-
- private final InputPort<Graph> inputPort;
-
- public GraphMLWriterComposite(final Function<Graph, OutputStream> outputStreamMapper) {
- final GraphMLTransformationStage graphTypeTransformer;
- final JAXBMarshalStage<GraphmlType> jaxbMarshaller;
-
- graphTypeTransformer = new GraphMLTransformationStage(outputStreamMapper);
- jaxbMarshaller = new JAXBMarshalStage<GraphmlType>(GraphmlType.class);
-
- this.inputPort = graphTypeTransformer.getInputPort();
-
- super.connectPorts(graphTypeTransformer.getOutputPort(), jaxbMarshaller.getInputPort());
- }
-
- public InputPort<Graph> getInputPort() {
- return this.inputPort;
- }
-
-}
diff --git a/src/main/java/kieker/analysis/util/graph/export/graphml/GraphMLWriterStage.java b/src/main/java/kieker/analysis/util/graph/export/graphml/GraphMLWriterStage.java
new file mode 100644
index 00000000..d2aa9c17
--- /dev/null
+++ b/src/main/java/kieker/analysis/util/graph/export/graphml/GraphMLWriterStage.java
@@ -0,0 +1,45 @@
+package kieker.analysis.util.graph.export.graphml;
+
+import java.io.OutputStream;
+import java.util.function.Function;
+
+import org.graphdrawing.graphml.GraphmlType;
+
+import kieker.analysis.util.FunctionStage;
+import kieker.analysis.util.JAXBMarshalStage;
+import kieker.analysis.util.graph.Graph;
+
+import teetime.framework.CompositeStage;
+import teetime.framework.InputPort;
+import teetime.stage.basic.distributor.Distributor;
+import teetime.stage.basic.distributor.strategy.CopyByReferenceStrategy;
+
+public class GraphMLWriterStage extends CompositeStage {
+
+ private final InputPort<Graph> inputPort;
+
+ public GraphMLWriterStage(final Function<Graph, OutputStream> outputStreamMapper) {
+
+ final Distributor<Graph> graphDistributor = new Distributor<>(new CopyByReferenceStrategy());
+ final GraphTypeTransformationStage graphTypeTransformer = new GraphTypeTransformationStage();
+ final GraphMLTypeTransformationStage graphMLTypeTransformer = new GraphMLTypeTransformationStage();
+ final JAXBElementWrapperStage jaxbElementWrapper = new JAXBElementWrapperStage();
+ final JAXBMarshalStage<GraphmlType> jaxbMarshaller = new JAXBMarshalStage<>(GraphmlType.class);
+ final FunctionStage<Graph, OutputStream> outputStreamMapperStage = new FunctionStage<>(outputStreamMapper);
+
+ this.inputPort = graphDistributor.getInputPort();
+
+ super.connectPorts(graphDistributor.getNewOutputPort(), graphTypeTransformer.getInputPort());
+ super.connectPorts(graphTypeTransformer.getOutputPort(), graphMLTypeTransformer.getInputPort());
+ super.connectPorts(graphMLTypeTransformer.getOutputPort(), jaxbElementWrapper.getInputPort());
+ super.connectPorts(jaxbElementWrapper.getOutputPort(), jaxbMarshaller.getInputPort1());
+ super.connectPorts(graphDistributor.getNewOutputPort(), outputStreamMapperStage.getInputPort());
+ super.connectPorts(outputStreamMapperStage.getOutputPort(), jaxbMarshaller.getInputPort2());
+
+ }
+
+ public InputPort<Graph> getInputPort() {
+ return this.inputPort;
+ }
+
+}
diff --git a/src/main/java/kieker/analysis/util/graph/export/graphml/GraphTypeTransformationStage.java b/src/main/java/kieker/analysis/util/graph/export/graphml/GraphTypeTransformationStage.java
new file mode 100644
index 00000000..b1227d56
--- /dev/null
+++ b/src/main/java/kieker/analysis/util/graph/export/graphml/GraphTypeTransformationStage.java
@@ -0,0 +1,21 @@
+package kieker.analysis.util.graph.export.graphml;
+
+import org.graphdrawing.graphml.GraphType;
+
+import kieker.analysis.util.graph.Graph;
+
+import teetime.stage.basic.AbstractTransformation;
+
+public class GraphTypeTransformationStage extends AbstractTransformation<Graph, GraphType> {
+
+ @Override
+ protected void execute(final Graph graph) {
+
+ final GraphTypeTransformer graphTypeTransformer = new GraphTypeTransformer(graph);
+ final GraphType graphType = graphTypeTransformer.transform();
+
+ this.getOutputPort().send(graphType);
+
+ }
+
+}
diff --git a/src/main/java/kieker/analysis/util/graph/export/graphml/JAXBElementWrapperStage.java b/src/main/java/kieker/analysis/util/graph/export/graphml/JAXBElementWrapperStage.java
new file mode 100644
index 00000000..973eedaf
--- /dev/null
+++ b/src/main/java/kieker/analysis/util/graph/export/graphml/JAXBElementWrapperStage.java
@@ -0,0 +1,22 @@
+package kieker.analysis.util.graph.export.graphml;
+
+import javax.xml.bind.JAXBElement;
+
+import org.graphdrawing.graphml.GraphmlType;
+import org.graphdrawing.graphml.ObjectFactory;
+
+import teetime.stage.basic.AbstractTransformation;
+
+public class JAXBElementWrapperStage extends AbstractTransformation<GraphmlType, JAXBElement<GraphmlType>> {
+
+ private final ObjectFactory objectFactory = new ObjectFactory();
+
+ @Override
+ protected void execute(final GraphmlType graphmlType) {
+
+ final JAXBElement<GraphmlType> jaxbElement = objectFactory.createGraphml(graphmlType);
+ this.getOutputPort().send(jaxbElement);
+
+ }
+
+}
--
GitLab