StatConfig (GemFire XD Java API Documentation)

java.lang.Object
- perffmwk.StatConfig

```
public class StatConfig
extends Object
```
A StatConfig contains a statistics specification, trim specification, and latest properties. It is used to hold results of generating or parsing statistics.spec, trim.spec, and latest.prop files.
Instances of this class are not available to hydra clients.

Field Summary

Fields
Modifier and Type Field and Description

protected Map matchingArchiveCache
Cache of matching archives for specs (key is logical spec name, val is list of archives)

Fields
Modifier and Type	Field and Description
`protected Map`	`matchingArchiveCache` Cache of matching archives for specs (key is logical spec name, val is list of archives)

Constructor Summary

Constructors
Modifier Constructor and Description

protected StatConfig(String testDir)
Creates a new StatConfig for a test whose output resides in the given directory.

Constructors
Modifier	Constructor and Description
`protected`	`StatConfig(String testDir)` Creates a new `StatConfig` for a test whose output resides in the given directory.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addStatSpec(StatSpec statspec)` Adds a `StatSpec` to this `StatConfig`.
`protected void`	`addSystemProperty(String key, String val)`
`protected void`	`addTrimSpec(TrimSpec trimspec)` Adds a `TrimSpec` for the test run represented by this `StatConfig`.
`protected SortedMap`	`distillStatSpecsForComparison()` Used by `PerfComparer` to throw out stats (`StatSpec`s) that will not be compared.
`protected String`	`getBuildDate()` Returns the build date of the version of GemFire used by the test that was run to generate this `StatConfig`.
`protected String`	`getBuildJDK()` Returns the version of JDK used by the build that was run to generate this `StatConfig`.
`protected String`	`getBuildVersion()` Returns the version of GemFire used by the test that was run to generate this `StatConfig`.
`protected Map`	`getExprInstances()` Returns all of the `Expr`s from the test run from which this `StatConfig` was created.
`protected String`	`getJavaVMName()` Returns the Java VM name used by the test that was run to generate this `StatConfig`.
`protected Properties`	`getLatestProperties()` Returns the properties from latest.prop for the test run from which this `StatConfig` was created.
`protected List`	`getMatchingArchiveCache(String specname)` Returns a list of archives associated with the given spec.
`protected String`	`getNativeClientBuildVersion()` Returns the version of native client used by the test that was run to generate this `StatConfig`.
`protected String`	`getNativeClientSourceRepository()` Returns the repository of native client source used by the test that was run to generate this `StatConfig`.
`protected String`	`getNativeClientSourceRevision()` Returns the revision of C++ source used by the test that was run to generate this `StatConfig`.
`protected String`	`getRuntimeJDK()` Returns the version of JDK used by the test that was run to generate this `StatConfig`.
`protected String`	`getSourceDate()` Returns the date of GemFire source used by the test that was run to generate this `StatConfig`.
`protected String`	`getSourceRepository()` Returns the repository of GemFire source used by the test that was run to generate this `StatConfig`.
`protected String`	`getSourceRevision()` Returns the revision of GemFire source used by the test that was run to generate this `StatConfig`.
`protected SortedMap`	`getStatisticArchives()` Returns all statistic archives for the test mapped by system name.
`protected List`	`getStatisticArchivesAsList()` Returns all statistic archives for the test in a single list.
`protected StatSpec`	`getStatSpec(String name)` Returns the `StatSpec` with the given name.
`protected StatSpec`	`getStatSpecByKey(String key)` Returns the `StatSpec` with the given key.
`protected Map`	`getStatSpecInstances()` Returns all of the `StatSpec`s from the test run from which this `StatConfig` was created.
`protected SortedMap`	`getStatSpecs()` Returns all of the `StatSpec`s from the test run from which this `StatConfig` was created.
`protected Vector`	`getStatSpecsWithId(StatSpecId id)` Returns the statistics spec with the given id.
`protected Map`	`getSystemProperties()`
`protected String`	`getTestDescription()` Returns the description of the test that was run to generate this `StatConfig`.
`protected String`	`getTestDir()` Returns the test output directory from which this `StatConfig` was created.
`protected String`	`getTestName()` Returns the name of the test that was run to generate this `StatConfig`.
`protected Properties`	`getTestProperties()` Returns the test properties (a.k.a.
`protected TrimSpec`	`getTrimSpec(String name)` Returns the `TrimSpec` with the given name.
`protected SortedMap`	`getTrimSpecs()` Returns all of the statistic `TrimSpec`s for this test run.
`protected boolean`	`isNativeClient()` Returns whether this is a native client test.
`protected void`	`resetStatSpecs()` Resets the stat of this `StatConfig`
`protected void`	`setLatestProperties(Properties p)` Sets the properties from latest.prop for the test run from which this `StatConfig` was created.
`protected void`	`setMatchingArchiveCache(String specname, List archives)` Associates the list of arhives with the given spec.
`protected void`	`setStatSpecs(SortedMap statspecs)` Associates this `StatConfig` all of the `StatSpec`s in the given map.
`protected void`	`setTestProperties(Properties p)` Returns the test properties (a.k.a.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - matchingArchiveCache
```
protected Map matchingArchiveCache
```
    Cache of matching archives for specs (key is logical spec name, val is list of archives)
- Constructor Detail
  - StatConfig
```
protected StatConfig(String testDir)
```
    Creates a new StatConfig for a test whose output resides in the given directory.
- Method Detail
  - getTestName
```
protected String getTestName()
```
    Returns the name of the test that was run to generate this StatConfig.
  - isNativeClient
```
protected boolean isNativeClient()
```
    Returns whether this is a native client test.
  - getTestDescription
```
protected String getTestDescription()
```
    Returns the description of the test that was run to generate this StatConfig.
  - getSourceRepository
```
protected String getSourceRepository()
```
    Returns the repository of GemFire source used by the test that was run to generate this StatConfig.
  - getSourceRevision
```
protected String getSourceRevision()
```
    Returns the revision of GemFire source used by the test that was run to generate this StatConfig.
  - getSourceDate
```
protected String getSourceDate()
```
    Returns the date of GemFire source used by the test that was run to generate this StatConfig.
  - getBuildVersion
```
protected String getBuildVersion()
```
    Returns the version of GemFire used by the test that was run to generate this StatConfig.
  - getBuildDate
```
protected String getBuildDate()
```
    Returns the build date of the version of GemFire used by the test that was run to generate this StatConfig.
  - getBuildJDK
```
protected String getBuildJDK()
```
    Returns the version of JDK used by the build that was run to generate this StatConfig.
  - getNativeClientSourceRepository
```
protected String getNativeClientSourceRepository()
```
    Returns the repository of native client source used by the test that was run to generate this StatConfig.
  - getNativeClientSourceRevision
```
protected String getNativeClientSourceRevision()
```
    Returns the revision of C++ source used by the test that was run to generate this StatConfig.
  - getNativeClientBuildVersion
```
protected String getNativeClientBuildVersion()
```
    Returns the version of native client used by the test that was run to generate this StatConfig.
  - getRuntimeJDK
```
protected String getRuntimeJDK()
```
    Returns the version of JDK used by the test that was run to generate this StatConfig.
  - getJavaVMName
```
protected String getJavaVMName()
```
    Returns the Java VM name used by the test that was run to generate this StatConfig.
  - getTestDir
```
protected String getTestDir()
```
    Returns the test output directory from which this StatConfig was created.
  - setLatestProperties
```
protected void setLatestProperties(Properties p)
```
    Sets the properties from latest.prop for the test run from which this StatConfig was created.
  - getLatestProperties
```
protected Properties getLatestProperties()
```
    Returns the properties from latest.prop for the test run from which this StatConfig was created.
  - setTestProperties
```
protected void setTestProperties(Properties p)
```
    Returns the test properties (a.k.a. the "test config properties") for the test run from which this StatConfig was created.
  - getTestProperties
```
protected Properties getTestProperties()
```
    Returns the test properties (a.k.a. the "test config properties") for the test run from which this StatConfig was created.
  - getSystemProperties
```
protected Map getSystemProperties()
```
  - addSystemProperty
```
protected void addSystemProperty(String key,
                                 String val)
```
  - getTrimSpecs
```
protected SortedMap getTrimSpecs()
```
    Returns all of the statistic TrimSpecs for this test run. The keys of the map are the names of the trim specs and the values are the TrimSpec objects.
  - getTrimSpec
```
protected TrimSpec getTrimSpec(String name)
```
    Returns the TrimSpec with the given name. If a TrimSpec with that name does not exist, a new one will be created.
  - addTrimSpec
```
protected void addTrimSpec(TrimSpec trimspec)
```
    Adds a TrimSpec for the test run represented by this StatConfig.
  - getStatSpecsWithId
```
protected Vector getStatSpecsWithId(StatSpecId id)
```
    Returns the statistics spec with the given id.
  - getStatSpecByKey
```
protected StatSpec getStatSpecByKey(String key)
```
    Returns the StatSpec with the given key. The key is composed of the stat spec's id and name.
  - getStatSpec
```
protected StatSpec getStatSpec(String name)
```
    Returns the StatSpec with the given name. If no StatSpec with that name exists, then null is returned.
  - getStatSpecs
```
protected SortedMap getStatSpecs()
```
    Returns all of the StatSpecs from the test run from which this StatConfig was created.
  - getStatSpecInstances
```
protected Map getStatSpecInstances()
```
    Returns all of the StatSpecs from the test run from which this StatConfig was created. Excludes Exprs.
  - getExprInstances
```
protected Map getExprInstances()
```
    Returns all of the Exprs from the test run from which this StatConfig was created. Excludes StatSpecs.
  - addStatSpec
```
protected void addStatSpec(StatSpec statspec)
```
    Adds a StatSpec to this StatConfig.
  - setStatSpecs
```
protected void setStatSpecs(SortedMap statspecs)
```
    Associates this StatConfig all of the StatSpecs in the given map.
  - resetStatSpecs
```
protected void resetStatSpecs()
```
    Resets the stat of this StatConfig
  - getMatchingArchiveCache
```
protected List getMatchingArchiveCache(String specname)
```
    Returns a list of archives associated with the given spec.
  - setMatchingArchiveCache
```
protected void setMatchingArchiveCache(String specname,
                                       List archives)
```
    Associates the list of arhives with the given spec.
  - distillStatSpecsForComparison
```
protected SortedMap distillStatSpecsForComparison()
```
    Used by PerfComparer to throw out stats (StatSpecs) that will not be compared.
    
    See Also:
    
    StatSpec.distill()
  - getStatisticArchivesAsList
```
protected List getStatisticArchivesAsList()
```
    Returns all statistic archives for the test in a single list.
  - getStatisticArchives
```
protected SortedMap getStatisticArchives()
```
    Returns all statistic archives for the test mapped by system name.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class StatConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

matchingArchiveCache

Constructor Detail

StatConfig

Method Detail

getTestName

isNativeClient

getTestDescription

getSourceRepository

getSourceRevision

getSourceDate

getBuildVersion

getBuildDate

getBuildJDK

getNativeClientSourceRepository

getNativeClientSourceRevision

getNativeClientBuildVersion

getRuntimeJDK

getJavaVMName

getTestDir

setLatestProperties

getLatestProperties

setTestProperties

getTestProperties

getSystemProperties

addSystemProperty

getTrimSpecs

getTrimSpec

addTrimSpec

getStatSpecsWithId

getStatSpecByKey

getStatSpec

getStatSpecs

getStatSpecInstances

getExprInstances

addStatSpec

setStatSpecs

resetStatSpecs

getMatchingArchiveCache

setMatchingArchiveCache

distillStatSpecsForComparison

getStatisticArchivesAsList

getStatisticArchives

toString