StatSpec (GemFire XD Java API Documentation)

java.lang.Object
- perffmwk.StatSpec

All Implemented Interfaces:

com.gemstone.gemfire.internal.StatArchiveReader.StatSpec, com.gemstone.gemfire.internal.StatArchiveReader.ValueFilter, Serializable

Direct Known Subclasses:

Expr, RuntimeStatSpec
```
public class StatSpec
extends Object
implements com.gemstone.gemfire.internal.StatArchiveReader.StatSpec, Serializable
```
Holds an individual statistics specification.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`exactMatch` Determines if the class type should be an exact match; this is useful for stats that have the same name in types that have similar names, such as the product's CachePerfStats and the framework's cacheperf.CachePerfStats
`protected String`	`name` The logical name of the spec
`protected StatConfig`	`statconfig` The stat config

Fields inherited from interface com.gemstone.gemfire.internal.StatArchiveReader.StatSpec
FILE, GLOBAL, NONE

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`StatSpec(PerformanceStatistics statInst, com.gemstone.gemfire.StatisticDescriptor statDesc)`
`protected`	`StatSpec(String name)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`archiveMatches(File archive)`
`protected StatSpec`	`distill()` Used by PerfComparer to throw out stats that will not be compared
`protected List`	`findMatchingArchives(SortedMap allArchives, StatSpecId id)`
`int`	`getCombineType()` Implements `StatArchiveReader.StatSpec.getCombineType()`.
`String`	`getDescription()` Returns a description of the statistic referred to by this `StatSpec`.
`int`	`getFilter()`
`StatSpecId`	`getId()`
`Pattern`	`getInstancePattern()`
`protected List`	`getMatchingArchives()`
`boolean`	`getMax()`
`boolean`	`getMaxCompare()`
`boolean`	`getMaxExpr()`
`boolean`	`getMaxMinusMin()`
`boolean`	`getMaxMinusMinCompare()`
`boolean`	`getMaxMinusMinExpr()`
`boolean`	`getMean()`
`boolean`	`getMeanCompare()`
`boolean`	`getMeanExpr()`
`boolean`	`getMin()`
`boolean`	`getMinCompare()`
`boolean`	`getMinExpr()`
`String`	`getName()`
`String`	`getStatName()`
`boolean`	`getStddev()`
`boolean`	`getStddevCompare()`
`boolean`	`getStddevExpr()`
`String`	`getTrimSpecName()`
`String`	`getTypeName()`
`boolean`	`instanceMatches(String textId, long numericId)`
`void`	`setCombineType(int combine)`
`void`	`setCombineType(String combineType)`
`void`	`setDescription(String description)` Sets the description of the statistic referred to by this `StatSpec`.
`void`	`setExactMatch(boolean boolArg)`
`void`	`setFilter(int filter)`
`void`	`setFilter(String filterType)`
`void`	`setId(StatSpecId id)`
`void`	`setMax(boolean b)`
`void`	`setMaxCompare(boolean b)`
`void`	`setMaxExpr(boolean b)`
`void`	`setMaxMinusMin(boolean b)`
`void`	`setMaxMinusMinCompare(boolean b)`
`void`	`setMaxMinusMinExpr(boolean b)`
`void`	`setMean(boolean b)`
`void`	`setMeanCompare(boolean b)`
`void`	`setMeanExpr(boolean b)`
`void`	`setMin(boolean b)`
`void`	`setMinCompare(boolean b)`
`void`	`setMinExpr(boolean b)`
`void`	`setStatConfig(StatConfig statconfig)`
`void`	`setStddev(boolean b)`
`void`	`setStddevCompare(boolean b)`
`void`	`setStddevExpr(boolean b)`
`void`	`setTrimSpecName(String trimspecName)`
`boolean`	`statMatches(String statName)`
`String`	`toSpecString()`
`String`	`toString()`
`boolean`	`typeMatches(String typeName)`

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

Field Detail
- name
```
protected String name
```
  The logical name of the spec
- statconfig
```
protected StatConfig statconfig
```
  The stat config
- exactMatch
```
protected boolean exactMatch
```
  Determines if the class type should be an exact match; this is useful for stats that have the same name in types that have similar names, such as the product's CachePerfStats and the framework's cacheperf.CachePerfStats

Constructor Detail

StatSpec
```
protected StatSpec(String name)
```

StatSpec

protected StatSpec(PerformanceStatistics statInst,
                   com.gemstone.gemfire.StatisticDescriptor statDesc)

Method Detail

getCombineType
```
public int getCombineType()
```
Implements StatArchiveReader.StatSpec.getCombineType().

Specified by:

getCombineType in interface com.gemstone.gemfire.internal.StatArchiveReader.StatSpec

archiveMatches
```
public boolean archiveMatches(File archive)
```
Specified by:

archiveMatches in interface com.gemstone.gemfire.internal.StatArchiveReader.ValueFilter

typeMatches
```
public boolean typeMatches(String typeName)
```
Specified by:

typeMatches in interface com.gemstone.gemfire.internal.StatArchiveReader.ValueFilter

statMatches
```
public boolean statMatches(String statName)
```
Specified by:

statMatches in interface com.gemstone.gemfire.internal.StatArchiveReader.ValueFilter

instanceMatches
```
public boolean instanceMatches(String textId,
                               long numericId)
```
Specified by:

instanceMatches in interface com.gemstone.gemfire.internal.StatArchiveReader.ValueFilter

getName
```
public String getName()
```

getTypeName
```
public String getTypeName()
```

getInstancePattern
```
public Pattern getInstancePattern()
```

getStatName
```
public String getStatName()
```

getMatchingArchives
```
protected List getMatchingArchives()
```

findMatchingArchives

protected List findMatchingArchives(SortedMap allArchives,
                                    StatSpecId id)

setExactMatch

public void setExactMatch(boolean boolArg)

setStatConfig

public void setStatConfig(StatConfig statconfig)

getId
```
public StatSpecId getId()
```

setId
```
public void setId(StatSpecId id)
```

getFilter
```
public int getFilter()
```

setFilter

public void setFilter(String filterType)

setFilter
```
public void setFilter(int filter)
```

setCombineType

public void setCombineType(String combineType)

setCombineType

public void setCombineType(int combine)

getMin
```
public boolean getMin()
```

setMin
```
public void setMin(boolean b)
```

getMax
```
public boolean getMax()
```

setMax
```
public void setMax(boolean b)
```

getMaxMinusMin
```
public boolean getMaxMinusMin()
```

setMaxMinusMin

public void setMaxMinusMin(boolean b)

getMean
```
public boolean getMean()
```

setMean
```
public void setMean(boolean b)
```

getStddev
```
public boolean getStddev()
```

setStddev
```
public void setStddev(boolean b)
```

getMinExpr
```
public boolean getMinExpr()
```

setMinExpr
```
public void setMinExpr(boolean b)
```

getMaxExpr
```
public boolean getMaxExpr()
```

setMaxExpr
```
public void setMaxExpr(boolean b)
```

getMaxMinusMinExpr
```
public boolean getMaxMinusMinExpr()
```

setMaxMinusMinExpr

public void setMaxMinusMinExpr(boolean b)

getMeanExpr
```
public boolean getMeanExpr()
```

setMeanExpr
```
public void setMeanExpr(boolean b)
```

getStddevExpr
```
public boolean getStddevExpr()
```

setStddevExpr
```
public void setStddevExpr(boolean b)
```

getMinCompare
```
public boolean getMinCompare()
```

setMinCompare
```
public void setMinCompare(boolean b)
```

getMaxCompare
```
public boolean getMaxCompare()
```

setMaxCompare
```
public void setMaxCompare(boolean b)
```

getMaxMinusMinCompare

public boolean getMaxMinusMinCompare()

setMaxMinusMinCompare

public void setMaxMinusMinCompare(boolean b)

getMeanCompare
```
public boolean getMeanCompare()
```

setMeanCompare

public void setMeanCompare(boolean b)

getStddevCompare
```
public boolean getStddevCompare()
```

setStddevCompare

public void setStddevCompare(boolean b)

getTrimSpecName
```
public String getTrimSpecName()
```

setTrimSpecName

public void setTrimSpecName(String trimspecName)

getDescription
```
public String getDescription()
```
Returns a description of the statistic referred to by this StatSpec. author David Whitlock

setDescription
```
public void setDescription(String description)
```
Sets the description of the statistic referred to by this StatSpec. author David Whitlock

distill
```
protected StatSpec distill()
```
Used by PerfComparer to throw out stats that will not be compared

toString
```
public String toString()
```
Overrides:

toString in class Object

toSpecString
```
public String toSpecString()
```

Class StatSpec

Field Summary

Fields inherited from interface com.gemstone.gemfire.internal.StatArchiveReader.StatSpec

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

statconfig

exactMatch

Constructor Detail

StatSpec

StatSpec

Method Detail

getCombineType

archiveMatches

typeMatches

statMatches

instanceMatches

getName

getTypeName

getInstancePattern

getStatName

getMatchingArchives

findMatchingArchives

setExactMatch

setStatConfig

getId

setId

getFilter

setFilter

setFilter

setCombineType

setCombineType

getMin

setMin

getMax

setMax

getMaxMinusMin

setMaxMinusMin

getMean

setMean

getStddev

setStddev

getMinExpr

setMinExpr

getMaxExpr

setMaxExpr

getMaxMinusMinExpr

setMaxMinusMinExpr

getMeanExpr

setMeanExpr

getStddevExpr

setStddevExpr

getMinCompare

setMinCompare

getMaxCompare

setMaxCompare

getMaxMinusMinCompare

setMaxMinusMinCompare

getMeanCompare

setMeanCompare

getStddevCompare

setStddevCompare

getTrimSpecName

setTrimSpecName

getDescription

setDescription

distill

toString

toSpecString