Package org.languagetool.rules.patterns
Class PatternToken
java.lang.Object
org.languagetool.rules.patterns.PatternToken
- All Implemented Interfaces:
Cloneable
A part of a pattern, represents the 'token' element of the
grammar.xml
.-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final List<PatternToken>
private static final String
Parameter passed to regular expression matcher to enable case insensitive Unicode matching.private final boolean
private ChunkTag
private List<PatternToken>
List of exceptions that are valid for the current token and / or some next tokens.private boolean
True if any exception with a scope=="current" or scope=="next" is set for the element.private boolean
True if scope=="next".private boolean
True if attribute scope=="previous".private final boolean
private boolean
private boolean
Set to true on tokens that close the unification block.private int
private int
private boolean
private final List<PatternToken>
private Pattern
private String
String ID of the phrase the element is in.private PatternToken.PosToken
private List<PatternToken>
List of exceptions that are valid for a previous token.private String
True when the element stores a formatted reference to another element of the pattern.private int
private final boolean
private String
private boolean
This var is used to determine if callingsetStringElement(java.lang.String)
makes sense.private boolean
private Match
The reference to another element in the pattern.private boolean
Determines whether the element should be ignored when doing unificationprivate boolean
static final String
Matches only tokens without any POS tag.private boolean
-
Constructor Summary
ConstructorsConstructorDescriptionPatternToken
(String token, boolean caseSensitive, boolean regExp, boolean inflected) Creates Element that is used to match tokens in the text. -
Method Summary
Modifier and TypeMethodDescriptionclone()
compile
(AnalyzedTokenReadings token, Synthesizer synth) Prepare PatternToken for matching by formatting its string token and POS (if the Element is supposed to refer to some other token).private void
doCompile
(AnalyzedTokenReadings token, Synthesizer synth) Returns the group of elements linked with AND operator.@Nullable ChunkTag
getMatch()
int
The maximum number of times the element may occur.int
The minimum number of times the element needs to occur.boolean
Returns the group of elements linked with OR operator.@Nullable String
Gets the phrase the element is in.boolean
@Nullable String
int
Gets the exception scope length.@Nullable String
private String
getTestToken
(AnalyzedToken token) Get unification features and types.boolean
Checks if this element has an AND group associated with it.boolean
boolean
Checks if the element has an exception for a next scope.boolean
Checks if this element has an OR group associated with it.boolean
Checks if the element has an exception for a previous token.boolean
Enables testing multiple conditions specified by multiple element exceptions.boolean
Whether the element matches case sensitively.boolean
isExceptionMatched
(AnalyzedToken token) Checks whether an exception matches.boolean
This method checks exceptions both in AND-group and the token.boolean
boolean
boolean
boolean
isMatched
(AnalyzedToken token) Checks whether the rule element matches the token given as a parameter.boolean
Checks whether an exception for a previous token matches (in case the exception had scope == "previous").boolean
Checks whether an exception for a previous token matches all readings of a given token (in case the exception had scope == "previous").boolean
Checks whether a previously set exception matches (in case the exception had scope == "next").boolean
Checks if the Element is in any phrase.boolean
Tests whether the POS matches a regular expression.private boolean
isPosTokenMatched
(AnalyzedToken token) Tests if part of speech matches a given string.boolean
boolean
Tests whether the element matches a regular expression.boolean
Checks if the token is a sentence start.private boolean
Tests whether the string token element matches a given token.boolean
Determines whether the element should be silently ignored during unification, and simply added.boolean
boolean
boolean
isWhitespaceBefore
(AnalyzedToken token) void
setAndGroupElement
(PatternToken andToken) void
setChunkTag
(ChunkTag chunkTag) private void
setException
(PatternToken pToken, boolean scopePrevious) void
setExceptionSpaceBefore
(boolean isWhite) Sets the attribute on the exception that determines matching of patterns that depends on whether there was a space before the token matching the exception or not.void
setInsideMarker
(boolean isInsideMarker) void
void
Sets the reference to another token.void
setMaxOccurrence
(int i) The maximum number of times this element may occur.void
setMinOccurrence
(int i) The minimum number of times this element may occur.void
setNegation
(boolean negation) Negates the matching so that non-matching elements match and vice-versa.void
setOrGroupElement
(PatternToken orToken) void
setPhraseName
(String id) Sets the phrase the element is in.void
setPosToken
(PatternToken.PosToken posToken) void
setSkipNext
(int i) void
setStringElement
(String token) void
setStringPosException
(String token, boolean regExp, boolean inflected, boolean negation, boolean scopeNext, boolean scopePrevious, String posToken, boolean posRegExp, boolean posNegation, Boolean caseSensitivity) Sets a string and/or pos exception for matching tokens.void
setUnification
(Map<String, List<String>> uniFeatures) void
Sets the element as ignored during unification.void
void
setWhitespaceBefore
(boolean isWhite) toString()
-
Field Details
-
UNKNOWN_TAG
Matches only tokens without any POS tag.- See Also:
-
CASE_INSENSITIVE
Parameter passed to regular expression matcher to enable case insensitive Unicode matching.- See Also:
-
caseSensitive
private final boolean caseSensitive -
stringRegExp
private final boolean stringRegExp -
andGroupList
-
orGroupList
-
inflected
private final boolean inflected -
stringToken
-
posToken
-
chunkTag
-
negation
private boolean negation -
testWhitespace
private boolean testWhitespace -
whitespaceBefore
private boolean whitespaceBefore -
isInsideMarker
private boolean isInsideMarker -
exceptionList
List of exceptions that are valid for the current token and / or some next tokens. -
exceptionValidNext
private boolean exceptionValidNextTrue if scope=="next". -
exceptionSet
private boolean exceptionSetTrue if any exception with a scope=="current" or scope=="next" is set for the element. -
exceptionValidPrevious
private boolean exceptionValidPreviousTrue if attribute scope=="previous". -
previousExceptionList
List of exceptions that are valid for a previous token. -
skip
private int skip -
minOccurrence
private int minOccurrence -
maxOccurrence
private int maxOccurrence -
pattern
-
tokenReference
The reference to another element in the pattern. -
referenceString
True when the element stores a formatted reference to another element of the pattern. -
phraseName
String ID of the phrase the element is in. -
testString
private boolean testStringThis var is used to determine if callingsetStringElement(java.lang.String)
makes sense. This method takes most time so it's best to reduce the number of its calls. -
unificationNeutral
private boolean unificationNeutralDetermines whether the element should be ignored when doing unification -
uniNegation
private boolean uniNegation -
unificationFeatures
-
isLastUnified
private boolean isLastUnifiedSet to true on tokens that close the unification block.
-
-
Constructor Details
-
PatternToken
Creates Element that is used to match tokens in the text.- Parameters:
token
- String to be matchedcaseSensitive
- true if the check is case-sensitiveregExp
- true if the check uses regular expressionsinflected
- true if the check refers to base forms (lemmas), note thattoken
must be a base form for this to work
-
-
Method Details
-
clone
- Overrides:
clone
in classObject
- Throws:
CloneNotSupportedException
-
isMatched
Checks whether the rule element matches the token given as a parameter.- Parameters:
token
- AnalyzedToken to check matching against- Returns:
- True if token matches, false otherwise.
-
isExceptionMatched
Checks whether an exception matches.- Parameters:
token
- AnalyzedToken to check matching against- Returns:
- True if any of the exceptions matches (logical disjunction).
-
isAndExceptionGroupMatched
Enables testing multiple conditions specified by multiple element exceptions. Works as logical AND operator.- Parameters:
token
- the token checked for exceptions.- Returns:
- true if all conditions are met, false otherwise.
-
isExceptionMatchedCompletely
This method checks exceptions both in AND-group and the token. Introduced to for clarity.- Parameters:
token
- Token to match- Returns:
- True if matched.
-
setAndGroupElement
-
hasAndGroup
public boolean hasAndGroup()Checks if this element has an AND group associated with it.- Returns:
- true if the element has a group of elements that all should match.
-
getAndGroup
Returns the group of elements linked with AND operator. -
setOrGroupElement
- Since:
- 2.3
-
hasOrGroup
public boolean hasOrGroup()Checks if this element has an OR group associated with it.- Returns:
- true if the element has a group of elements that all should match.
- Since:
- 2.3
-
getOrGroup
Returns the group of elements linked with OR operator.- Since:
- 2.3
-
isMatchedByScopeNextException
Checks whether a previously set exception matches (in case the exception had scope == "next").- Parameters:
token
-AnalyzedToken
to check matching against.- Returns:
- True if any of the exceptions matches.
-
isMatchedByPreviousException
Checks whether an exception for a previous token matches (in case the exception had scope == "previous").- Parameters:
token
-AnalyzedToken
to check matching against.- Returns:
- True if any of the exceptions matches.
-
isMatchedByPreviousException
Checks whether an exception for a previous token matches all readings of a given token (in case the exception had scope == "previous").- Parameters:
prevToken
-AnalyzedTokenReadings
to check matching against.- Returns:
- true if any of the exceptions matches.
-
isSentenceStart
public boolean isSentenceStart()Checks if the token is a sentence start.- Returns:
- True if the element starts the sentence and the element hasn't been set to have negated POS token.
-
setPosToken
- Since:
- 2.9
-
setChunkTag
- Since:
- 2.9
-
getString
-
setStringElement
-
setStringPosException
public void setStringPosException(String token, boolean regExp, boolean inflected, boolean negation, boolean scopeNext, boolean scopePrevious, String posToken, boolean posRegExp, boolean posNegation, Boolean caseSensitivity) Sets a string and/or pos exception for matching tokens.- Parameters:
token
- The string in the exception.regExp
- True if the string is specified as a regular expression.inflected
- True if the string is a base form (lemma).negation
- True if the exception is negated.scopeNext
- True if the exception scope is next tokens.scopePrevious
- True if the exception should match only a single previous token.posToken
- The part of the speech tag in the exception.posRegExp
- True if the POS is specified as a regular expression.posNegation
- True if the POS exception is negated.caseSensitivity
- if null, use this element's setting for case sensitivity, otherwise the specified value- Since:
- 2.9
-
setException
-
isPosTokenMatched
Tests if part of speech matches a given string. Special value UNKNOWN_TAG matches null POS tags.- Parameters:
token
- Token to test.- Returns:
- true if matches
-
isStringTokenMatched
Tests whether the string token element matches a given token.- Parameters:
token
-AnalyzedToken
to match against.- Returns:
- True if matches.
-
getTestToken
-
getSkipNext
public int getSkipNext()Gets the exception scope length.- Returns:
- scope length in tokens
-
getMinOccurrence
public int getMinOccurrence()The minimum number of times the element needs to occur. -
getMaxOccurrence
public int getMaxOccurrence()The maximum number of times the element may occur. -
setSkipNext
public void setSkipNext(int i) - Parameters:
i
- exception scope length.
-
setMinOccurrence
public void setMinOccurrence(int i) The minimum number of times this element may occur.- Parameters:
i
- currently only0
and1
are supported
-
setMaxOccurrence
public void setMaxOccurrence(int i) The maximum number of times this element may occur.- Parameters:
i
- a number >= 1 or-1
for unlimited occurrences
-
hasPreviousException
public boolean hasPreviousException()Checks if the element has an exception for a previous token.- Returns:
- True if the element has a previous token matching exception.
-
hasNextException
public boolean hasNextException()Checks if the element has an exception for a next scope. (only used for testing)- Returns:
- True if the element has exception for the next scope.
-
setNegation
public void setNegation(boolean negation) Negates the matching so that non-matching elements match and vice-versa. -
getNegation
public boolean getNegation()- Since:
- 0.9.3
-
isReferenceElement
public boolean isReferenceElement()- Returns:
- true when this element refers to another token.
-
setMatch
Sets the reference to another token.- Parameters:
match
- Formatting object for the token reference.
-
getMatch
-
compile
Prepare PatternToken for matching by formatting its string token and POS (if the Element is supposed to refer to some other token).- Parameters:
token
- the token specified asAnalyzedTokenReadings
synth
- the language synthesizer (Synthesizer
)- Throws:
IOException
-
doCompile
- Throws:
IOException
-
setPhraseName
Sets the phrase the element is in.- Parameters:
id
- ID of the phrase.
-
isPartOfPhrase
public boolean isPartOfPhrase()Checks if the Element is in any phrase.- Returns:
- True if the Element is contained in the phrase.
-
isCaseSensitive
public boolean isCaseSensitive()Whether the element matches case sensitively.- Since:
- 2.3
-
isRegularExpression
public boolean isRegularExpression()Tests whether the element matches a regular expression.- Since:
- 0.9.6
-
isPOStagRegularExpression
public boolean isPOStagRegularExpression()Tests whether the POS matches a regular expression.- Since:
- 1.3.0
-
getPOStag
- Returns:
- the POS of the Element or
null
- Since:
- 0.9.6
-
getChunkTag
- Returns:
- the chunk tag of the Element or
null
- Since:
- 2.3
-
getPOSNegation
public boolean getPOSNegation()- Returns:
- true if the POS is negated.
-
isInflected
public boolean isInflected()- Returns:
- true if the token matches all inflected forms
-
getPhraseName
Gets the phrase the element is in.- Returns:
- String The name of the phrase.
-
isUnified
public boolean isUnified() -
setUnification
-
getUniFeatures
Get unification features and types.- Returns:
- A map from features to a list of types or
null
- Since:
- 1.0.1
-
setUniNegation
public void setUniNegation() -
isUniNegated
public boolean isUniNegated() -
isLastInUnification
public boolean isLastInUnification() -
setLastInUnification
public void setLastInUnification() -
isUnificationNeutral
public boolean isUnificationNeutral()Determines whether the element should be silently ignored during unification, and simply added.- Returns:
- True when the element is not included in unifying.
- Since:
- 2.5
-
setUnificationNeutral
public void setUnificationNeutral()Sets the element as ignored during unification.- Since:
- 2.5
-
setWhitespaceBefore
public void setWhitespaceBefore(boolean isWhite) -
isInsideMarker
public boolean isInsideMarker() -
setInsideMarker
public void setInsideMarker(boolean isInsideMarker) -
setExceptionSpaceBefore
public void setExceptionSpaceBefore(boolean isWhite) Sets the attribute on the exception that determines matching of patterns that depends on whether there was a space before the token matching the exception or not. The same procedure is used for tokens that are valid for previous or current tokens.- Parameters:
isWhite
- If true, the space before exception is required.
-
isWhitespaceBefore
-
getExceptionList
- Returns:
- A List of Exceptions. Used for testing.
- Since:
- 1.0.0
-
getPreviousExceptionList
- Returns:
- List of previous exceptions. Used for testing.
-
hasExceptionList
public boolean hasExceptionList() -
toString
-