AnalyzedTokenReadings (LanguageTool Style and Grammar Checker Core 3.0 API)

java.lang.Object
- org.languagetool.AnalyzedTokenReadings

All Implemented Interfaces:

Iterable<AnalyzedToken>
```
public final class AnalyzedTokenReadings
extends Object
implements Iterable<AnalyzedToken>
```
An array of AnalyzedTokens used to store multiple POS tags and lemmas for a given single token.

Author:

Marcin Milkowski

Constructor Summary

Constructors
Constructor and Description
`AnalyzedTokenReadings(AnalyzedToken[] tokens, int startPos)`
`AnalyzedTokenReadings(AnalyzedToken token, int startPos)`
`AnalyzedTokenReadings(List<AnalyzedToken> tokens, int startPos)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addReading(AnalyzedToken token)` Add a new reading.
`boolean`	`equals(Object obj)`
`AnalyzedToken`	`getAnalyzedToken(int idx)` Get a token reading.
`List<ChunkTag>`	`getChunkTags()`
`int`	`getEndPos()`
`String`	`getHistoricalAnnotations()` Used to track disambiguator actions.
`List<AnalyzedToken>`	`getReadings()`
`int`	`getReadingsLength()` Number of readings.
`int`	`getStartPos()`
`String`	`getToken()`
`int`	`hashCode()`
`boolean`	`hasLemma(String lemma)` Checks if one of the token's readings has a particular lemma.
`boolean`	`hasPartialPosTag(String posTag)` Checks if the token has a particular POS tag, whereas only a part of the given POS tag needs to match.
`boolean`	`hasPosTag(String posTag)` Checks if the token has a particular POS tag.
`boolean`	`hasSameLemmas()` Used to optimize pattern matching.
`void`	`ignoreSpelling()` Make the token ignored by all spelling rules.
`void`	`immunize()`
`boolean`	`isFieldCode()`
`boolean`	`isIgnoredBySpeller()` Test if the token can be ignored by spelling rules.
`boolean`	`isImmunized()`
`boolean`	`isLinebreak()` Returns true if the token equals `\n`, `\r`, `\n\r`, or `\r\n`.
`boolean`	`isParagraphEnd()`
`boolean`	`isSentenceEnd()`
`boolean`	`isSentenceStart()`
`boolean`	`isTagged()`
`boolean`	`isWhitespace()`
`boolean`	`isWhitespaceBefore()`
`Iterator<AnalyzedToken>`	`iterator()`
`void`	`leaveReading(AnalyzedToken token)` Removes all readings but the one that matches the token given.
`boolean`	`matchesPosTagRegex(String posTagRegex)` Checks if at least one of the readings matches a given POS tag regex.
`void`	`removeReading(AnalyzedToken token)` Removes a reading from the list of readings.
`void`	`setChunkTags(List<ChunkTag> chunkTags)`
`void`	`setHistoricalAnnotations(String historicalAnnotations)` Used to track disambiguator actions.
`void`	`setParagraphEnd()` Add a reading with a paragraph end token unless this is already a paragraph end.
`void`	`setSentEnd()` Add a SENT_END tag.
`void`	`setStartPos(int position)`
`void`	`setWhitespaceBefore(boolean isWhiteSpaceBefore)`
`String`	`toString()`

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

- Constructor Detail
  - AnalyzedTokenReadings
```
public AnalyzedTokenReadings(AnalyzedToken[] tokens,
                     int startPos)
```
  - AnalyzedTokenReadings
```
public AnalyzedTokenReadings(AnalyzedToken token,
                     int startPos)
```
  - AnalyzedTokenReadings
```
public AnalyzedTokenReadings(List<AnalyzedToken> tokens,
                     int startPos)
```
- Method Detail
  - getReadings
```
public List<AnalyzedToken> getReadings()
```
  - getAnalyzedToken
```
public AnalyzedToken getAnalyzedToken(int idx)
```
    Get a token reading.
    
    See Also:
    getReadingsLength() for how many token readings there are
  - hasPosTag
```
public boolean hasPosTag(String posTag)
```
    Checks if the token has a particular POS tag.
    
    Parameters:
    posTag - POS tag to look for
  - hasLemma
```
public boolean hasLemma(String lemma)
```
    Checks if one of the token's readings has a particular lemma.
    
    Parameters:
    lemma - lemma POS tag to look for
  - hasPartialPosTag
```
public boolean hasPartialPosTag(String posTag)
```
    Checks if the token has a particular POS tag, whereas only a part of the given POS tag needs to match.
    
    Parameters:
    posTag - POS tag substring to look for
    Since:
    
    1.8
  - matchesPosTagRegex
```
public boolean matchesPosTagRegex(String posTagRegex)
```
    Checks if at least one of the readings matches a given POS tag regex.
    
    Parameters:
    posTagRegex - POS tag regular expression to look for
    Since:
    
    2.9
  - addReading
```
public void addReading(AnalyzedToken token)
```
    Add a new reading.
    
    Parameters:
    token - new reading, given as AnalyzedToken
  - removeReading
```
public void removeReading(AnalyzedToken token)
```
    Removes a reading from the list of readings. Note: if the token has only one reading, then a new reading with an empty POS tag and an empty lemma is created.
    
    Parameters:
    token - reading to be removed
  - leaveReading
```
public void leaveReading(AnalyzedToken token)
```
    Removes all readings but the one that matches the token given.
    
    Parameters:
    token - Token to be matched
    Since:
    
    1.5
  - getReadingsLength
```
public int getReadingsLength()
```
    Number of readings.
  - isWhitespace
```
public boolean isWhitespace()
```
  - isLinebreak
```
public boolean isLinebreak()
```
    Returns true if the token equals \n, \r, \n\r, or \r\n.
  - isSentenceStart
```
public boolean isSentenceStart()
```
    Since:
    
    2.3
  - isParagraphEnd
```
public boolean isParagraphEnd()
```
    Returns:
    true when the token is a last token in a paragraph.
    Since:
    
    2.3
  - setParagraphEnd
```
public void setParagraphEnd()
```
    Add a reading with a paragraph end token unless this is already a paragraph end.
    
    Since:
    
    2.3
  - isSentenceEnd
```
public boolean isSentenceEnd()
```
    Returns:
    true when the token is a last token in a sentence.
    Since:
    
    2.3
  - isFieldCode
```
public boolean isFieldCode()
```
    Returns:
    true if the token is LibreOffice/OpenOffice field code.
    Since:
    
    0.9.9
  - setSentEnd
```
public void setSentEnd()
```
    Add a SENT_END tag.
  - getStartPos
```
public int getStartPos()
```
  - getEndPos
```
public int getEndPos()
```
    Since:
    
    2.9
  - setStartPos
```
public void setStartPos(int position)
```
  - getToken
```
public String getToken()
```
  - setWhitespaceBefore
```
public void setWhitespaceBefore(boolean isWhiteSpaceBefore)
```
  - isWhitespaceBefore
```
public boolean isWhitespaceBefore()
```
  - immunize
```
public void immunize()
```
  - isImmunized
```
public boolean isImmunized()
```
  - ignoreSpelling
```
public void ignoreSpelling()
```
    Make the token ignored by all spelling rules.
    
    Since:
    
    2.5
  - isIgnoredBySpeller
```
public boolean isIgnoredBySpeller()
```
    Test if the token can be ignored by spelling rules.
    
    Returns:
    true if the token should be ignored.
    Since:
    
    2.5
  - getHistoricalAnnotations
```
public String getHistoricalAnnotations()
```
    Used to track disambiguator actions.
    
    Returns:
    the historicalAnnotations
  - setHistoricalAnnotations
```
public void setHistoricalAnnotations(String historicalAnnotations)
```
    Used to track disambiguator actions.
    
    Parameters:
    historicalAnnotations - the historicalAnnotations to set
  - setChunkTags
```
public void setChunkTags(List<ChunkTag> chunkTags)
```
    Since:
    
    2.3
  - getChunkTags
```
public List<ChunkTag> getChunkTags()
```
    Since:
    
    2.3
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - isTagged
```
public boolean isTagged()
```
    Returns:
    true if AnalyzedTokenReadings has some real POS tag (= not null or a special tag)
    Since:
    
    2.3
  - hasSameLemmas
```
public boolean hasSameLemmas()
```
    Used to optimize pattern matching.
    
    Returns:
    true if all AnalyzedToken lemmas are the same.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - iterator
```
public Iterator<AnalyzedToken> iterator()
```
    Specified by:
    
    iterator in interface Iterable<AnalyzedToken>
    
    Since:
    
    2.3

Class AnalyzedTokenReadings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AnalyzedTokenReadings

AnalyzedTokenReadings

AnalyzedTokenReadings

Method Detail

getReadings

getAnalyzedToken

hasPosTag

hasLemma

hasPartialPosTag

matchesPosTagRegex

addReading

removeReading

leaveReading

getReadingsLength

isWhitespace

isLinebreak

isSentenceStart

isParagraphEnd

setParagraphEnd

isSentenceEnd

isFieldCode

setSentEnd

getStartPos

getEndPos

setStartPos

getToken

setWhitespaceBefore

isWhitespaceBefore

immunize

isImmunized

ignoreSpelling

isIgnoredBySpeller

getHistoricalAnnotations

setHistoricalAnnotations

setChunkTags

getChunkTags

toString

isTagged

hasSameLemmas

hashCode

equals

iterator