Package org.variantsync.diffdetective.variation.diff.serialize

Class TikzExporter<L extends Label>

java.lang.Object

org.variantsync.diffdetective.variation.diff.serialize.TikzExporter<L>

All Implemented Interfaces:

Exporter<L>

public final class TikzExporter<L extends Label>
extends Object
implements Exporter<L>

Exporter for TikZ pictures which can be embedded into a LaTeX document. The resulting graph is styled using TikZ styles which have to be set using \tikzset. An example for all required styles can be found in the file tikz_header.tex in the resource directory. This particular style is used by <La>exportFullLatexExample(org.variantsync.diffdetective.variation.diff.VariationDiff<La>,java.nio.file.Path).

Field Summary

Fields

Modifier and Type	Field	Description
private Format<? super L>	format

Constructor Summary

Constructors

Constructor	Description
TikzExporter(Format<? super L> format)

Method Summary

Modifier and Type	Method	Description
<La extends L> void	exportFullLatexExample(VariationDiff<La> variationDiff, Path destination)	Exports a ready to compile LaTeX document containing a TikZ graph exported by <La>exportVariationDiff(org.variantsync.diffdetective.variation.diff.VariationDiff<La>,java.io.OutputStream).
<La extends L> void	exportVariationDiff(VariationDiff<La> variationDiff, OutputStream destination)	Export variationDiff as TikZ graph into destination.
<La extends L> void	exportVariationDiff(VariationDiff<La> variationDiff, Function<DiffNode<La>,Vec2> nodeLayout, OutputStream destination, boolean escape)
<La extends L> void	exportVariationDiff(VariationDiff<La> variationDiff, GraphvizExporter.LayoutAlgorithm algorithm, OutputStream destination)	Export variationDiff as TikZ graph into destination.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

format

private Format<? super L extends Label> format

Constructor Details

TikzExporter

public TikzExporter(Format<? super L> format)

Method Details

exportVariationDiff

public <La extends L> void exportVariationDiff(VariationDiff<La> variationDiff,
 OutputStream destination)
                                        throws IOException

Export variationDiff as TikZ graph into destination. The exported graph starts and ends with the tikzpicture environment and does not include surrounding LaTeX code like the preamble. For a quick way to set up a working LaTeX document see <La>exportFullLatexExample(org.variantsync.diffdetective.variation.diff.VariationDiff<La>,java.nio.file.Path).

Specified by:

exportVariationDiff in interface Exporter<L extends Label>

Parameters:

variationDiff - to be exported

destination - where the result should be written

Throws:

IOException

exportVariationDiff

public <La extends L> void exportVariationDiff(VariationDiff<La> variationDiff,
 GraphvizExporter.LayoutAlgorithm algorithm,
 OutputStream destination)
                                        throws IOException

Export variationDiff as TikZ graph into destination. Same as <La>exportVariationDiff(org.variantsync.diffdetective.variation.diff.VariationDiff<La>,java.io.OutputStream), but allows the selection of a different Graphviz layout algorithm.

Throws:

IOException

exportVariationDiff

public <La extends L> void exportVariationDiff(VariationDiff<La> variationDiff,
 Function<DiffNode<La>,Vec2> nodeLayout,
 OutputStream destination,
 boolean escape)

exportFullLatexExample

public <La extends L> void exportFullLatexExample(VariationDiff<La> variationDiff,
 Path destination)
                                           throws IOException

Exports a ready to compile LaTeX document containing a TikZ graph exported by <La>exportVariationDiff(org.variantsync.diffdetective.variation.diff.VariationDiff<La>,java.io.OutputStream). The resulting document should be used as prototype not as ready to be published visualisation. To discourage further processing the API differs from exportVariationDiff by exporting directly into a file.

Parameters:

variationDiff - to be exported

destination - path of the generated file

Throws:

IOException