Package org.variantsync.diffdetective.examplesearch

Class ExampleFinder

java.lang.Object

org.variantsync.diffdetective.examplesearch.ExampleFinder

All Implemented Interfaces:

Analysis.Hooks

public class ExampleFinder
extends Object
implements Analysis.Hooks

Helper class to find suitable running examples. An example finder inspects each VariationDiff, checks some requirements relevant for the desired running example and writes candidates to a file and renders them. An example finder should be side-effect free (i.e., it does not alter or transform the given VariationDiff, just observes it).

Field Summary

Fields

Modifier and Type	Field	Description
private final PatchDiffRenderer	exampleExport
static final RenderOptions<DiffLinesLabel>	ExportOptions	Default render options for exporting example candidates.
private final ExplainedFilter<VariationDiff<? extends DiffLinesLabel>>	isGoodExample

Constructor Summary

Constructors

Constructor	Description
ExampleFinder(ExplainedFilter<VariationDiff<? extends DiffLinesLabel>> isGoodExample, VariationDiffRenderer renderer)	Creates a new ExampleFinder.

Method Summary

Modifier and Type	Method	Description
boolean	analyzeVariationDiff(Analysis analysis)	The main hook for analyzing non-empty diff trees.
private boolean	checkIfExample(Analysis analysis, String localDiff)
private void	exportExample(Analysis analysis, String tdiff, VariationDiff<DiffLinesLabel> vdiff, Path outputDir)
(package private) static String	getDiff(VariationDiff<?> tree)
void	initializeResults(Analysis analysis)	Initialization hook for Analysis.getResult().
static <T> List<List<T>>	split(List<T> elements, Predicate<T> split)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.variantsync.diffdetective.analysis.Analysis.Hooks

beginBatch, beginCommit, beginPatch, endBatch, endCommit, endPatch, onFailedCommit, onFailedParse, onParsedCommit

Field Details

ExportOptions

public static final RenderOptions<DiffLinesLabel> ExportOptions

Default render options for exporting example candidates.

isGoodExample

private final ExplainedFilter<VariationDiff<? extends DiffLinesLabel>> isGoodExample

exampleExport

private final PatchDiffRenderer exampleExport

Constructor Details

ExampleFinder

public ExampleFinder(ExplainedFilter<VariationDiff<? extends DiffLinesLabel>> isGoodExample,
 VariationDiffRenderer renderer)

Creates a new ExampleFinder.

Parameters:

isGoodExample - Function that decides whether a VariationDiff is an example candidate or not. Should return Optional.empty() when the given tree is not a good example and thus, should not be considered. Should return a VariationDiff when the given tree is a good example candidate and should be exported. The returned VariationDiff might be the exact same VariationDiff or a subtree (e.g., to only export a certain subtree that is relevant).

renderer - The renderer to use for rendering example candidates.

Method Details

split

public static <T> List<List<T>> split(List<T> elements,
 Predicate<T> split)

checkIfExample

private boolean checkIfExample(Analysis analysis,
 String localDiff)

initializeResults

public void initializeResults(Analysis analysis)

Description copied from interface: Analysis.Hooks

Initialization hook for Analysis.getResult(). All result types should be appended with a neutral value using Analysis.append(org.variantsync.diffdetective.analysis.AnalysisResult.ResultKey<T>, T). No other side effects should be performed during this methods as it might be called an arbitrary amount of times.

Specified by:

initializeResults in interface Analysis.Hooks

analyzeVariationDiff

public boolean analyzeVariationDiff(Analysis analysis)

Description copied from interface: Analysis.Hooks

The main hook for analyzing non-empty diff trees. Called at most once during the patch phase.

Specified by:

analyzeVariationDiff in interface Analysis.Hooks

exportExample

private void exportExample(Analysis analysis,
 String tdiff,
 VariationDiff<DiffLinesLabel> vdiff,
 Path outputDir)

getDiff

static String getDiff(VariationDiff<?> tree)