edu.ucla.sspace.wordsi.semeval

Class SemEvalReporter

java.lang.Object

edu.ucla.sspace.wordsi.semeval.SemEvalReporter

All Implemented Interfaces:

AssignmentReporter

public class SemEvalReporter
extends Object
implements AssignmentReporter

A AssignmentReporter that creates a SenseEval or SemEval answer key. This should be used in conjunction with a SemEvalContextExtractor. When reporting, Primary keys are not used. Secondary keys are expected to be the instance identifier. For each call to updateAssignment, the reporter will generate a line of the form word.pos word.pos.idNumber word.pos.clusterNumber which designates word.pos.idNumber is the secondary key. The line signifies that the given word instance was assigned to a cluster identified by clusterNumber.

Author:

Keith Stevens

Constructor Summary

Constructors

Constructor and Description
SemEvalReporter(OutputStream stream) Creates a new SemEvalReporter.

Method Summary

Methods

Modifier and Type	Method and Description
void	assignContextToKey(String primaryKey, String secondaryKey, int contextId) Records a contexts identifier for an instance of primaryKey.
String[]	contextLabels(String primaryKey) Returns the secondary keys assigned to this primaryKey based on their associated context ids.
void	finalizeReport() Finalizes the assignment report.
void	updateAssignment(String primaryKey, String secondaryKey, int clusterId) Updates the assignment report with the knowledge that primaryKey and secondaryKey were associated with clusterId once.

Methods inherited from class java.lang.Object

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

Constructor Detail

SemEvalReporter

public SemEvalReporter(OutputStream stream)

Creates a new SemEvalReporter.

Parameters:

stream - The stream to which the answer key should be written.

Method Detail

updateAssignment

public void updateAssignment(String primaryKey,
                    String secondaryKey,
                    int clusterId)

Updates the assignment report with the knowledge that primaryKey and secondaryKey were associated with clusterId once.

Specified by:

updateAssignment in interface AssignmentReporter

finalizeReport

public void finalizeReport()

Finalizes the assignment report. Any output streams must be closed and any unreported data must be reported.

Specified by:

finalizeReport in interface AssignmentReporter

assignContextToKey

public void assignContextToKey(String primaryKey,
                      String secondaryKey,
                      int contextId)

Records a contexts identifier for an instance of primaryKey. The identifies recorded aresecondaryKey and contextId. secondaryKey can be any string. contextId can should be between 0 and the total number of contexts that will be observed, i.e. contexts for a single primaryKey simply get idsj based on the order in which they are processed.

Specified by:

assignContextToKey in interface AssignmentReporter

contextLabels

public String[] contextLabels(String primaryKey)

Returns the secondary keys assigned to this primaryKey based on their associated context ids. This list can be used if a Wordsi algorithm needs to report it's clustering assignments. Reporting SenseEval/SemEval or Pseudo Word Disambiguation assignments are two good use cases which require this functionality.

Specified by:

contextLabels in interface AssignmentReporter