BinaryRelationMatchGroupMetrics (CharGer4 Documentation)

Object
- kb.matching.AbstractMatchGroupMetrics
- - kb.matching.BinaryRelationMatchGroupMetrics

```
public class BinaryRelationMatchGroupMetrics
extends AbstractMatchGroupMetrics
```
Calculates. collects and reports the metrics of a group of BinaryRelationMatch objects. In operation, forms a collection of BinaryRelationMatch objects, getting their summary information. A match can be a member of more than one match group.

See Also:

BinaryRelationMatch

Field Summary

Fields
Modifier and Type	Field and Description
`private String`	`_explanation`
`private chargerlib.FloatStatistics`	`_matchedMaxPossibleScore` In effect, this score is what would be the maximum possible if the graph to match were completely and exactly correct.
`private chargerlib.FloatStatistics`	`_matchedScore`
`private ArrayList<BinaryRelationMatch>`	`_matches`
`private chargerlib.FloatStatistics`	`_maxPossible`
`private chargerlib.FloatStatistics`	`_normScore`
`private chargerlib.FloatStatistics`	`_precision`
`private chargerlib.FloatStatistics`	`_recall`
`private boolean`	`_upToDate`
`protected NumberFormat`	`ff` Used for displaying floating point scores
`protected NumberFormat`	`intf` Used for displaying integer values.

Fields inherited from class kb.matching.AbstractMatchGroupMetrics
name

Constructor Summary

Constructors
Constructor and Description

BinaryRelationMatchGroupMetrics(String s)

Constructors
Constructor and Description
`BinaryRelationMatchGroupMetrics(String s)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMatch(BinaryRelationMatch m)` Adds a member to the match group.
`String`	`getAveragesHTML()` Returns the totals of each of the summary items in getSummaryHeaderHTML
`String`	`getCompleteSummaryHTML()` Displays (in HTML) the complete summary of this group.
`ArrayList`	`getMatches()` Returns the set of matches that are all members of this group.
`String`	`getMaxesHTML()` Returns the totals of each of the summary items in getSummaryHeaderHTML
`String`	`getMinsHTML()` Returns the totals of each of the summary items in getSummaryHeaderHTML
`float`	`getOverallScore()` A suggested way of reducing the entire match group (really precision and recall) into one number.
`String`	`getStdDeviationsHTML()` Returns the totals of each of the summary items in getSummaryHeaderHTML
`String`	`getSummaryHeaderHTML()` Return the header labels for a one-line summary, suitable for inclusion in an HTML table.
`String`	`getSummaryHTML(BinaryRelationMatch m)` Return a one-line HTML TR summary, suitable for inclusion in an HTML table.
`String`	`getSummaryStatisticsHTML()` Formats for HTML display the totals of all the matches; e.g., totals, averages, etc.
`String`	`getTotalsHTML()` Returns the totals of each of the summary items in getSummaryHeaderHTML
`void`	`scanAllMatches()` Gather all the stats, updating all the total, statistics, etc.

Methods inherited from class kb.matching.AbstractMatchGroupMetrics
getName

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _matches
```
private ArrayList<BinaryRelationMatch> _matches
```
  - _upToDate
```
private boolean _upToDate
```
  - _explanation
```
private String _explanation
```
  - _matchedScore
```
private chargerlib.FloatStatistics _matchedScore
```
  - _matchedMaxPossibleScore
```
private chargerlib.FloatStatistics _matchedMaxPossibleScore
```
    In effect, this score is what would be the maximum possible if the graph to match were completely and exactly correct.
  - _precision
```
private chargerlib.FloatStatistics _precision
```
  - _recall
```
private chargerlib.FloatStatistics _recall
```
  - _normScore
```
private chargerlib.FloatStatistics _normScore
```
  - _maxPossible
```
private chargerlib.FloatStatistics _maxPossible
```
  - intf
```
protected NumberFormat intf
```
    Used for displaying integer values.
  - ff
```
protected NumberFormat ff
```
    Used for displaying floating point scores
- Constructor Detail
  - BinaryRelationMatchGroupMetrics
```
public BinaryRelationMatchGroupMetrics(String s)
```
    Parameters:
    
    s - The name of this group (can be null)
- Method Detail
  - addMatch
```
public void addMatch(BinaryRelationMatch m)
```
    Adds a member to the match group. Makes no assumption about whether the match has actually been performed or not. If match is already a member, does nothing.
    
    Parameters:
    
    m - The match object to be added.
  - getSummaryHTML
```
public String getSummaryHTML(BinaryRelationMatch m)
```
    Return a one-line HTML TR summary, suitable for inclusion in an HTML table. Intended to be used within a wrapper that creates the actual table.
    
    See Also:
    
    getSummaryHeaderHTML()
  - getSummaryHeaderHTML
```
public String getSummaryHeaderHTML()
```
    Return the header labels for a one-line summary, suitable for inclusion in an HTML table. Intended to be used within a wrapper that creates the actual table.
    
    See Also:
    
    getSummaryHTML(kb.matching.BinaryRelationMatch)
  - getSummaryStatisticsHTML
```
public String getSummaryStatisticsHTML()
```
    Formats for HTML display the totals of all the matches; e.g., totals, averages, etc.
    
    Returns:
    
    a set of TR labeled strings suitable for inclusion in a table.
  - getTotalsHTML
```
public String getTotalsHTML()
```
    Returns the totals of each of the summary items in getSummaryHeaderHTML
  - getAveragesHTML
```
public String getAveragesHTML()
```
    Returns the totals of each of the summary items in getSummaryHeaderHTML
  - getStdDeviationsHTML
```
public String getStdDeviationsHTML()
```
    Returns the totals of each of the summary items in getSummaryHeaderHTML
  - getMaxesHTML
```
public String getMaxesHTML()
```
    Returns the totals of each of the summary items in getSummaryHeaderHTML
  - getMinsHTML
```
public String getMinsHTML()
```
    Returns the totals of each of the summary items in getSummaryHeaderHTML
  - getCompleteSummaryHTML
```
public String getCompleteSummaryHTML()
```
    Displays (in HTML) the complete summary of this group. Displays the following:
    - The matching strategy (in English) or a disclaimer if the matches used different strategies.
    - The recall, precision and scores for each match.
    - The mean, min, max and std dev for the group.
  - getMatches
```
public ArrayList getMatches()
```
    Returns the set of matches that are all members of this group. Does a safe copy (i.e., clone) but does not ensure that all the matches exist.
  - scanAllMatches
```
public void scanAllMatches()
```
    Gather all the stats, updating all the total, statistics, etc. Establishes a single explanation string (if there's only one).
    
    Since:
    
    3.5b2
    
    See Also:
    
    AbstractMatcher.explainYourself()
  - getOverallScore
```
public float getOverallScore()
```
    A suggested way of reducing the entire match group (really precision and recall) into one number. Take sqrt( precision * recall ).

Class BinaryRelationMatchGroupMetrics

Field Summary

Fields inherited from class kb.matching.AbstractMatchGroupMetrics

Constructor Summary

Method Summary

Methods inherited from class kb.matching.AbstractMatchGroupMetrics

Methods inherited from class Object

Field Detail

_matches

_upToDate

_explanation

_matchedScore

_matchedMaxPossibleScore

_precision

_recall

_normScore

_maxPossible

intf

ff

Constructor Detail

BinaryRelationMatchGroupMetrics

Method Detail

addMatch

getSummaryHTML

getSummaryHeaderHTML

getSummaryStatisticsHTML

getTotalsHTML

getAveragesHTML

getStdDeviationsHTML

getMaxesHTML

getMinsHTML

getCompleteSummaryHTML

getMatches

scanAllMatches

getOverallScore