org.languagetool

Class AnalyzedSentence

java.lang.Object

org.languagetool.AnalyzedSentence

public final class AnalyzedSentence
extends Object

A sentence that has been tokenized and analyzed.

Author:

Daniel Naber

Constructor Summary

Constructors

Constructor and Description
AnalyzedSentence(AnalyzedTokenReadings[] tokens) Creates an AnalyzedSentence from the given AnalyzedTokenReadings.
AnalyzedSentence(AnalyzedTokenReadings[] tokens, AnalyzedTokenReadings[] preDisambigTokens)

Method Summary

Modifier and Type	Method and Description
AnalyzedSentence	copy(AnalyzedSentence sentence) The method copies AnalyzedSentence and returns the copy.
boolean	equals(Object o)
String	getAnnotations() Get disambiguator actions log.
int	getCorrectedTextLength() Text length taking position fixes (for removed soft hyphens etc.) into account, so this is _not_ always equal to getText().
List<Integer>	getLemmaOffsets(String token)
Set<String>	getLemmaSet() Get the lowercase lemmas of this sentence in a set.
int	getOriginalPosition(int nonWhPosition) Get a position of a non-whitespace token in the original sentence with whitespace.
AnalyzedTokenReadings[]	getPreDisambigTokens()
AnalyzedTokenReadings[]	getPreDisambigTokensWithoutWhitespace()
String	getText() Return the original text.
List<Integer>	getTokenOffsets(String token)
AnalyzedTokenReadings[]	getTokens() Returns the AnalyzedTokenReadings of the analyzed text.
Set<String>	getTokenSet() Get the lowercase tokens of this sentence in a set.
AnalyzedTokenReadings[]	getTokensWithoutWhitespace() Returns the AnalyzedTokenReadings of the analyzed text, with whitespace tokens removed but with the artificial SENT_START token included.
int	hashCode()
String	toShortString(String readingDelimiter) Return string representation without chunk information.
String	toString()
String	toString(String readingDelimiter) Return string representation with chunk information.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnalyzedSentence

public AnalyzedSentence(AnalyzedTokenReadings[] tokens)

Creates an AnalyzedSentence from the given AnalyzedTokenReadings. Whitespace is also a token.

AnalyzedSentence

public AnalyzedSentence(AnalyzedTokenReadings[] tokens,
                        AnalyzedTokenReadings[] preDisambigTokens)

Method Detail

copy

public AnalyzedSentence copy(AnalyzedSentence sentence)

The method copies AnalyzedSentence and returns the copy. Useful for performing local immunization (for example).

Parameters:

sentence - AnalyzedSentence to be copied

Returns:

a new object which is a copy

Since:

2.5

getTokens

public AnalyzedTokenReadings[] getTokens()

Returns the AnalyzedTokenReadings of the analyzed text. Whitespace is also a token.

getPreDisambigTokens

public AnalyzedTokenReadings[] getPreDisambigTokens()

Since:

4.5

getTokensWithoutWhitespace

public AnalyzedTokenReadings[] getTokensWithoutWhitespace()

Returns the AnalyzedTokenReadings of the analyzed text, with whitespace tokens removed but with the artificial SENT_START token included.

getPreDisambigTokensWithoutWhitespace

public AnalyzedTokenReadings[] getPreDisambigTokensWithoutWhitespace()

Since:

4.5

getOriginalPosition

public int getOriginalPosition(int nonWhPosition)

Get a position of a non-whitespace token in the original sentence with whitespace.

Parameters:

nonWhPosition - position of a non-whitespace token

Returns:

position in the original sentence.

toString

public String toString()

Overrides:

toString in class Object

toShortString

public String toShortString(String readingDelimiter)

Return string representation without chunk information.

Since:

2.3

getText

public String getText()

Return the original text.

Since:

2.7

getCorrectedTextLength

public int getCorrectedTextLength()

Text length taking position fixes (for removed soft hyphens etc.) into account, so this is _not_ always equal to getText().

Since:

5.1

toString

public String toString(String readingDelimiter)

Return string representation with chunk information.

getAnnotations

public String getAnnotations()

Get disambiguator actions log.

getTokenSet

public Set<String> getTokenSet()

Get the lowercase tokens of this sentence in a set. Used internally for performance optimization.

Since:

2.4

getLemmaSet

public Set<String> getLemmaSet()

Get the lowercase lemmas of this sentence in a set. Used internally for performance optimization.

Since:

2.5

getTokenOffsets

@Nullable
 @ApiStatus.Internal
public List<Integer> getTokenOffsets(String token)

Returns:

all offsets in getTokensWithoutWhitespace() where tokens with the given text occur (case-insensitive), or null if there are no such occurrences

Since:

5.3

getLemmaOffsets

@Nullable
 @ApiStatus.Internal
public List<Integer> getLemmaOffsets(String token)

Returns:

all offsets in getTokensWithoutWhitespace() where tokens with the given lemma occur (case-insensitive), or null if there are no such occurrences

Since:

5.3

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object