edu.illinois.cs.cogcomp.core.datastructures.textannotation

Class Relation

java.lang.Object

edu.illinois.cs.cogcomp.core.datastructures.textannotation.Relation

All Implemented Interfaces:

HasAttributes, Serializable

public class Relation
extends Object
implements Serializable, HasAttributes

Author:

Vivek Srikumar

Aug 4, 2009

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	attributes
protected Map<String,Double>	labelsToScores
protected int	relationName
protected double	score
protected Constituent	source
protected Constituent	target

Constructor Summary

Constructors

Constructor and Description
Relation(Map<String,Double> labelsToScores, Constituent source, Constituent target) Instantiates a Relation connecting two constituents with a set of labels and corresponding scores.
Relation(String relationName, Constituent source, Constituent target, double score) Instantiates a Relation connecting two Constituents with the name and score specified.

Method Summary

Modifier and Type	Method and Description
void	addAttribute(String key, String value)
boolean	equals(Object obj)
String	getAttribute(String key)
Set<String>	getAttributeKeys()
Map<String,Double>	getLabelsToScores() return map of labels to scores.
String	getRelationName()
double	getScore()
Constituent	getSource()
Constituent	getTarget()
boolean	hasAttribute(String key)
int	hashCode()
void	removeAllAttributes() Removes all attributes from a Constituent.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

relationName

protected final int relationName

labelsToScores

protected final Map<String,Double> labelsToScores

source

protected Constituent source

target

protected Constituent target

score

protected double score

attributes

protected Map<String,String> attributes

Constructor Detail

Relation

public Relation(Map<String,Double> labelsToScores,
                Constituent source,
                Constituent target)

Instantiates a Relation connecting two constituents with a set of labels and corresponding scores. The 'main' label and score that will be returned by getRelationName() and getScore() will be the argmax and corresponding score from the labelsToScores argument.

Parameters:

labelsToScores - map from labels to scores.

source - constituent that is the source of the relation

target - constituent that is the target of the relation

Relation

public Relation(String relationName,
                Constituent source,
                Constituent target,
                double score)

Instantiates a Relation connecting two Constituents with the name and score specified.

Parameters:

relationName - name of relation

source - constituent that is the source of the relation

target - constituent that is the target of the relation

score - confidence score for relation

Method Detail

getLabelsToScores

public Map<String,Double> getLabelsToScores()

return map of labels to scores. If not explicitly created, generates a trivial distribution using the label assigned at construction.

Returns:

map of labels to scores

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getRelationName

public String getRelationName()

getScore

public double getScore()

Returns:

the score

getSource

public Constituent getSource()

Returns:

the source

getTarget

public Constituent getTarget()

Returns:

the target

addAttribute

public void addAttribute(String key,
                         String value)

Specified by:

addAttribute in interface HasAttributes

getAttribute

public String getAttribute(String key)

Specified by:

getAttribute in interface HasAttributes

getAttributeKeys

public Set<String> getAttributeKeys()

Specified by:

getAttributeKeys in interface HasAttributes

hasAttribute

public boolean hasAttribute(String key)

Specified by:

hasAttribute in interface HasAttributes

removeAllAttributes

public void removeAllAttributes()

Removes all attributes from a Constituent.

Specified by:

removeAllAttributes in interface HasAttributes

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object