Package org.variantsync.diffdetective.analysis

Class AnalysisResult

java.lang.Object

org.variantsync.diffdetective.analysis.AnalysisResult

All Implemented Interfaces:

Metadata<AnalysisResult>

public final class AnalysisResult
extends Object
implements Metadata<AnalysisResult>

The result of a Analysis. This result stores various metadata and statistics that we use for the validation of our ESEC/FSE paper. An AnalysisResult also allows to store any custom metadata or information.

Author:

Paul Bittner

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	AnalysisResult.ResultKey<T extends Metadata<T>>	Type proxy and runtime key for the type of a Metadata subclass.

Field Summary

Fields

Modifier and Type	Field	Description
final org.variantsync.functjonal.map.MergeMap<DiffError,Integer>	diffErrors
private static final String	ERROR_BEGIN
private static final String	ERROR_END
static final org.variantsync.functjonal.category.InplaceMonoid<AnalysisResult>	IMONOID
static final org.variantsync.functjonal.category.InplaceSemigroup<AnalysisResult>	ISEMIGROUP	Inplace semigroup for AnalysisResult.
static final String	NO_REPO	Placeholder name for data that is not associated to a repository or where the repository is unknown.
String	repoName	The repo from which the results where collected.
private final Map<String,Metadata<?>>	results
String	taskName

Constructor Summary

Constructors

Constructor	Description
AnalysisResult()
AnalysisResult(String repoName)	Creates an empty analysis result for the given repo.

Method Summary

Modifier and Type	Method	Description
<T extends Metadata<T>> void	append(AnalysisResult.ResultKey<T> resultKey, T value)	Adds a new value or Metadata.append(T)s it to the old value which is indexed by resultKey.
<T extends Metadata<T>> T	get(AnalysisResult.ResultKey<T> resultKey)	Returns the value previously added using <T>append(org.variantsync.diffdetective.analysis.AnalysisResult.ResultKey<T>,T).
void	reportDiffErrors(List<DiffError> errors)	Report errors (that for example occurred when parsing VariationDiffs).
org.variantsync.functjonal.category.InplaceSemigroup<AnalysisResult>	semigroup()	Metadata should be composable.
void	setFrom(Path path)
void	setFromSnapshot(LinkedHashMap<String,String> snap)
LinkedHashMap<String,Object>	snapshot()	Create a key-value store of the metadata that can be used for serialization.
private void	unsafeAppend(String key, Metadata<?> value)

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.metadata.Metadata

append, exportTo

Field Details

NO_REPO

public static final String NO_REPO

Placeholder name for data that is not associated to a repository or where the repository is unknown.

See Also:

• Constant Field Values

ERROR_BEGIN

private static final String ERROR_BEGIN

See Also:

• Constant Field Values

ERROR_END

private static final String ERROR_END

See Also:

• Constant Field Values

repoName

public String repoName

The repo from which the results where collected.

taskName

public String taskName

diffErrors

public final org.variantsync.functjonal.map.MergeMap<DiffError,Integer> diffErrors

results

private final Map<String,Metadata<?>> results

ISEMIGROUP

public static final org.variantsync.functjonal.category.InplaceSemigroup<AnalysisResult> ISEMIGROUP

Inplace semigroup for AnalysisResult. Merges the second results values into the first result.

IMONOID

public static final org.variantsync.functjonal.category.InplaceMonoid<AnalysisResult> IMONOID

Constructor Details

AnalysisResult

public AnalysisResult()

AnalysisResult

public AnalysisResult(String repoName)

Creates an empty analysis result for the given repo.

Parameters:

repoName - The repo for which to collect results.

Method Details

get

public <T extends Metadata<T>> T get(AnalysisResult.ResultKey<T> resultKey)

Returns the value previously added using <T>append(org.variantsync.diffdetective.analysis.AnalysisResult.ResultKey<T>,T).

Type Parameters:

T - the type of the value which was previously stored

Parameters:

resultKey - the key which is used to identify the data and its type

unsafeAppend

private void unsafeAppend(String key,
 Metadata<?> value)

append

public <T extends Metadata<T>> void append(AnalysisResult.ResultKey<T> resultKey,
 T value)

Adds a new value or Metadata.append(T)s it to the old value which is indexed by resultKey.

Type Parameters:

T - the type of the value which is appended

Parameters:

resultKey - the key which is used to identify the data and its type

See Also:

• <T>get(org.variantsync.diffdetective.analysis.AnalysisResult.ResultKey<T>)

semigroup

public org.variantsync.functjonal.category.InplaceSemigroup<AnalysisResult> semigroup()

Description copied from interface: Metadata

Metadata should be composable. Composition should be inplace to optimize performance.

Specified by:

semigroup in interface Metadata<AnalysisResult>

reportDiffErrors

public void reportDiffErrors(List<DiffError> errors)

Report errors (that for example occurred when parsing VariationDiffs).

Parameters:

errors - A list of errors to report.

snapshot

public LinkedHashMap<String,Object> snapshot()

Description copied from interface: Metadata

Create a key-value store of the metadata that can be used for serialization.

Specified by:

snapshot in interface Metadata<AnalysisResult>

Returns:

A LinkedHashMap that stores all relevant properties to export. The return type has to be a LinkedHashMap to obtain insertion-order iteration.

setFromSnapshot

public void setFromSnapshot(LinkedHashMap<String,String> snap)

Specified by:

setFromSnapshot in interface Metadata<AnalysisResult>

setFrom

public void setFrom(Path path)
             throws IOException

Throws:

IOException