BinaryRelationMatch (CharGer4 Documentation)

Object
- kb.matching.BinaryRelationMatch

```
public class BinaryRelationMatch
extends Object
```
Represents the abstraction of a match between all binary relations in two graphs. The two graphs are linked from this object. It maintains a list of matched tuples for statistical purposes. One of the graphs is considered the "master". Since it must match itself exactly, its score is maxScore, its precision is 1.0 and its recall is 1.0. The score, precision and recall of a BinaryRelationMatch object is therefore the "goodness" of the other graph (called here the "graph to match") with respect to the master graph.

Since:

3.5b2

Field Summary

Fields
Modifier and Type	Field and Description
`private Graph`	`_masterGraph`
`private String`	`_masterName`
`private ArrayList<MatchedBinaryTuple>`	`_masterScoredTuples`
`private ArrayList<MatchedBinaryTuple>`	`_masterTuples` Unlike ConceptManager, this class uses MatchedBinaryTuple's, not an unstructured table entry array list.
`private Graph`	`_toMatchGraph`
`private String`	`_toMatchName`
`private ArrayList<MatchedBinaryTuple>`	`_toMatchTuples`
`private AbstractTupleMatcher`	`_tupleMatcher`
`protected NumberFormat`	`ff` Used for displaying floating point scores
`protected NumberFormat`	`intf` Used for displaying integer values.
`protected float`	`masterScore`
`protected float`	`matchedScore`
`protected float`	`precision`
`protected float`	`recall`

Constructor Summary

Constructors
Constructor and Description
`BinaryRelationMatch(Graph masterG, String masterName)` Set up a matcher to be used by matchBinaryRelations/1
`BinaryRelationMatch(Graph masterG, String masterName, Graph toMatchGraph, String toMatchName)` Create a match between a master graph and a match candidate.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`convertTuplesToHTMLtable(ArrayList tuples, String summary)` Converts a ArrayList of BinaryTuples to an HTML work sheet (usable for manual analysis of the relations), with a summary.
`String`	`getMasterName()` Returns the name of the master graph
`float`	`getMasterScore()` Returns the total score obtainable; i.e., the max score of the master tuples
`float`	`getMatchedMaxPossibleScore()` Returns the max score possible derived from the graph to match; i.e., the "count" of everything in the graph to match.
`String`	`getMatchedName()` Returns the name of the graph to be matched
`float`	`getMatchedScore()` Returns the raw score obtained; i.e., the "count" of the things matched.
`float`	`getNormScore()`
`float`	`getPrecision()` Returns the percentage of things in the graph to match that also appear in the master.
`float`	`getRecall()` Returns the percentage of things in the master that also appear in the graph to match.
`static String`	`getSummaryHeaderHTML()`
`String`	`getSummaryHTML()` Return a one-line HTML TR summary, suitable for inclusion in an HTML table
`float`	`getTotalScore(ArrayList v)`
`AbstractTupleMatcher`	`getTupleMatcher()`
`ArrayList<MatchedBinaryTuple>`	`makeBinaryTuples(Graph masterG)` Mimics getBinaryRelationTuples, but constructs a vector of BinaryTuple objects.
`String`	`masterDetailToHTML()` Displays the details of the master graph in HTML form.
`void`	`matchAGraph(Graph toMatchGraph, String toMatchName)`
`String`	`matchedDetailToHTML()`
`void`	`matchTheTuples()`
`void`	`matchTheTuplesByMaster()` Performs the actual matching algorithm on two given graphs, considering each row of the master in turn.
`void`	`matchTheTuplesByMatchedTuples()` Performs the actual matching algorithm on two given graphs, considering each row of the to-be-matched graph in turn.
`void`	`setTupleMatcher(AbstractTupleMatcher m)` Tell the relation matcher which specific tuple matcher objects to use.
`void`	`setupMaster(Graph masterG)` Load the matcher with an entry for each binary relation.

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

- Field Detail
  - masterScore
```
protected float masterScore
```
  - matchedScore
```
protected float matchedScore
```
  - precision
```
protected float precision
```
  - recall
```
protected float recall
```
  - intf
```
protected NumberFormat intf
```
    Used for displaying integer values.
  - ff
```
protected NumberFormat ff
```
    Used for displaying floating point scores
  - _masterTuples
```
private ArrayList<MatchedBinaryTuple> _masterTuples
```
    Unlike ConceptManager, this class uses MatchedBinaryTuple's, not an unstructured table entry array list.
  - _masterScoredTuples
```
private ArrayList<MatchedBinaryTuple> _masterScoredTuples
```
  - _toMatchTuples
```
private ArrayList<MatchedBinaryTuple> _toMatchTuples
```
  - _tupleMatcher
```
private AbstractTupleMatcher _tupleMatcher
```
  - _masterGraph
```
private Graph _masterGraph
```
  - _toMatchGraph
```
private Graph _toMatchGraph
```
  - _masterName
```
private String _masterName
```
  - _toMatchName
```
private String _toMatchName
```
- Constructor Detail
  - BinaryRelationMatch
```
public BinaryRelationMatch(Graph masterG,
                           String masterName,
                           Graph toMatchGraph,
                           String toMatchName)
```
    Create a match between a master graph and a match candidate.
    
    Parameters:
    
    masterG - the graph to serve as the "correct" or master graph of the comparison.
    
    masterName - a label for the master graph
    
    toMatchGraph - the graph to be matched to the master
    
    toMatchName - a label for the toMatch graph
  - BinaryRelationMatch
```
public BinaryRelationMatch(Graph masterG,
                           String masterName)
```
    Set up a matcher to be used by matchBinaryRelations/1
    
    Parameters:
    
    masterG - the graph to serve as the "correct" or master graph of the comparison.
    
    masterName - a label for the master graph
- Method Detail
  - getTupleMatcher
```
public AbstractTupleMatcher getTupleMatcher()
```
  - setTupleMatcher
```
public void setTupleMatcher(AbstractTupleMatcher m)
```
    Tell the relation matcher which specific tuple matcher objects to use.
    
    Parameters:
    
    m -
  - getTotalScore
```
public float getTotalScore(ArrayList v)
```
  - getMasterScore
```
public float getMasterScore()
```
    Returns the total score obtainable; i.e., the max score of the master tuples
  - getMatchedScore
```
public float getMatchedScore()
```
    Returns the raw score obtained; i.e., the "count" of the things matched.
  - getMatchedMaxPossibleScore
```
public float getMatchedMaxPossibleScore()
```
    Returns the max score possible derived from the graph to match; i.e., the "count" of everything in the graph to match. This is used to determine precision scores. In effect, this score is what would be the maximum possible if the graph to match were completely and exactly correct.
    
    Returns:
    
    the result of getting each tuple in the graph-to-be-matched, and matching it to itself.
  - getPrecision
```
public float getPrecision()
```
    Returns the percentage of things in the graph to match that also appear in the master.
  - getRecall
```
public float getRecall()
```
    Returns the percentage of things in the master that also appear in the graph to match.
  - getNormScore
```
public float getNormScore()
```
  - getMasterName
```
public String getMasterName()
```
    Returns the name of the master graph
  - getMatchedName
```
public String getMatchedName()
```
    Returns the name of the graph to be matched
  - matchAGraph
```
public void matchAGraph(Graph toMatchGraph,
                        String toMatchName)
```
  - setupMaster
```
public void setupMaster(Graph masterG)
```
    Load the matcher with an entry for each binary relation. Each entry looks like this (from makeTableEntry):
    - element 0 - phrase,
    - element 1 - concept label,
    - element 2 - relation label,
    - element 3 - concept label,
    - element 4 - actual 1st (CharGer) concept
    - element 5 - actual (CharGer) relation
    - element 6 - actual 2nd (CharGer) concept
    See Also:
    
    ConceptManager.makeTableEntryArrayList(charger.obj.Concept, charger.obj.GNode, charger.obj.Concept, kb.ConceptManager.ConceptsToInclude)
  - convertTuplesToHTMLtable
```
public String convertTuplesToHTMLtable(ArrayList tuples,
                                       String summary)
```
    Converts a ArrayList of BinaryTuples to an HTML work sheet (usable for manual analysis of the relations), with a summary. Table entries have added score for left and right concepts and the master row that we matched. These are all strings.
    
    Parameters:
    
    tuples - a ArrayList of BinaryTuple or one of its subclasses.
    
    summary - an identifying string, used to identify the table in HTML, but not otherwise displayed.
  - getSummaryHTML
```
public String getSummaryHTML()
```
    Return a one-line HTML TR summary, suitable for inclusion in an HTML table
  - getSummaryHeaderHTML
```
public static String getSummaryHeaderHTML()
```
  - masterDetailToHTML
```
public String masterDetailToHTML()
```
    Displays the details of the master graph in HTML form.
  - matchedDetailToHTML
```
public String matchedDetailToHTML()
```
  - makeBinaryTuples
```
public ArrayList<MatchedBinaryTuple> makeBinaryTuples(Graph masterG)
```
    Mimics getBinaryRelationTuples, but constructs a vector of BinaryTuple objects. If a relation is above binary (e.g., ternary, etc.) then its constituents are split into their corresponding binary "equivalents". That is, all the concepts that are involved in the relation are paired up.
    
    Parameters:
    
    masterG - graph whose tuples are to be collected
    
    See Also:
    
    ConceptManager.getBinaryRelationTuples(charger.obj.Graph, kb.ConceptManager.ConceptsToInclude)
  - matchTheTuples
```
public void matchTheTuples()
```
  - matchTheTuplesByMatchedTuples
```
public void matchTheTuplesByMatchedTuples()
```
    Performs the actual matching algorithm on two given graphs, considering each row of the to-be-matched graph in turn. Uses the previously associated "master" graph and the graph to be matched. Recall and precision scores are obtained for how well the graph to match did match. Sets all the totals but does not immediately return anything.
    
    See Also:
    
    getSummaryHTML()
  - matchTheTuplesByMaster
```
public void matchTheTuplesByMaster()
```
    Performs the actual matching algorithm on two given graphs, considering each row of the master in turn. Recall and precision scores are obtained for how well the graph to match did match.

Class BinaryRelationMatch

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

masterScore

matchedScore

precision

recall

intf

ff

_masterTuples

_masterScoredTuples

_toMatchTuples

_tupleMatcher

_masterGraph

_toMatchGraph

_masterName

_toMatchName

Constructor Detail

BinaryRelationMatch

BinaryRelationMatch

Method Detail

getTupleMatcher

setTupleMatcher

getTotalScore

getMasterScore

getMatchedScore

getMatchedMaxPossibleScore

getPrecision

getRecall

getNormScore

getMasterName

getMatchedName

matchAGraph

setupMaster

convertTuplesToHTMLtable

getSummaryHTML

getSummaryHeaderHTML

masterDetailToHTML

matchedDetailToHTML

makeBinaryTuples

matchTheTuples

matchTheTuplesByMatchedTuples

matchTheTuplesByMaster