eu.cqse.check.framework.util.tokens

Class TokenPatternMatch

java.lang.Object

eu.cqse.check.framework.util.tokens.TokenPatternMatch

public class TokenPatternMatch
extends java.lang.Object

A single match created by a TokenPattern. Keeps track of any groups that have been matched by parts of the pattern. A group is identified by an arbitrary integer. See also TokenPattern.group(int). Multiple segments of the tokenStream can be associated with the same group. In this case, getMatchGroup(int) will return multiple MatchGroupElements for the group.

Constructor Summary

Constructors

Constructor and Description
TokenPatternMatch(java.util.List<IToken> tokenStream) Constructor.

Method Summary

Modifier and Type	Method and Description
void	appendToGroup(java.lang.Integer groupIndex, int inclusiveStartIndex, int exclusiveEndIndex) Appends the given tokens to the group with the given index if the given range contains at least one token.
static java.util.List<java.lang.String>	getAllStrings(java.util.List<TokenPatternMatch> matches, int groupIndex) Returns a list of all group strings in all matches of the group with the given index.
static java.util.List<IToken>	getAllTokens(java.util.List<TokenPatternMatch> matches, int groupIndex) Returns a list of all group tokens in all matches of the group with the given index.
java.util.List<MatchGroupElement>	getMatchGroup(int groupIndex) Returns the TokenStream parts matched in this group.
java.util.List<java.lang.Integer>	groupIndices(int groupIndex) Returns the indices into the token stream in the given group or an empty list.
java.lang.String	groupString(int groupIndex) Returns the concatenated text of the tokens in the given group.
java.util.List<java.lang.String>	groupTexts(int groupIndex) Returns the text of the tokens in the given group.
java.util.List<IToken>	groupTokens(int groupIndex) Returns the tokens in the given group or an empty list.
boolean	hasGroup(int groupIndex) Returns true if the match contains tokens in the given group.
void	mergeFrom(TokenPatternMatch other) Merges the group information from given match into this match.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TokenPatternMatch

public TokenPatternMatch(java.util.List<IToken> tokenStream)

Constructor.

Method Detail

appendToGroup

public void appendToGroup(java.lang.Integer groupIndex,
                          int inclusiveStartIndex,
                          int exclusiveEndIndex)

Appends the given tokens to the group with the given index if the given range contains at least one token.

groupTexts

public java.util.List<java.lang.String> groupTexts(int groupIndex)

Returns the text of the tokens in the given group. All MatchGroupElements for the given group will be concatenated.

groupIndices

public java.util.List<java.lang.Integer> groupIndices(int groupIndex)

Returns the indices into the token stream in the given group or an empty list. All MatchGroupElements for the given group will be concatenated.

groupTokens

public java.util.List<IToken> groupTokens(int groupIndex)

Returns the tokens in the given group or an empty list. All MatchGroupElements for the given group will be concatenated.

getMatchGroup

public java.util.List<MatchGroupElement> getMatchGroup(int groupIndex)

Returns the TokenStream parts matched in this group. Each part is represented by a MatchGroupElement and can contain multiple ITokens, depending on the used pattern.

groupString

public java.lang.String groupString(int groupIndex)

Returns the concatenated text of the tokens in the given group. All MatchGroupElements for the given group will be concatenated.If the group was not matched, returns the empty string.

hasGroup

public boolean hasGroup(int groupIndex)

Returns true if the match contains tokens in the given group.

mergeFrom

public void mergeFrom(TokenPatternMatch other)

Merges the group information from given match into this match.

getAllStrings

public static java.util.List<java.lang.String> getAllStrings(java.util.List<TokenPatternMatch> matches,
                                                             int groupIndex)

Returns a list of all group strings in all matches of the group with the given index.

getAllTokens

public static java.util.List<IToken> getAllTokens(java.util.List<TokenPatternMatch> matches,
                                                  int groupIndex)

Returns a list of all group tokens in all matches of the group with the given index.