edu.illinois.cs.cogcomp.sim

Class StringMetric<T>

java.lang.Object

edu.illinois.cs.cogcomp.sim.StringMetric<T>

All Implemented Interfaces:

Metric<T>

Direct Known Subclasses:

Paraphrase, WNSim

public abstract class StringMetric<T>
extends Object
implements Metric<T>

Basic functionality for Metric classes that can operate on a pair of String inputs, in addition to whatever non-basic Types the Metric can compare. Created by mssammon on 2/29/16.

Constructor Summary

Constructors

Constructor and Description
StringMetric()

Method Summary

Modifier and Type	Method and Description
Map<String,String>	compareStringValues(Map<String,String> arguments) alternate representation of the compare() method using only Map and String values, to support XMLRPC-like interfaces
abstract String	getName() returns the name of this metric.
protected abstract T	wrapStringArgument(String word) construct a T instance from just a String to allow the compareStringValues(Map) to interact with Metric.compare

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface edu.illinois.cs.cogcomp.sim.Metric

compare

Constructor Detail

StringMetric

public StringMetric()

Method Detail

getName

public abstract String getName()

returns the name of this metric. Used as the reason by the default compareStringValues(java.util.Map<java.lang.String, java.lang.String>) method.

Returns:

the name of this metric.

compareStringValues

public Map<String,String> compareStringValues(Map<String,String> arguments)

alternate representation of the compare() method using only Map and String values, to support XMLRPC-like interfaces

Parameters:

arguments - a map of key-value pairs, where each key indicates the intended use of the corresponding value. Must allow the implementor to map these values into the data structures used by .compare.

Returns:

a map of key-value pairs, where they keys indicate the intended use of the entry

wrapStringArgument

protected abstract T wrapStringArgument(String word)

construct a T instance from just a String to allow the compareStringValues(Map) to interact with Metric.compare

Parameters:

word - the word to wrap

Returns:

the corresponding object of type T specified by the implementor