RelationTriple (Stanford CoreNLP API)

java.lang.Object
- edu.stanford.nlp.ie.util.RelationTriple

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RelationTriple>, java.lang.Iterable<CoreLabel>

Direct Known Subclasses:

RelationTriple.WithTree
```
public class RelationTriple
extends java.lang.Object
implements java.lang.Comparable<RelationTriple>, java.lang.Iterable<CoreLabel>, java.io.Serializable
```
A (subject, relation, object) triple; e.g., as used in the KBP challenges or in OpenIE systems.

Author:

Gabor Angeli

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RelationTriple.WithLink` A `RelationTriple`, but with both the tree and the entity links saved as well.
`static class`	`RelationTriple.WithTree` A `RelationTriple`, but with the tree saved as well.

Field Summary

Fields
Modifier and Type	Field and Description
`java.util.List<CoreLabel>`	`canonicalObject` The object (third argument) of this triple, in its canonical mention (i.e., coref resolved).
`java.util.List<CoreLabel>`	`canonicalSubject` The subject (first argument) of this triple, in its canonical mention (i.e., coref resolved)
`double`	`confidence` An optional score (confidence) for this triple
`java.util.List<CoreLabel>`	`object` The object (third argument) of this triple
`java.util.List<CoreLabel>`	`relation` The relation (second argument) of this triple.
`java.util.List<CoreLabel>`	`subject` The subject (first argument) of this triple

Constructor Summary

Constructors
Constructor and Description
`RelationTriple(java.util.List<CoreLabel> subject, java.util.List<CoreLabel> relation, java.util.List<CoreLabel> object)`
`RelationTriple(java.util.List<CoreLabel> subject, java.util.List<CoreLabel> relation, java.util.List<CoreLabel> object, double confidence)` Create a new triple with known values for the subject, relation, and object.
`RelationTriple(java.util.List<CoreLabel> subject, java.util.List<CoreLabel> canonicalSubject, java.util.List<CoreLabel> relation, java.util.List<CoreLabel> canonicalObject, java.util.List<CoreLabel> object)`
`RelationTriple(java.util.List<CoreLabel> subject, java.util.List<CoreLabel> canonicalSubject, java.util.List<CoreLabel> relation, java.util.List<CoreLabel> object, java.util.List<CoreLabel> canonicalObject, double confidence)` Create a new triple with known values for the subject, relation, and object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.List<CoreLabel>`	`allTokens()` Returns all the tokens in the extraction, in the order subject then relation then object.
`java.util.Optional<SemanticGraph>`	`asDependencyTree()` An optional method, returning the dependency tree this triple was extracted from
`java.util.List<CoreLabel>`	`asSentence()` Return the given relation triple as a flat sentence
`int`	`compareTo(RelationTriple o)`
`java.lang.String`	`confidenceGloss()` A textual representation of the confidence.
`boolean`	`equals(java.lang.Object o)`
`int`	`hashCode()`
`boolean`	`isPrefixBe()` If true, this relation expresses a "to be" relation.
`boolean`	`isPrefixBe(boolean newValue)` Set the value of this relation triple expressing a "to be" relation.
`boolean`	`isSuffixBe()` If true, this relation expresses a "to be" relation (with the be at the end of the sentence).
`boolean`	`isSuffixBe(boolean newValue)` Set the value of this relation triple expressing a "to be" relation (suffix).
`boolean`	`isSuffixOf()` If true, this relation has an ungrounded "of" at the end of the relation.
`boolean`	`isSuffixOf(boolean newValue)` Set the value of this triple missing an ungrounded "of" in the relation string.
`boolean`	`istmod()` If true, this relation expresses a tmod (temporal modifier) relation that is not grounded in the sentence.
`boolean`	`istmod(boolean newValue)` Set the value of this relation triple expressing a tmod (temporal modifier) relation.
`java.util.Iterator<CoreLabel>`	`iterator()`
`java.lang.String`	`objectGloss()` The object of this relation triple, as a String
`CoreLabel`	`objectHead()` The head of the object of this relation triple.
`java.lang.String`	`objectLemmaGloss()` The object of this relation triple, as a String of the object's lemmas.
`java.lang.String`	`objectLink()` The entity link of the subject
`Pair<java.lang.Integer,java.lang.Integer>`	`objectTokenSpan()` Gets the span of the NON-CANONICAL object.
`java.lang.String`	`relationGloss()` The relation of this relation triple, as a String
`CoreLabel`	`relationHead()` The head of the relation of this relation triple.
`java.lang.String`	`relationLemmaGloss()` The relation of this relation triple, as a String of the relation's lemmas.
`Pair<java.lang.Integer,java.lang.Integer>`	`relationTokenSpan()` Get a representative span for the relation expressed by this triple.
`java.lang.String`	`subjectGloss()` The subject of this relation triple, as a String
`CoreLabel`	`subjectHead()` The head of the subject of this relation triple.
`java.lang.String`	`subjectLemmaGloss()` The subject of this relation triple, as a String of the subject's lemmas.
`java.lang.String`	`subjectLink()` The entity link of the subject
`Pair<java.lang.Integer,java.lang.Integer>`	`subjectTokenSpan()` Gets the span of the NON-CANONICAL subject.
`java.lang.String`	`toQaSrlString(CoreMap sentence)` Print in the format expected by Gabriel Stanovsky and Ido Dagan, Creating a Large Benchmark for Open Information Extraction, EMNLP 2016.
`java.lang.String`	`toReverbString(java.lang.String docid, CoreMap sentence)` Print a description of this triple, formatted like the ReVerb outputs.
`java.lang.String`	`toString()` Print a human-readable description of this relation triple, as a tab-separated line.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - subject
```
public final java.util.List<CoreLabel> subject
```
    The subject (first argument) of this triple
  - canonicalSubject
```
public final java.util.List<CoreLabel> canonicalSubject
```
    The subject (first argument) of this triple, in its canonical mention (i.e., coref resolved)
  - relation
```
public final java.util.List<CoreLabel> relation
```
    The relation (second argument) of this triple. Note that this is only the part of the relation that can be grounded in the sentence itself. Often, for a standalone readable relation string, you want to attach additional modifiers otherwise stored in the dependnecy arc. Therefore, for getting a String form of the relation, we recommend using relationGloss() or relationLemmaGloss().
  - object
```
public final java.util.List<CoreLabel> object
```
    The object (third argument) of this triple
  - canonicalObject
```
public final java.util.List<CoreLabel> canonicalObject
```
    The object (third argument) of this triple, in its canonical mention (i.e., coref resolved).
  - confidence
```
public final double confidence
```
    An optional score (confidence) for this triple
- Constructor Detail
  - RelationTriple
```
public RelationTriple(java.util.List<CoreLabel> subject,
                      java.util.List<CoreLabel> relation,
                      java.util.List<CoreLabel> object,
                      double confidence)
```
    Create a new triple with known values for the subject, relation, and object. For example, "(cats, play with, yarn)"
    
    Parameters:
    
    subject - The subject of this triple; e.g., "cats".
    
    relation - The relation of this triple; e.g., "play with".
    
    object - The object of this triple; e.g., "yarn".
  - RelationTriple
```
public RelationTriple(java.util.List<CoreLabel> subject,
                      java.util.List<CoreLabel> relation,
                      java.util.List<CoreLabel> object)
```
    See Also:
    
    RelationTriple(java.util.List, java.util.List, java.util.List, double)
  - RelationTriple
```
public RelationTriple(java.util.List<CoreLabel> subject,
                      java.util.List<CoreLabel> canonicalSubject,
                      java.util.List<CoreLabel> relation,
                      java.util.List<CoreLabel> object,
                      java.util.List<CoreLabel> canonicalObject,
                      double confidence)
```
    Create a new triple with known values for the subject, relation, and object. For example, "(cats, play with, yarn)"
    
    Parameters:
    
    subject - The subject of this triple; e.g., "cats".
    
    relation - The relation of this triple; e.g., "play with".
    
    object - The object of this triple; e.g., "yarn".
  - RelationTriple
```
public RelationTriple(java.util.List<CoreLabel> subject,
                      java.util.List<CoreLabel> canonicalSubject,
                      java.util.List<CoreLabel> relation,
                      java.util.List<CoreLabel> canonicalObject,
                      java.util.List<CoreLabel> object)
```
    See Also:
    
    RelationTriple(java.util.List, java.util.List, java.util.List, double)
- Method Detail
  - allTokens
```
public java.util.List<CoreLabel> allTokens()
```
    Returns all the tokens in the extraction, in the order subject then relation then object.
  - subjectGloss
```
public java.lang.String subjectGloss()
```
    The subject of this relation triple, as a String
  - subjectHead
```
public CoreLabel subjectHead()
```
    The head of the subject of this relation triple.
  - subjectLink
```
public java.lang.String subjectLink()
```
    The entity link of the subject
  - subjectLemmaGloss
```
public java.lang.String subjectLemmaGloss()
```
    The subject of this relation triple, as a String of the subject's lemmas. This method will additionally strip out punctuation as well.
  - objectGloss
```
public java.lang.String objectGloss()
```
    The object of this relation triple, as a String
  - objectHead
```
public CoreLabel objectHead()
```
    The head of the object of this relation triple.
  - objectLink
```
public java.lang.String objectLink()
```
    The entity link of the subject
  - objectLemmaGloss
```
public java.lang.String objectLemmaGloss()
```
    The object of this relation triple, as a String of the object's lemmas. This method will additionally strip out punctuation as well.
  - relationGloss
```
public java.lang.String relationGloss()
```
    The relation of this relation triple, as a String
  - relationLemmaGloss
```
public java.lang.String relationLemmaGloss()
```
    The relation of this relation triple, as a String of the relation's lemmas. This method will additionally strip out punctuation as well, and lower-cases the relation.
  - relationHead
```
public CoreLabel relationHead()
```
    The head of the relation of this relation triple. This is usually the main verb.
  - confidenceGloss
```
public java.lang.String confidenceGloss()
```
    A textual representation of the confidence.
  - subjectTokenSpan
```
public Pair<java.lang.Integer,java.lang.Integer> subjectTokenSpan()
```
    Gets the span of the NON-CANONICAL subject.
  - relationTokenSpan
```
public Pair<java.lang.Integer,java.lang.Integer> relationTokenSpan()
```
    Get a representative span for the relation expressed by this triple. This is a bit more complicated than the subject and object spans, as the relation span is occasionally discontinuous. If this is the case, this method returns the largest contiguous chunk. If the relation span is empty, return the object span.
  - objectTokenSpan
```
public Pair<java.lang.Integer,java.lang.Integer> objectTokenSpan()
```
    Gets the span of the NON-CANONICAL object.
  - isPrefixBe
```
public boolean isPrefixBe()
```
    If true, this relation expresses a "to be" relation. For example, "President Obama" expresses the relation (Obama; be; President).
  - isPrefixBe
```
public boolean isPrefixBe(boolean newValue)
```
    Set the value of this relation triple expressing a "to be" relation.
    
    Parameters:
    
    newValue - The new value of this relation being a "to be" relation.
    
    Returns:
    
    The old value of whether this relation expressed a "to be" relation.
  - isSuffixBe
```
public boolean isSuffixBe()
```
    If true, this relation expresses a "to be" relation (with the be at the end of the sentence). For example, "Tim's father Tom" expresses the relation (Tim; 's father is; Tom).
  - isSuffixBe
```
public boolean isSuffixBe(boolean newValue)
```
    Set the value of this relation triple expressing a "to be" relation (suffix).
    
    Parameters:
    
    newValue - The new value of this relation being a "to be" relation.
    
    Returns:
    
    The old value of whether this relation expressed a "to be" relation.
  - isSuffixOf
```
public boolean isSuffixOf()
```
    If true, this relation has an ungrounded "of" at the end of the relation. For example, "United States president Barack Obama" expresses the relation (Obama; is president of; United States).
  - isSuffixOf
```
public boolean isSuffixOf(boolean newValue)
```
    Set the value of this triple missing an ungrounded "of" in the relation string.
    
    Parameters:
    
    newValue - The new value of this relation missing an "of".
    
    Returns:
    
    The old value of whether this relation missing an "of".
  - istmod
```
public boolean istmod()
```
    If true, this relation expresses a tmod (temporal modifier) relation that is not grounded in the sentence. For example, "I went to the store Friday" would otherwise yield a strange triple (I; go to store; Friday).
  - istmod
```
public boolean istmod(boolean newValue)
```
    Set the value of this relation triple expressing a tmod (temporal modifier) relation.
    
    Parameters:
    
    newValue - The new value of this relation being a tmod relation.
    
    Returns:
    
    The old value of whether this relation expressed a tmod relation.
  - asDependencyTree
```
public java.util.Optional<SemanticGraph> asDependencyTree()
```
    An optional method, returning the dependency tree this triple was extracted from
  - asSentence
```
public java.util.List<CoreLabel> asSentence()
```
    Return the given relation triple as a flat sentence
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Print a human-readable description of this relation triple, as a tab-separated line.
    
    Overrides:
    
    toString in class java.lang.Object
  - toQaSrlString
```
public java.lang.String toQaSrlString(CoreMap sentence)
```
    Print in the format expected by Gabriel Stanovsky and Ido Dagan, Creating a Large Benchmark for Open Information Extraction, EMNLP 2016. https://gabrielstanovsky.github.io/assets/papers/emnlp16a/paper.pdf , with equivalence classes.
  - toReverbString
```
public java.lang.String toReverbString(java.lang.String docid,
                                       CoreMap sentence)
```
    Print a description of this triple, formatted like the ReVerb outputs.
  - compareTo
```
public int compareTo(RelationTriple o)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<RelationTriple>
  - iterator
```
public java.util.Iterator<CoreLabel> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<CoreLabel>

Class RelationTriple

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

subject

canonicalSubject

relation

object

canonicalObject

confidence

Constructor Detail

RelationTriple

RelationTriple

RelationTriple

RelationTriple

Method Detail

allTokens

subjectGloss

subjectHead

subjectLink

subjectLemmaGloss

objectGloss

objectHead

objectLink

objectLemmaGloss

relationGloss

relationLemmaGloss

relationHead

confidenceGloss

subjectTokenSpan

relationTokenSpan

objectTokenSpan

isPrefixBe

isPrefixBe

isSuffixBe

isSuffixBe

isSuffixOf

isSuffixOf

istmod

istmod

asDependencyTree

asSentence

equals

hashCode

toString

toQaSrlString

toReverbString

compareTo

iterator