de.danielnaber.languagetool.rules.patterns
Class Element

Object
  Element

public class Element
extends Object

A part of a pattern.

Author:

Daniel Naber

Constructor Summary

Element(String token, boolean caseSensitive, boolean regExp, boolean inflected)

Method Summary

boolean	checkAndGroup(boolean previousValue)
void	compile(AnalyzedTokenReadings token, Synthesizer synth) Prepare Element for matching by formatting its string token and POS (if the Element is supposed to refer to some other token).
ArrayList<Element>	getAndGroup() Returns the group of elements linked with AND operator.
boolean	getCaseSensitive() Whether the element matches case sensitively.
Match	getMatch()
boolean	getNegation() see setNegation(boolean)
String	getPhraseName() Gets the phrase the element is in.
int	getSkipNext() Gets the exception scope length.
String	getString()
boolean	hasAndGroup() Checks if this element has an AND group associated with it.
boolean	hasPreviousException() Checks if the element has an exception for a previous token.
boolean	isAndExceptionGroupMatched(AnalyzedToken token) Enables testing multiple conditions specified by multiple element exceptions.
boolean	isAndGroupMatched(AnalyzedToken token) Enables testing multiple conditions specified by different elements.
boolean	isExceptionMatched(AnalyzedToken token) Checks whether an exception matches.
boolean	isExceptionMatchedCompletely(AnalyzedToken token) This method checks exceptions both in AND-group and the token.
boolean	isMatched(AnalyzedToken token) Checks whether the rule element matches the token given as a parameter.
boolean	isMatchedByScopeNextException(AnalyzedToken token) Checks whether a previously set exception matches (in case the exception had scope == "next").
boolean	isMatchedByScopePreviousException(AnalyzedToken token) Checks whether an exception for a previous token matches (in case the exception had scope == "previous").
boolean	isMatchedCompletely(AnalyzedToken token) This method checks AND-group and the token.
boolean	isPartOfPhrase() Checks if the Element is in any phrase.
boolean	isReferenceElement()
boolean	isSentStart() Checks if the token is a SENT_START.
void	setAndGroupElement(Element andToken)
void	setMatch(Match match) Sets the reference to another token.
void	setNegation(boolean negation) Negates the meaning of match().
void	setPhraseName(String s) Sets the phrase the element is in.
void	setPosElement(String posToken, boolean regExp, boolean negation)
void	setPosException(String posToken, boolean regExp, boolean negation, boolean scopeNext, boolean scopePrevious) Sets a POS-type exception for matching string tokens.
void	setSkipNext(int i) Sets the exception scope length.
void	setStringElement(String token)
void	setStringException(String token, boolean regExp, boolean inflected, boolean negation, boolean scopeNext, boolean scopePrevious) Sets a string-type exception for matching string tokens.
void	setupAndGroup()
String	toString()

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Element

public Element(String token,
               boolean caseSensitive,
               boolean regExp,
               boolean inflected)

Method Detail

isMatched

public final boolean isMatched(AnalyzedToken token)

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

public final boolean isExceptionMatched(AnalyzedToken token)

Checks whether an exception matches.

Parameters:

token - @AnalyzedToken to check matching against

Returns:

True if any of the exceptions matches (logical disjunction).

isAndGroupMatched

public final boolean isAndGroupMatched(AnalyzedToken token)

Enables testing multiple conditions specified by different elements. Doesn't test exceptions. Works as logical AND operator only if preceded with setupAndGroup(), and followed by checkAndGroup(boolean).

Parameters:

token - AnalyzedToken - the token checked.

Returns:

true if any condition is met, false otherwise.

setupAndGroup

public final void setupAndGroup()

checkAndGroup

public final boolean checkAndGroup(boolean previousValue)

isMatchedCompletely

public final boolean isMatchedCompletely(AnalyzedToken token)

This method checks AND-group and the token. Introduced to for clarity.

Parameters:

token - Token to match

Returns:

True if matched.

isAndExceptionGroupMatched

public final boolean isAndExceptionGroupMatched(AnalyzedToken token)

Enables testing multiple conditions specified by multiple element exceptions. Works as logical AND operator.

Parameters:

token - AnalyzedToken - the token checked for exceptions.

Returns:

true if all conditions are met, false otherwise.

isExceptionMatchedCompletely

public final boolean isExceptionMatchedCompletely(AnalyzedToken token)

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

public final void setAndGroupElement(Element andToken)

hasAndGroup

public final 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

public final ArrayList<Element> getAndGroup()

Returns the group of elements linked with AND operator.

Returns:

List of Elements.

isMatchedByScopeNextException

public final boolean isMatchedByScopeNextException(AnalyzedToken token)

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.

isMatchedByScopePreviousException

public final boolean isMatchedByScopePreviousException(AnalyzedToken token)

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.

isSentStart

public final boolean isSentStart()

Checks if the token is a SENT_START.

Returns:

True if the token starts the sentence.

toString

public final String toString()

Overrides:

toString in class Object

setPosElement

public final void setPosElement(String posToken,
                                boolean regExp,
                                boolean negation)

getString

public final String getString()

setStringElement

public final void setStringElement(String token)

setPosException

public final void setPosException(String posToken,
                                  boolean regExp,
                                  boolean negation,
                                  boolean scopeNext,
                                  boolean scopePrevious)

Sets a POS-type exception for matching string tokens.

Parameters:

posToken - The part of the speech tag in the exception.

regExp - True if the POS is specified as a regular expression.

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.

setStringException

public final void setStringException(String token,
                                     boolean regExp,
                                     boolean inflected,
                                     boolean negation,
                                     boolean scopeNext,
                                     boolean scopePrevious)

Sets a string-type exception for matching string 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.

getSkipNext

public final int getSkipNext()

Gets the exception scope length.

Returns:

@int Scope length.

setSkipNext

public final void setSkipNext(int i)

Sets the exception scope length.

Parameters:

i - @int Exception scope length.

hasPreviousException

public final boolean hasPreviousException()

Checks if the element has an exception for a previous token.

Returns:

True if the element has a previous token matching exception.

setNegation

public final void setNegation(boolean negation)

Negates the meaning of match().

Parameters:

negation - - true if the meaning of match() is to be negated.

getNegation

public final boolean getNegation()

see setNegation(boolean)

Since:

0.9.3

isReferenceElement

public final boolean isReferenceElement()

Returns:

true when this element refers to another token.

setMatch

public final void setMatch(Match match)

Sets the reference to another token.

Parameters:

match - Formatting object for the token reference.

getMatch

public final Match getMatch()

compile

public final void compile(AnalyzedTokenReadings token,
                          Synthesizer synth)

Prepare Element for matching by formatting its string token and POS (if the Element is supposed to refer to some other token).

Parameters:

token - @AnalyzedTokenReadings - the token synth @Syntesizer - the language synthesizer

setPhraseName

public final void setPhraseName(String s)

Sets the phrase the element is in.

Parameters:

s - ID of the phrase.

isPartOfPhrase

public final boolean isPartOfPhrase()

Checks if the Element is in any phrase.

Returns:

True if the Element is contained in the phrase.

getCaseSensitive

public final boolean getCaseSensitive()

Whether the element matches case sensitively.

Since:

0.9.3

getPhraseName

public final String getPhraseName()

Gets the phrase the element is in.

Returns:

String The name of the phrase.