org.eclipse.test.internal.performance.results
Class ScenarioResults

java.lang.Object
  org.eclipse.test.internal.performance.results.AbstractResults
      org.eclipse.test.internal.performance.results.ScenarioResults

All Implemented Interfaces:

java.lang.Comparable

public class ScenarioResults
extends AbstractResults

Class to handle performance results of a component's scenario (for example 'org.eclipse.jdt.core.FullSourceWorkspaceSearchTest#searchAllTypeNames()'). It gives access to results for each configuration run on this scenario.

See Also:

ConfigResults

Field Summary

Fields inherited from class org.eclipse.test.internal.performance.results.AbstractResults

BOXES, CONFIGS, DEFAULT_DIM, SUPPORTED_DIMS, VERSION, VERSION_REF

Constructor Summary

ScenarioResults(int id, java.lang.String name, java.lang.String shortName)

Method Summary

java.lang.String	getBaselineBuildName() Returns the first configuration baseline build name.
ConfigResults	getConfigResults(java.lang.String config) Return the results of the given configuration.
java.lang.String	getFileName() Return a name which can be used as a file name to store information related to this scenario.
java.lang.String	getLabel() Returns the scenario label.
java.lang.String	getShortName() Returns the short name of the scenario.
int	hashCode()
boolean	hasSummary() Returns whether one of the scenario's config has a summary or not.
boolean	isValid() Returns whether the current scenario is valid or not.
boolean	isValid(java.lang.String config) Returns whether the current build of the given config has valid results or not.
boolean	knowsBuild(java.lang.String buildName) Returns whether the current scenario knows a build or not.

Methods inherited from class org.eclipse.test.internal.performance.results.AbstractResults

compareTo, copyFile, equals, getBuildDate, getBuildDate, getChildren, getName, getParent, getResults, size, timeChrono, timeEnd, timeString, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ScenarioResults

public ScenarioResults(int id,
                       java.lang.String name,
                       java.lang.String shortName)

Method Detail

getBaselineBuildName

public java.lang.String getBaselineBuildName()

Returns the first configuration baseline build name.

Returns:

The name of the baseline build

See Also:

ConfigResults.getBaselineBuildName()

getConfigResults

public ConfigResults getConfigResults(java.lang.String config)

Return the results of the given configuration.

Parameters:

config - The configuration name

Returns:

The results for the given configuration or null if none was found.

getFileName

public java.lang.String getFileName()

Return a name which can be used as a file name to store information related to this scenario. This name does not contain the extension.

Returns:

The file name

getLabel

public java.lang.String getLabel()

Returns the scenario label. If no label exist as there's no associated summary, then the short name is returned

Returns:

The label of the scenario or it's short name if no summary exists

getShortName

public java.lang.String getShortName()

Returns the short name of the scenario. Short name is the name scenario from which package declaration has been removed.

Returns:

The scenario short name

hasSummary

public boolean hasSummary()

Returns whether one of the scenario's config has a summary or not.

Returns:

true if one of the scenario's config has a summary false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractResults

isValid

public boolean isValid()

Returns whether the current scenario is valid or not.

Returns:

true if all the builds contained in the database are known by the scenario (ie. at least one its configuration knows each of the db builds), false otherwise.

isValid

public boolean isValid(java.lang.String config)

Returns whether the current build of the given config has valid results or not.

Parameters:

config - The name of the configuration

Returns:

true if the build has valid results false otherwise.

knowsBuild

public boolean knowsBuild(java.lang.String buildName)

Returns whether the current scenario knows a build or not.

Parameters:

buildName - The name of the build

Returns:

true if the at least one of scenario configuration knows the given build, false otherwise.