Sentence (Stanford CoreNLP API)

java.lang.Object
- edu.stanford.nlp.simple.Sentence

```
public class Sentence
extends java.lang.Object
```
A representation of a single Sentence. Although it is possible to create a sentence directly from text, it is advisable to create a document instead and operate on the document directly.

Author:

Gabor Angeli

Field Summary

Fields
Modifier and Type Field and Description

Document document
The document this sentence is derived from

Fields
Modifier and Type	Field and Description
`Document`	`document` The document this sentence is derived from

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Sentence(java.util.function.BiFunction<java.util.Properties,java.lang.String,Document> docFn, CoreNLPProtos.Sentence proto, java.util.Properties props)` Create a sentence from a saved protocol buffer.
	`Sentence(CoreMap sentence)` Convert a CoreMap into a simple Sentence object.
	`Sentence(CoreNLPProtos.Sentence proto)` Create a sentence from a saved protocol buffer.
`protected`	`Sentence(Document doc, CoreMap sentence)` Helper for creating a sentence from a document and a CoreMap representation
`protected`	`Sentence(Document doc, CoreNLPProtos.Sentence.Builder proto, java.util.Properties defaultProps)` The canonical constructor of a sentence from a `Document`.
`protected`	`Sentence(Document doc, int sentenceIndex)` Helper for creating a sentence from a document at a given index
`protected`	`Sentence(Document doc, java.util.Properties props)` Create a new sentence, using the specified properties as the default properties.
`protected`	`Sentence(java.util.function.Function<java.lang.String,Document> doc, java.util.List<java.lang.String> tokens, java.util.Properties props)` The actual implementation of a tokenized sentence constructor
	`Sentence(java.util.List<java.lang.String> tokens)` Create a new sentence from the given tokenized text, assuming the entire text is just one sentence.
	`Sentence(SentenceFragment sentence)` Convert a sentence fragment (i.e., entailed sentence) into a simple sentence object.
	`Sentence(java.lang.String text)` Create a new sentence from the given text, assuming the entire text is just one sentence.
	`Sentence(java.lang.String text, java.util.Properties props)` Create a new sentence from some text, and some properties.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.List<java.lang.String>`	`after()` The whitespace after each token in the sentence.
`java.lang.String`	`after(int index)` The whitespace after this token in the sentence.
`SentenceAlgorithms`	`algorithms()` Return a class that can perform common algorithms on this sentence.
`java.util.List<CoreLabel>`	`asCoreLabels(java.util.function.Function<Sentence,java.lang.Object>... functions)` Returns this sentence as a list of CoreLabels representing the sentence.
`CoreMap`	`asCoreMap(java.util.function.Function<Sentence,java.lang.Object>... functions)` Returns this sentence as a CoreNLP CoreMap object.
`java.util.List<java.lang.String>`	`before()` The whitespace before each token in the sentence.
`java.lang.String`	`before(int index)` The whitespace before this token in the sentence.
`Sentence`	`cased()` Make this sentence case sensitive.
`Sentence`	`caseless()` Make this sentence caseless.
`java.util.List<java.lang.Integer>`	`characterOffsetBegin()` The character offset of each token in the sentence, as per `CoreLabel.beginPosition()`.
`int`	`characterOffsetBegin(int index)` The character offset of the given index in the sentence.
`java.util.List<java.lang.Integer>`	`characterOffsetEnd()` The end character offset of each token in the sentence, as per `CoreLabel.endPosition()`.
`int`	`characterOffsetEnd(int index)` The end character offset of the given index in the sentence.
`java.util.Map<java.lang.Integer,CorefChain>`	`coref()` Get the coreference chain for just this sentence.
`SemanticGraph`	`dependencyGraph()`
`SemanticGraph`	`dependencyGraph(java.util.Properties props)`
`SemanticGraph`	`dependencyGraph(java.util.Properties props, SemanticGraphFactory.Mode mode)` Returns the dependency graph of the sentence, as a raw `SemanticGraph` object.
`SemanticGraph`	`dependencyGraph(SemanticGraphFactory.Mode mode)`
`static Sentence`	`deserialize(java.io.InputStream in)` Read a sentence from an input stream.
`boolean`	`equals(java.lang.Object o)`
`<T> java.util.List<T>`	`find(java.lang.String pattern, java.util.function.Function<TokenSequenceMatcher,T> fn)`
`<T> java.util.List<T>`	`find(TokenSequencePattern pattern, java.util.function.Function<TokenSequenceMatcher,T> fn)` Apply a TokensRegex pattern to the sentence.
`java.util.Optional<java.lang.Integer>`	`governor(int index)`
`java.util.Optional<java.lang.Integer>`	`governor(int index, SemanticGraphFactory.Mode mode)`
`java.util.Optional<java.lang.Integer>`	`governor(java.util.Properties props, int index)`
`java.util.Optional<java.lang.Integer>`	`governor(java.util.Properties props, int index, SemanticGraphFactory.Mode mode)` Returns the governor of the given index, according to the passed dependency type.
`java.util.List<java.util.Optional<java.lang.Integer>>`	`governors()`
`java.util.List<java.util.Optional<java.lang.Integer>>`	`governors(java.util.Properties props)`
`java.util.List<java.util.Optional<java.lang.Integer>>`	`governors(java.util.Properties props, SemanticGraphFactory.Mode mode)` Returns the governors of a sentence, according to the passed dependency type.
`java.util.List<java.util.Optional<java.lang.Integer>>`	`governors(SemanticGraphFactory.Mode mode)`
`int`	`hashCode()`
`java.util.Optional<java.lang.String>`	`incomingDependencyLabel(int index)`
`java.util.Optional<java.lang.String>`	`incomingDependencyLabel(int index, SemanticGraphFactory.Mode mode)`
`java.util.Optional<java.lang.String>`	`incomingDependencyLabel(java.util.Properties props, int index)`
`java.util.Optional<java.lang.String>`	`incomingDependencyLabel(java.util.Properties props, int index, SemanticGraphFactory.Mode mode)` Returns the incoming dependency label to a particular index, according to the Basic Dependencies.
`java.util.List<java.util.Optional<java.lang.String>>`	`incomingDependencyLabels()`
`java.util.List<java.util.Optional<java.lang.String>>`	`incomingDependencyLabels(java.util.Properties props)`
`java.util.List<java.util.Optional<java.lang.String>>`	`incomingDependencyLabels(java.util.Properties props, SemanticGraphFactory.Mode mode)`
`java.util.List<java.util.Optional<java.lang.String>>`	`incomingDependencyLabels(SemanticGraphFactory.Mode mode)`
`java.util.Collection<Quadruple<java.lang.String,java.lang.String,java.lang.String,java.lang.Double>>`	`kbp()` Get a list of KBP triples as flat (subject, relation, object, confidence) quadruples.
`java.util.Collection<RelationTriple>`	`kbpTriples()`
`java.util.Collection<RelationTriple>`	`kbpTriples(java.util.Properties props)` Get the KBP triples associated with this sentence.
`java.lang.String`	`lemma(int index)`
`java.util.List<java.lang.String>`	`lemmas()`
`java.util.List<java.lang.String>`	`lemmas(java.util.Properties props)` The lemmas of the sentence.
`int`	`length()` The length of the sentence, in tokens
`boolean`	`matches(java.lang.String pattern)` Apply a TokensRegex pattern to the sentence.
`boolean`	`matches(TokenSequencePattern pattern)` Apply a TokensRegex pattern to the sentence.
`java.util.List<java.lang.String>`	`mentions()` Get all mentions of any NER tag, as a list of surface forms.
`java.util.List<java.lang.String>`	`mentions(java.lang.String nerTag)` Get all mentions of the given NER tag, as a list of surface forms.
`java.util.List<Polarity>`	`natlogPolarities()`
`java.util.List<Polarity>`	`natlogPolarities(java.util.Properties props)` The Natural Logic notion of polarity for each token in a sentence.
`Polarity`	`natlogPolarity(int index)`
`Polarity`	`natlogPolarity(java.util.Properties props, int index)` Get the polarity (the Natural Logic notion of polarity) for a given token in the sentence.
`java.lang.String`	`nerTag(int index)`
`java.util.List<java.lang.String>`	`nerTags()`
`java.util.List<java.lang.String>`	`nerTags(java.util.Properties props)` The named entity tags of the sentence.
`java.util.Collection<Quadruple<java.lang.String,java.lang.String,java.lang.String,java.lang.Double>>`	`openie()` Get a list of Open IE triples as flat (subject, relation, object, confidence) quadruples.
`java.util.Collection<RelationTriple>`	`openieTriples()`
`java.util.Collection<RelationTriple>`	`openieTriples(java.util.Properties props)` Get the OpenIE triples associated with this sentence.
`java.util.Optional<OperatorSpec>`	`operatorAt(int i)`
`java.util.Optional<OperatorSpec>`	`operatorAt(java.util.Properties props, int i)`
`java.util.List<java.util.Optional<OperatorSpec>>`	`operators()`
`java.util.List<java.util.Optional<OperatorSpec>>`	`operators(java.util.Properties props)` Get a list of the (possible) Natural Logic operators on each node of the sentence.
`java.util.List<OperatorSpec>`	`operatorsNonempty()`
`java.util.List<OperatorSpec>`	`operatorsNonempty(java.util.Properties props)` Returns the list of non-empty Natural Logic operator specifications.
`java.lang.String`	`originalText(int index)` The original word at the given index.
`java.util.List<java.lang.String>`	`originalTexts()` The original (unprocessed) words of the sentence, as per `CoreLabel.originalText()`.
`Tree`	`parse()`
`Tree`	`parse(java.util.Properties props)` Returns the constituency parse of this sentence.
`java.lang.String`	`posTag(int index)`
`java.util.List<java.lang.String>`	`posTags()`
`java.util.List<java.lang.String>`	`posTags(java.util.Properties props)` The part of speech tags of the sentence.
`CoreNLPProtos.Sentence.Builder`	`rawSentence()` Get the backing protocol buffer for this sentence.
`CoreNLPProtos.Token.Builder`	`rawToken(int i)` A helper to get the raw Protobuf builder for a given token.
`void`	`regexner(java.lang.String mappingFile, boolean ignorecase)` Run RegexNER over this sentence.
`<T> java.util.List<T>`	`semgrex(SemgrexPattern pattern, java.util.function.Function<SemgrexMatcher,T> fn)` Apply a semgrex pattern to the sentence
`<T> java.util.List<T>`	`semgrex(java.lang.String pattern, java.util.function.Function<SemgrexMatcher,T> fn)` Apply a semgrex pattern to the sentence
`java.util.Optional<java.lang.String>`	`sentenceid()` Returns the sentence id of the sentence, if one was found
`int`	`sentenceIndex()` The index of the sentence within the document.
`int`	`sentenceTokenOffsetBegin()` THe token offset of the sentence within the document.
`int`	`sentenceTokenOffsetEnd()` The token offset of the end of this sentence within the document.
`SentimentClass`	`sentiment()` The sentiment of this sentence (e.g., positive / negative).
`SentimentClass`	`sentiment(java.util.Properties props)` The sentiment of this sentence (e.g., positive / negative).
`CoreNLPProtos.Sentence`	`serialize()` Serialize the given sentence (but not the associated document!) into a Protocol Buffer.
`void`	`serialize(java.io.OutputStream out)` Write this sentence to an output stream.
`java.lang.String`	`substring(int start, int end)`
`java.lang.String`	`text()` The raw text of the sentence, as input by, e.g., `Sentence(String)`.
`java.util.List<Token>`	`tokens()` The tokens in this sentence.
`java.lang.String`	`toString()`
`protected void`	`updateDependencies(CoreNLPProtos.DependencyGraph basic, CoreNLPProtos.DependencyGraph enhanced, CoreNLPProtos.DependencyGraph enhancedPlusPlus)` Update the dependencies of the sentence.
`protected void`	`updateKBP(java.util.stream.Stream<CoreNLPProtos.RelationTriple> triples)` Update the Open IE relation triples for this sentence.
`protected void`	`updateOpenIE(java.util.stream.Stream<CoreNLPProtos.RelationTriple> triples)` Update the Open IE relation triples for this sentence.
`protected void`	`updateParse(CoreNLPProtos.ParseTree parse, CoreNLPProtos.ParseTree binary)` Update the parse tree for this sentence.
`protected void`	`updateSentiment(java.lang.String sentiment)` Update the Sentiment class for this sentence.
`protected <E> void`	`updateTokens(java.util.List<CoreLabel> tokens, java.util.function.Consumer<Pair<CoreNLPProtos.Token.Builder,E>> setter, java.util.function.Function<CoreLabel,E> getter)` Update each token in the sentence with the given information.
`java.lang.String`	`word(int index)` The word at the given index of the sentence.
`java.util.List<java.lang.String>`	`words()` The words of the sentence, as per `CoreLabel.word()`.

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

- Field Detail
  - document
```
public final Document document
```
    The document this sentence is derived from
- Constructor Detail
  - Sentence
```
protected Sentence(Document doc,
                   java.util.Properties props)
```
    Create a new sentence, using the specified properties as the default properties.
    
    Parameters:
    
    doc - The document to link this sentence to.
    
    props - The properties to use for tokenizing the sentence.
  - Sentence
```
public Sentence(java.lang.String text,
                java.util.Properties props)
```
    Create a new sentence from some text, and some properties.
    
    Parameters:
    
    text - The text of the sentence.
    
    props - The properties to use for the annotators.
  - Sentence
```
public Sentence(java.lang.String text)
```
    Create a new sentence from the given text, assuming the entire text is just one sentence.
    
    Parameters:
    
    text - The text of the sentence.
  - Sentence
```
protected Sentence(java.util.function.Function<java.lang.String,Document> doc,
                   java.util.List<java.lang.String> tokens,
                   java.util.Properties props)
```
    The actual implementation of a tokenized sentence constructor
  - Sentence
```
public Sentence(java.util.List<java.lang.String> tokens)
```
    Create a new sentence from the given tokenized text, assuming the entire text is just one sentence. WARNING: This method may in rare cases (mostly when tokens themselves have whitespace in them) produce strange results; it's a bit of a hack around the default tokenizer.
    
    Parameters:
    
    tokens - The text of the sentence.
  - Sentence
```
protected Sentence(java.util.function.BiFunction<java.util.Properties,java.lang.String,Document> docFn,
                   CoreNLPProtos.Sentence proto,
                   java.util.Properties props)
```
    Create a sentence from a saved protocol buffer.
  - Sentence
```
public Sentence(CoreNLPProtos.Sentence proto)
```
    Create a sentence from a saved protocol buffer.
  - Sentence
```
protected Sentence(Document doc,
                   int sentenceIndex)
```
    Helper for creating a sentence from a document at a given index
  - Sentence
```
protected Sentence(Document doc,
                   CoreNLPProtos.Sentence.Builder proto,
                   java.util.Properties defaultProps)
```
    The canonical constructor of a sentence from a Document.
    
    Parameters:
    
    doc - The document to link this sentence to.
    
    proto - The sentence implementation to use for this sentence.
  - Sentence
```
protected Sentence(Document doc,
                   CoreMap sentence)
```
    Helper for creating a sentence from a document and a CoreMap representation
  - Sentence
```
public Sentence(CoreMap sentence)
```
    Convert a CoreMap into a simple Sentence object. Note that this is a copy operation -- the implementing CoreMap will not be updated, and all of its contents are copied over to the protocol buffer format backing the Sentence object.
    
    Parameters:
    
    sentence - The CoreMap representation of the sentence.
  - Sentence
```
public Sentence(SentenceFragment sentence)
```
    Convert a sentence fragment (i.e., entailed sentence) into a simple sentence object. Like Sentence(CoreMap), this copies the information in the fragment into the underlying protobuf backed format.
    
    Parameters:
    
    sentence - The sentence fragment to convert.
- Method Detail
  - caseless
```
public Sentence caseless()
```
    Make this sentence caseless. That is, from now on, run the caseless models on the sentence by default rather than the standard CoreNLP models.
    
    Returns:
    
    A new sentence with the default properties swapped out.
  - cased
```
public Sentence cased()
```
    Make this sentence case sensitive. A sentence is case sensitive by default; this only has an effect if you have previously called caseless().
    
    Returns:
    
    A new sentence with the default properties swapped out.
  - serialize
```
public CoreNLPProtos.Sentence serialize()
```
    Serialize the given sentence (but not the associated document!) into a Protocol Buffer.
    
    Returns:
    
    The Protocol Buffer representing this sentence.
  - serialize
```
public void serialize(java.io.OutputStream out)
               throws java.io.IOException
```
    Write this sentence to an output stream. Internally, this stores the sentence as a protocol buffer, and saves that buffer to the output stream. This method does not close the stream after writing.
    
    Parameters:
    
    out - The output stream to write to. The stream is not closed after the method returns.
    
    Throws:
    
    java.io.IOException - Thrown from the underlying write() implementation.
  - deserialize
```
public static Sentence deserialize(java.io.InputStream in)
                            throws java.io.IOException
```
    Read a sentence from an input stream. This does not close the input stream.
    
    Parameters:
    
    in - The input stream to deserialize from.
    
    Returns:
    
    The next sentence encoded in the input stream.
    
    Throws:
    
    java.io.IOException - Thrown by the underlying parse() implementation.
    
    See Also:
    
    Document.serialize(java.io.OutputStream)
  - algorithms
```
public SentenceAlgorithms algorithms()
```
    Return a class that can perform common algorithms on this sentence.
  - text
```
public java.lang.String text()
```
    The raw text of the sentence, as input by, e.g., Sentence(String).
  - sentenceIndex
```
public int sentenceIndex()
```
    The index of the sentence within the document.
  - sentenceTokenOffsetBegin
```
public int sentenceTokenOffsetBegin()
```
    THe token offset of the sentence within the document.
  - sentenceTokenOffsetEnd
```
public int sentenceTokenOffsetEnd()
```
    The token offset of the end of this sentence within the document.
  - words
```
public java.util.List<java.lang.String> words()
```
    The words of the sentence, as per CoreLabel.word().
  - word
```
public java.lang.String word(int index)
```
    The word at the given index of the sentence. @see Sentence#words()
  - originalTexts
```
public java.util.List<java.lang.String> originalTexts()
```
    The original (unprocessed) words of the sentence, as per CoreLabel.originalText().
  - originalText
```
public java.lang.String originalText(int index)
```
    The original word at the given index. @see Sentence#originalTexts()
  - characterOffsetBegin
```
public java.util.List<java.lang.Integer> characterOffsetBegin()
```
    The character offset of each token in the sentence, as per CoreLabel.beginPosition().
  - characterOffsetBegin
```
public int characterOffsetBegin(int index)
```
    The character offset of the given index in the sentence. @see Sentence#characterOffsetBegin().
  - characterOffsetEnd
```
public java.util.List<java.lang.Integer> characterOffsetEnd()
```
    The end character offset of each token in the sentence, as per CoreLabel.endPosition().
  - characterOffsetEnd
```
public int characterOffsetEnd(int index)
```
    The end character offset of the given index in the sentence. @see Sentence#characterOffsetEnd().
  - before
```
public java.util.List<java.lang.String> before()
```
    The whitespace before each token in the sentence. This will match after() of the previous token.
  - before
```
public java.lang.String before(int index)
```
    The whitespace before this token in the sentence. This will match after() of the previous token.
  - after
```
public java.util.List<java.lang.String> after()
```
    The whitespace after each token in the sentence. This will match before() of the next token.
  - after
```
public java.lang.String after(int index)
```
    The whitespace after this token in the sentence. This will match before() of the next token.
  - tokens
```
public java.util.List<Token> tokens()
```
    The tokens in this sentence. Each token class is just a helper for the methods in this class.
  - posTags
```
public java.util.List<java.lang.String> posTags(java.util.Properties props)
```
    The part of speech tags of the sentence.
    
    Parameters:
    
    props - The properties to use for the POSTaggerAnnotator.
    
    Returns:
    
    A list of part of speech tags, one for each token in the sentence.
  - posTags
```
public java.util.List<java.lang.String> posTags()
```
    See Also:
    
    posTags(java.util.Properties)
  - posTag
```
public java.lang.String posTag(int index)
```
    See Also:
    
    posTags(java.util.Properties)
  - lemmas
```
public java.util.List<java.lang.String> lemmas(java.util.Properties props)
```
    The lemmas of the sentence.
    
    Parameters:
    
    props - The properties to use for the MorphaAnnotator.
    
    Returns:
    
    A list of lemmatized words, one for each token in the sentence.
  - lemmas
```
public java.util.List<java.lang.String> lemmas()
```
    See Also:
    
    lemmas(java.util.Properties)
  - lemma
```
public java.lang.String lemma(int index)
```
    See Also:
    
    lemmas(java.util.Properties)
  - nerTags
```
public java.util.List<java.lang.String> nerTags(java.util.Properties props)
```
    The named entity tags of the sentence.
    
    Parameters:
    
    props - The properties to use for the NERCombinerAnnotator.
    
    Returns:
    
    A list of named entity tags, one for each token in the sentence.
  - nerTags
```
public java.util.List<java.lang.String> nerTags()
```
    See Also:
    
    nerTags(java.util.Properties)
  - regexner
```
public void regexner(java.lang.String mappingFile,
                     boolean ignorecase)
```
    Run RegexNER over this sentence. Note that this is an in place operation, and simply updates the NER tags. Therefore, every time this function is called, it re-runs the annotator!
    
    Parameters:
    
    mappingFile - The regexner mapping file.
    
    ignorecase - If true, run a caseless match on the regexner file.
  - nerTag
```
public java.lang.String nerTag(int index)
```
    See Also:
    
    nerTags(java.util.Properties)
  - mentions
```
public java.util.List<java.lang.String> mentions(java.lang.String nerTag)
```
    Get all mentions of the given NER tag, as a list of surface forms.
    
    Parameters:
    
    nerTag - The ner tag to search for, case sensitive.
    
    Returns:
    
    A list of surface forms of the entities of this tag. This is using the word(int) function.
  - mentions
```
public java.util.List<java.lang.String> mentions()
```
    Get all mentions of any NER tag, as a list of surface forms.
    
    Returns:
    
    A list of surface forms of the entities in this sentence. This is using the word(int) function.
  - parse
```
public Tree parse(java.util.Properties props)
```
    Returns the constituency parse of this sentence.
    
    Parameters:
    
    props - The properties to use in the parser annotator.
    
    Returns:
    
    A parse tree object.
  - parse
```
public Tree parse()
```
    See Also:
    
    parse(java.util.Properties)
  - governor
```
public java.util.Optional<java.lang.Integer> governor(java.util.Properties props,
                                                      int index,
                                                      SemanticGraphFactory.Mode mode)
```
    Returns the governor of the given index, according to the passed dependency type. The root has index -1.
    
    Parameters:
    
    props - The properties to use in the parser annotator.
    
    index - The index of the dependent word ZERO INDEXED. That is, the first word of the sentence is index 0, not 1 as it would be in the SemanticGraph framework.
    
    mode - The type of dependency to use (e.g., basic, collapsed, collapsed cc processed).
    
    Returns:
    
    The index of the governor, if one exists. A value of -1 indicates the root node.
  - governor
```
public java.util.Optional<java.lang.Integer> governor(java.util.Properties props,
                                                      int index)
```
    See Also:
    
    governor(java.util.Properties, int, SemanticGraphFactory.Mode)
  - governor
```
public java.util.Optional<java.lang.Integer> governor(int index,
                                                      SemanticGraphFactory.Mode mode)
```
    See Also:
    
    governor(java.util.Properties, int, SemanticGraphFactory.Mode)
  - governor
```
public java.util.Optional<java.lang.Integer> governor(int index)
```
    See Also:
    
    governor(java.util.Properties, int)
  - governors
```
public java.util.List<java.util.Optional<java.lang.Integer>> governors(java.util.Properties props,
                                                                       SemanticGraphFactory.Mode mode)
```
    Returns the governors of a sentence, according to the passed dependency type. The resulting list is of the same size as the original sentence, with each element being either the governor (index), or empty if the node has no known governor. The root has index -1.
    
    Parameters:
    
    props - The properties to use in the parser annotator.
    
    mode - The type of dependency to use (e.g., basic, collapsed, collapsed cc processed).
    
    Returns:
    
    A list of the (optional) governors of each token in the sentence.
  - governors
```
public java.util.List<java.util.Optional<java.lang.Integer>> governors(java.util.Properties props)
```
    See Also:
    
    governors(java.util.Properties, SemanticGraphFactory.Mode)
  - governors
```
public java.util.List<java.util.Optional<java.lang.Integer>> governors(SemanticGraphFactory.Mode mode)
```
    See Also:
    
    governors(java.util.Properties, SemanticGraphFactory.Mode)
  - governors
```
public java.util.List<java.util.Optional<java.lang.Integer>> governors()
```
    See Also:
    
    governors(java.util.Properties, SemanticGraphFactory.Mode)
  - incomingDependencyLabel
```
public java.util.Optional<java.lang.String> incomingDependencyLabel(java.util.Properties props,
                                                                    int index,
                                                                    SemanticGraphFactory.Mode mode)
```
    Returns the incoming dependency label to a particular index, according to the Basic Dependencies.
    
    Parameters:
    
    props - The properties to use in the parser annotator.
    
    index - The index of the dependent word ZERO INDEXED. That is, the first word of the sentence is index 0, not 1 as it would be in the SemanticGraph framework.
    
    mode - The type of dependency to use (e.g., basic, collapsed, collapsed cc processed).
    
    Returns:
    
    The incoming dependency label, if it exists.
  - incomingDependencyLabel
```
public java.util.Optional<java.lang.String> incomingDependencyLabel(java.util.Properties props,
                                                                    int index)
```
    See Also:
    
    incomingDependencyLabel(java.util.Properties, int, SemanticGraphFactory.Mode)
  - incomingDependencyLabel
```
public java.util.Optional<java.lang.String> incomingDependencyLabel(int index,
                                                                    SemanticGraphFactory.Mode mode)
```
    See Also:
    
    incomingDependencyLabel(java.util.Properties, int, SemanticGraphFactory.Mode)
  - incomingDependencyLabel
```
public java.util.Optional<java.lang.String> incomingDependencyLabel(int index)
```
    See Also:
    
    incomingDependencyLabel(java.util.Properties, int)
  - incomingDependencyLabels
```
public java.util.List<java.util.Optional<java.lang.String>> incomingDependencyLabels(java.util.Properties props,
                                                                                     SemanticGraphFactory.Mode mode)
```
    See Also:
    
    incomingDependencyLabel(java.util.Properties, int)
  - incomingDependencyLabels
```
public java.util.List<java.util.Optional<java.lang.String>> incomingDependencyLabels(SemanticGraphFactory.Mode mode)
```
    See Also:
    
    incomingDependencyLabels(java.util.Properties, SemanticGraphFactory.Mode)
  - incomingDependencyLabels
```
public java.util.List<java.util.Optional<java.lang.String>> incomingDependencyLabels(java.util.Properties props)
```
    See Also:
    
    incomingDependencyLabels(java.util.Properties, SemanticGraphFactory.Mode)
  - incomingDependencyLabels
```
public java.util.List<java.util.Optional<java.lang.String>> incomingDependencyLabels()
```
    See Also:
    
    incomingDependencyLabels(java.util.Properties, SemanticGraphFactory.Mode)
  - dependencyGraph
```
public SemanticGraph dependencyGraph(java.util.Properties props,
                                     SemanticGraphFactory.Mode mode)
```
    Returns the dependency graph of the sentence, as a raw SemanticGraph object. Note that this method is slower than you may expect, as it has to convert the underlying protocol buffer back into a list of CoreLabels with which to populate the SemanticGraph.
    
    Parameters:
    
    props - The properties to use for running the dependency parser annotator.
    
    mode - The type of graph to return (e.g., basic, collapsed, etc).
    
    Returns:
    
    The dependency graph of the sentence.
  - dependencyGraph
```
public SemanticGraph dependencyGraph(java.util.Properties props)
```
    See Also:
    
    dependencyGraph(Properties, SemanticGraphFactory.Mode)
  - dependencyGraph
```
public SemanticGraph dependencyGraph()
```
    See Also:
    
    dependencyGraph(Properties, SemanticGraphFactory.Mode)
  - dependencyGraph
```
public SemanticGraph dependencyGraph(SemanticGraphFactory.Mode mode)
```
    See Also:
    
    dependencyGraph(Properties, SemanticGraphFactory.Mode)
  - length
```
public int length()
```
    The length of the sentence, in tokens
  - operators
```
public java.util.List<java.util.Optional<OperatorSpec>> operators(java.util.Properties props)
```
    Get a list of the (possible) Natural Logic operators on each node of the sentence. At each index, the list contains an operator spec if that index is the head word of an operator in the sentence.
    
    Parameters:
    
    props - The properties to pass to the natural logic annotator.
    
    Returns:
    
    A list of Optionals, where each element corresponds to a token in the sentence, and the optional is nonempty if that index is an operator.
  - operators
```
public java.util.List<java.util.Optional<OperatorSpec>> operators()
```
    See Also:
    
    operators(Properties)
  - operatorAt
```
public java.util.Optional<OperatorSpec> operatorAt(java.util.Properties props,
                                                   int i)
```
    See Also:
    
    operators(Properties)
  - operatorAt
```
public java.util.Optional<OperatorSpec> operatorAt(int i)
```
    See Also:
    
    operators(Properties)
  - operatorsNonempty
```
public java.util.List<OperatorSpec> operatorsNonempty(java.util.Properties props)
```
    Returns the list of non-empty Natural Logic operator specifications. This amounts to the actual list of operators in the sentence. Note that the spans of the operators can be retrieved with OperatorSpec.quantifierBegin and OperatorSpec.quantifierEnd.
    
    Parameters:
    
    props - The properties to use for the natlog annotator.
    
    Returns:
    
    A list of operators in the sentence.
  - operatorsNonempty
```
public java.util.List<OperatorSpec> operatorsNonempty()
```
    See Also:
    
    operatorsNonempty(Properties)
  - natlogPolarities
```
public java.util.List<Polarity> natlogPolarities(java.util.Properties props)
```
    The Natural Logic notion of polarity for each token in a sentence.
    
    Parameters:
    
    props - The properties to use for the natural logic annotator.
    
    Returns:
    
    A list of Polarity objects, one for each token of the sentence.
  - natlogPolarities
```
public java.util.List<Polarity> natlogPolarities()
```
    See Also:
    
    natlogPolarities(Properties)
  - natlogPolarity
```
public Polarity natlogPolarity(java.util.Properties props,
                               int index)
```
    Get the polarity (the Natural Logic notion of polarity) for a given token in the sentence.
    
    Parameters:
    
    props - The properties to use for the natural logic annotator.
    
    index - The index to return the polarity of.
    
    Returns:
    
    A list of Polarity objects, one for each token of the sentence.
  - natlogPolarity
```
public Polarity natlogPolarity(int index)
```
    See Also:
    
    natlogPolarity(Properties, int)
  - openieTriples
```
public java.util.Collection<RelationTriple> openieTriples(java.util.Properties props)
```
    Get the OpenIE triples associated with this sentence. Note that this function may be slower than you would expect, as it has to convert the underlying Protobuf representation back into CoreLabels.
    
    Parameters:
    
    props - The properties to use for the OpenIE annotator.
    
    Returns:
    
    A collection of RelationTriple objects representing the OpenIE triples in the sentence.
  - openieTriples
```
public java.util.Collection<RelationTriple> openieTriples()
```
    See Also:
    
    Sentence@openieTriples(Properties)
  - openie
```
public java.util.Collection<Quadruple<java.lang.String,java.lang.String,java.lang.String,java.lang.Double>> openie()
```
    Get a list of Open IE triples as flat (subject, relation, object, confidence) quadruples. This is substantially faster than returning RelationTriple objects, as it doesn't require converting the underlying representation into CoreLabels; but, it also contains significantly less information about the sentence.
    
    See Also:
    
    Sentence@openieTriples(Properties)
  - kbpTriples
```
public java.util.Collection<RelationTriple> kbpTriples(java.util.Properties props)
```
    Get the KBP triples associated with this sentence. Note that this function may be slower than you would expect, as it has to convert the underlying Protobuf representation back into CoreLabels.
    
    Parameters:
    
    props - The properties to use for the KBP annotator.
    
    Returns:
    
    A collection of RelationTriple objects representing the KBP triples in the sentence.
  - kbpTriples
```
public java.util.Collection<RelationTriple> kbpTriples()
```
    See Also:
    
    Sentence@kbpTriples(Properties)
  - kbp
```
public java.util.Collection<Quadruple<java.lang.String,java.lang.String,java.lang.String,java.lang.Double>> kbp()
```
    Get a list of KBP triples as flat (subject, relation, object, confidence) quadruples. This is substantially faster than returning RelationTriple objects, as it doesn't require converting the underlying representation into CoreLabels; but, it also contains significantly less information about the sentence.
    
    See Also:
    
    Sentence@kbpTriples(Properties)
  - sentiment
```
public SentimentClass sentiment()
```
    The sentiment of this sentence (e.g., positive / negative).
    
    Returns:
    
    The SentimentClass of this sentence, as an enum value.
  - sentiment
```
public SentimentClass sentiment(java.util.Properties props)
```
    The sentiment of this sentence (e.g., positive / negative).
    
    Parameters:
    
    props - The properties to pass to the sentiment classifier.
    
    Returns:
    
    The SentimentClass of this sentence, as an enum value.
  - coref
```
public java.util.Map<java.lang.Integer,CorefChain> coref()
```
    Get the coreference chain for just this sentence. Note that this method is actually fairly computationally expensive to call, as it constructs and prunes the coreference data structure for the entire document.
    
    Returns:
    
    A coreference chain, but only for this sentence
  - asCoreMap
```
@SafeVarargs
public final CoreMap asCoreMap(java.util.function.Function<Sentence,java.lang.Object>... functions)
```
    Returns this sentence as a CoreNLP CoreMap object. Note that, importantly, only the fields which have already been called will be populated in the CoreMap! Therefore, this method is generally NOT recommended.
    
    Parameters:
    
    functions - A list of functions to call before populating the CoreMap. For example, you can specify mySentence::posTags, and then posTags will be populated.
  - asCoreLabels
```
@SafeVarargs
public final java.util.List<CoreLabel> asCoreLabels(java.util.function.Function<Sentence,java.lang.Object>... functions)
```
    Returns this sentence as a list of CoreLabels representing the sentence. Note that, importantly, only the fields which have already been called will be populated in the CoreMap! Therefore, this method is generally NOT recommended.
    
    Parameters:
    
    functions - A list of functions to call before populating the CoreMap. For example, you can specify mySentence::posTags, and then posTags will be populated.
  - rawToken
```
public CoreNLPProtos.Token.Builder rawToken(int i)
```
    A helper to get the raw Protobuf builder for a given token. Primarily useful for cache checks.
    
    Parameters:
    
    i - The index of the token to retrieve.
    
    Returns:
    
    A Protobuf builder for that token.
  - rawSentence
```
public CoreNLPProtos.Sentence.Builder rawSentence()
```
    Get the backing protocol buffer for this sentence.
    
    Returns:
    
    The raw backing protocol buffer builder for this sentence.
  - updateTokens
```
protected <E> void updateTokens(java.util.List<CoreLabel> tokens,
                                java.util.function.Consumer<Pair<CoreNLPProtos.Token.Builder,E>> setter,
                                java.util.function.Function<CoreLabel,E> getter)
```
    Update each token in the sentence with the given information.
    
    Type Parameters:
    
    E - The type of the given field we are setting in the protocol buffer and reading from the CoreLabel.
    
    Parameters:
    
    tokens - The CoreNLP tokens returned by the Annotator.
    
    setter - The function to set a Protobuf object with the given field.
    
    getter - The function to get the given field from the CoreLabel.
  - updateParse
```
protected void updateParse(CoreNLPProtos.ParseTree parse,
                           CoreNLPProtos.ParseTree binary)
```
    Update the parse tree for this sentence.
    
    Parameters:
    
    parse - The parse tree to update.
    
    binary - The binary parse tree to update.
  - updateDependencies
```
protected void updateDependencies(CoreNLPProtos.DependencyGraph basic,
                                  CoreNLPProtos.DependencyGraph enhanced,
                                  CoreNLPProtos.DependencyGraph enhancedPlusPlus)
```
    Update the dependencies of the sentence.
    
    Parameters:
    
    basic - The basic dependencies to update.
    
    enhanced - The enhanced dependencies to update.
    
    enhancedPlusPlus - The enhanced plus plus dependencies to update.
  - updateOpenIE
```
protected void updateOpenIE(java.util.stream.Stream<CoreNLPProtos.RelationTriple> triples)
```
    Update the Open IE relation triples for this sentence.
    
    Parameters:
    
    triples - The stream of relation triples to add to the sentence.
  - updateKBP
```
protected void updateKBP(java.util.stream.Stream<CoreNLPProtos.RelationTriple> triples)
```
    Update the Open IE relation triples for this sentence.
    
    Parameters:
    
    triples - The stream of relation triples to add to the sentence.
  - updateSentiment
```
protected void updateSentiment(java.lang.String sentiment)
```
    Update the Sentiment class for this sentence.
    
    Parameters:
    
    sentiment - The sentiment of the 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()
```
    Overrides:
    
    toString in class java.lang.Object
  - substring
```
public java.lang.String substring(int start,
                                  int end)
```
    Parameters:
    
    start - - inclusive
    
    end - - exclusive
    
    Returns:
    
    - the text for the provided token span.
  - sentenceid
```
public java.util.Optional<java.lang.String> sentenceid()
```
    Returns the sentence id of the sentence, if one was found
  - matches
```
public boolean matches(TokenSequencePattern pattern)
```
    Apply a TokensRegex pattern to the sentence.
    
    Parameters:
    
    pattern - The TokensRegex pattern to match against.
    
    Returns:
    
    the matcher.
  - matches
```
public boolean matches(java.lang.String pattern)
```
    Apply a TokensRegex pattern to the sentence.
    
    Parameters:
    
    pattern - The TokensRegex pattern to match against.
    
    Returns:
    
    True if the tokensregex pattern matches.
  - find
```
public <T> java.util.List<T> find(TokenSequencePattern pattern,
                                  java.util.function.Function<TokenSequenceMatcher,T> fn)
```
    Apply a TokensRegex pattern to the sentence.
    
    Parameters:
    
    pattern - The TokensRegex pattern to match against.
    
    fn - The action to do on each match.
    
    Returns:
    
    the list of matches, after run through the function.
  - find
```
public <T> java.util.List<T> find(java.lang.String pattern,
                                  java.util.function.Function<TokenSequenceMatcher,T> fn)
```
  - semgrex
```
public <T> java.util.List<T> semgrex(SemgrexPattern pattern,
                                     java.util.function.Function<SemgrexMatcher,T> fn)
```
    Apply a semgrex pattern to the sentence
    
    Parameters:
    
    pattern - The Semgrex pattern to match against.
    
    fn - The action to do on each match.
    
    Returns:
    
    the list of matches, after run through the function.
  - semgrex
```
public <T> java.util.List<T> semgrex(java.lang.String pattern,
                                     java.util.function.Function<SemgrexMatcher,T> fn)
```
    Apply a semgrex pattern to the sentence
    
    Parameters:
    
    pattern - The Semgrex pattern to match against.
    
    fn - The action to do on each match.
    
    Returns:
    
    the list of matches, after run through the function.

Class Sentence

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

document

Constructor Detail

Sentence

Sentence

Sentence

Sentence

Sentence

Sentence

Sentence

Sentence

Sentence

Sentence

Sentence

Sentence

Method Detail

caseless

cased

serialize

serialize

deserialize

algorithms

text

sentenceIndex

sentenceTokenOffsetBegin

sentenceTokenOffsetEnd

words

word

originalTexts

originalText

characterOffsetBegin

characterOffsetBegin

characterOffsetEnd

characterOffsetEnd

before

before

after

after

tokens

posTags

posTags

posTag

lemmas

lemmas

lemma

nerTags

nerTags

regexner

nerTag

mentions

mentions

parse

parse

governor

governor

governor

governor

governors

governors

governors

governors

incomingDependencyLabel

incomingDependencyLabel

incomingDependencyLabel

incomingDependencyLabel

incomingDependencyLabels

incomingDependencyLabels

incomingDependencyLabels

incomingDependencyLabels

dependencyGraph

dependencyGraph

dependencyGraph

dependencyGraph

length

operators