Package org.variantsync.diffdetective.variation.diff.render

Record Class RenderOptions<L extends Label>

java.lang.Object
java.lang.Record
org.variantsync.diffdetective.variation.diff.render.RenderOptions<L>
Record Components:
format - The format specifies if the input to render is a VariationDiff or DiffGraph. Most of the time you want to pick GraphFormat.VARIATION_DIFF.
treeFormat - The export format for VariationDiff names and metadata. This format may read or write a VariationDiff source.
nodeFormat - The export format for DiffNodes. This format decides how nodes are labeled in the exported graph.
edgeFormat - The export format for edges in VariationDiffs. This format decides how edges are labeled as well as their direction.
cleanUpTemporaryFiles - During rendering, some temporary files might be created. Set this to true if these files should be deleted after rendering.
dpi - The resolution of the produced image. Higher yields a better resolution at the cost of a larger memory footprint.
nodesize - The size, nodes should be printed (in pixels?).
edgesize - The thickness of drawn edge lines.
arrowsize - The size of arrows that are drawn at the end of directed edges.
fontsize - The size of any rendered text.
withlabels - Set this to true if labels of nodes should be printed as text. False will show unlabeled nodes.
extraArguments - Arbitrary extra command-line arguments for the underlying renderer. For example, some formats require additional information. The list should be filled with alternating values for parameter names and their values. All values will be passed as is, separated with spaces to the command line call of the internal renderer.
public record RenderOptions<L extends Label>(GraphFormat format, VariationDiffLabelFormat treeFormat, DiffNodeLabelFormat<? super L extends Label> nodeFormat, EdgeLabelFormat<? super L extends Label> edgeFormat, boolean cleanUpTemporaryFiles, int dpi, int nodesize, double edgesize, int arrowsize, int fontsize, boolean withlabels, List<String> extraArguments) extends Record
Configuration options to configure rendering of VariationDiffs.
Author:
Paul Bittner, Kevin Jedelhauser

  • Field Details

    • format

      private final GraphFormat format
      The field for the format record component.

    • treeFormat

      private final VariationDiffLabelFormat treeFormat
      The field for the treeFormat record component.

    • nodeFormat

      private final DiffNodeLabelFormat<? super L extends Label> nodeFormat
      The field for the nodeFormat record component.

    • edgeFormat

      private final EdgeLabelFormat<? super L extends Label> edgeFormat
      The field for the edgeFormat record component.

    • cleanUpTemporaryFiles

      private final boolean cleanUpTemporaryFiles
      The field for the cleanUpTemporaryFiles record component.

    • dpi

      private final int dpi
      The field for the dpi record component.

    • nodesize

      private final int nodesize
      The field for the nodesize record component.

    • edgesize

      private final double edgesize
      The field for the edgesize record component.

    • arrowsize

      private final int arrowsize
      The field for the arrowsize record component.

    • fontsize

      private final int fontsize
      The field for the fontsize record component.

    • withlabels

      private final boolean withlabels
      The field for the withlabels record component.

    • extraArguments

      private final List<String> extraArguments
      The field for the extraArguments record component.

  • Constructor Details

    • RenderOptions

      public RenderOptions(GraphFormat format, VariationDiffLabelFormat treeFormat, DiffNodeLabelFormat<? super L> nodeFormat, EdgeLabelFormat<? super L> edgeFormat, boolean cleanUpTemporaryFiles, int dpi, int nodesize, double edgesize, int arrowsize, int fontsize, boolean withlabels, List<String> extraArguments)
      Creates an instance of a RenderOptions record class.
      Parameters:
      format - the value for the format record component
      treeFormat - the value for the treeFormat record component
      nodeFormat - the value for the nodeFormat record component
      edgeFormat - the value for the edgeFormat record component
      cleanUpTemporaryFiles - the value for the cleanUpTemporaryFiles record component
      dpi - the value for the dpi record component
      nodesize - the value for the nodesize record component
      edgesize - the value for the edgesize record component
      arrowsize - the value for the arrowsize record component
      fontsize - the value for the fontsize record component
      withlabels - the value for the withlabels record component
      extraArguments - the value for the extraArguments record component

  • Method Details

    • DEFAULT

      public static <L extends Label> RenderOptions<L> DEFAULT()
      Default options.

    • toLineGraphOptions

      public LineGraphExportOptions<L> toLineGraphOptions()
      Converts this RenderOptions to options for linegraph export. Linegraph options are a subset of render options.
      Returns:
      Options for linegraph export consistent to this RenderOptions.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • format

      public GraphFormat format()
      Returns the value of the format record component.
      Returns:
      the value of the format record component

    • treeFormat

      public VariationDiffLabelFormat treeFormat()
      Returns the value of the treeFormat record component.
      Returns:
      the value of the treeFormat record component

    • nodeFormat

      public DiffNodeLabelFormat<? super L> nodeFormat()
      Returns the value of the nodeFormat record component.
      Returns:
      the value of the nodeFormat record component

    • edgeFormat

      public EdgeLabelFormat<? super L> edgeFormat()
      Returns the value of the edgeFormat record component.
      Returns:
      the value of the edgeFormat record component

    • cleanUpTemporaryFiles

      public boolean cleanUpTemporaryFiles()
      Returns the value of the cleanUpTemporaryFiles record component.
      Returns:
      the value of the cleanUpTemporaryFiles record component

    • dpi

      public int dpi()
      Returns the value of the dpi record component.
      Returns:
      the value of the dpi record component

    • nodesize

      public int nodesize()
      Returns the value of the nodesize record component.
      Returns:
      the value of the nodesize record component

    • edgesize

      public double edgesize()
      Returns the value of the edgesize record component.
      Returns:
      the value of the edgesize record component

    • arrowsize

      public int arrowsize()
      Returns the value of the arrowsize record component.
      Returns:
      the value of the arrowsize record component

    • fontsize

      public int fontsize()
      Returns the value of the fontsize record component.
      Returns:
      the value of the fontsize record component

    • withlabels

      public boolean withlabels()
      Returns the value of the withlabels record component.
      Returns:
      the value of the withlabels record component

    • extraArguments

      public List<String> extraArguments()
      Returns the value of the extraArguments record component.
      Returns:
      the value of the extraArguments record component