Package org.variantsync.diffdetective.experiments.views.result

Record Class ViewEvaluation

java.lang.Object

java.lang.Record

org.variantsync.diffdetective.experiments.views.result.ViewEvaluation

Record Components:

commit - The commit on which views were generated.

file - The file of the patch that was analysed.

relevance - The relevance predicate from which the views were generated.

msNaive - Milliseconds it took to generate the view with the naive algorithm

msOptimized - Milliseconds it took to generate the view with the optimized algorithm

diffStatistics - Various statistics on the variation diff of the analysed patch.

viewStatistics - The same statistics as for the original variation diff but for the produced view.

All Implemented Interfaces:

CSV

public record ViewEvaluation(String commit, String file, Relevance relevance, long msNaive, long msOptimized, ViewEvaluation.DiffStatistics diffStatistics, ViewEvaluation.DiffStatistics viewStatistics)
extends Record
implements CSV

Single data point in our feasibility study. An object of this class corresponds to a row in the CSV files we export. This row contains all information for benchmarking a single view generation:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ViewEvaluation.DiffStatistics	Holds various information of a variation diff.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	commit	The field for the commit record component.
private final ViewEvaluation.DiffStatistics	diffStatistics	The field for the diffStatistics record component.
private final String	file	The field for the file record component.
private final long	msNaive	The field for the msNaive record component.
private final long	msOptimized	The field for the msOptimized record component.
private final Relevance	relevance	The field for the relevance record component.
private final ViewEvaluation.DiffStatistics	viewStatistics	The field for the viewStatistics record component.

Fields inherited from interface org.variantsync.diffdetective.util.CSV

DEFAULT_CSV_DELIMITER

Constructor Summary

Constructors

Constructor	Description
ViewEvaluation(String commit, String file, Relevance relevance, long msNaive, long msOptimized, ViewEvaluation.DiffStatistics diffStatistics, ViewEvaluation.DiffStatistics viewStatistics)	Creates an instance of a ViewEvaluation record class.

Method Summary

Modifier and Type	Method	Description
String	commit()	Returns the value of the commit record component.
ViewEvaluation.DiffStatistics	diffStatistics()	Returns the value of the diffStatistics record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	file()	Returns the value of the file record component.
final int	hashCode()	Returns a hash code value for this object.
static String	makeHeader(String delimiter)	Creates the header for a CSV file in which objects of this class can be rows.
long	msNaive()	Returns the value of the msNaive record component.
long	msOptimized()	Returns the value of the msOptimized record component.
Relevance	relevance()	Returns the value of the relevance record component.
String	toCSV(String delimiter)	Convert this value into a CSV row using a custom CSV delimiter.
final String	toString()	Returns a string representation of this record class.
ViewEvaluation.DiffStatistics	viewStatistics()	Returns the value of the viewStatistics record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.variantsync.diffdetective.util.CSV

toCSV

Field Details

commit

private final String commit

The field for the commit record component.

file

private final String file

The field for the file record component.

relevance

private final Relevance relevance

The field for the relevance record component.

msNaive

private final long msNaive

The field for the msNaive record component.

msOptimized

private final long msOptimized

The field for the msOptimized record component.

diffStatistics

private final ViewEvaluation.DiffStatistics diffStatistics

The field for the diffStatistics record component.

viewStatistics

private final ViewEvaluation.DiffStatistics viewStatistics

The field for the viewStatistics record component.

Constructor Details

ViewEvaluation

public ViewEvaluation(String commit,
 String file,
 Relevance relevance,
 long msNaive,
 long msOptimized,
 ViewEvaluation.DiffStatistics diffStatistics,
 ViewEvaluation.DiffStatistics viewStatistics)

Creates an instance of a ViewEvaluation record class.

Parameters:

commit - the value for the commit record component

file - the value for the file record component

relevance - the value for the relevance record component

msNaive - the value for the msNaive record component

msOptimized - the value for the msOptimized record component

diffStatistics - the value for the diffStatistics record component

viewStatistics - the value for the viewStatistics record component

Method Details

makeHeader

public static String makeHeader(String delimiter)

Creates the header for a CSV file in which objects of this class can be rows.

Parameters:

delimiter - The delimiter to use between rows in the CSV file (see CSV.DEFAULT_CSV_DELIMITER.

Returns:

A string that should be the first row in a CSV file with objects of this class as rows.

toCSV

public String toCSV(String delimiter)

Description copied from interface: CSV

Convert this value into a CSV row using a custom CSV delimiter.

Specified by:

toCSV in interface CSV

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.

commit

public String commit()

Returns the value of the commit record component.

Returns:

the value of the commit record component

file

public String file()

Returns the value of the file record component.

Returns:

the value of the file record component

relevance

public Relevance relevance()

Returns the value of the relevance record component.

Returns:

the value of the relevance record component

msNaive

public long msNaive()

Returns the value of the msNaive record component.

Returns:

the value of the msNaive record component

msOptimized

public long msOptimized()

Returns the value of the msOptimized record component.

Returns:

the value of the msOptimized record component

diffStatistics

public ViewEvaluation.DiffStatistics diffStatistics()

Returns the value of the diffStatistics record component.

Returns:

the value of the diffStatistics record component

viewStatistics

public ViewEvaluation.DiffStatistics viewStatistics()

Returns the value of the viewStatistics record component.

Returns:

the value of the viewStatistics record component