BasicSequenceMatchResult (Stanford CoreNLP API)

java.lang.Object
- edu.stanford.nlp.ling.tokensregex.BasicSequenceMatchResult<T>

All Implemented Interfaces:

SequenceMatchResult<T>, HasInterval<Integer>, MatchResult

Direct Known Subclasses:

SequenceMatcher
```
public class BasicSequenceMatchResult<T>
extends Object
implements SequenceMatchResult<T>
```
Basic results for a Sequence Match

Author:

Angel Chang

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class BasicSequenceMatchResult.MatchedGroup
- Nested classes/interfaces inherited from interface edu.stanford.nlp.ling.tokensregex.SequenceMatchResult
  SequenceMatchResult.GroupToIntervalFunc<MR extends MatchResult>, SequenceMatchResult.MatchedGroupInfo<T>

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`BasicSequenceMatchResult.MatchedGroup`

Field Summary
- Fields inherited from interface edu.stanford.nlp.ling.tokensregex.SequenceMatchResult
  DEFAULT_COMPARATOR, GROUP_AFTER_MATCH, GROUP_BEFORE_MATCH, LENGTH_COMPARATOR, OFFSET_COMPARATOR, ORDER_COMPARATOR, PRIORITY_COMPARATOR, PRIORITY_SCORE_LENGTH_ORDER_OFFSET_COMPARATOR, SCORE_COMPARATOR, SCORER, TO_INTERVAL
- Fields inherited from interface edu.stanford.nlp.util.HasInterval
  CONTAINS_FIRST_ENDPOINTS_COMPARATOR, ENDPOINTS_COMPARATOR, LENGTH_ENDPOINTS_COMPARATOR, NESTED_FIRST_ENDPOINTS_COMPARATOR

Constructor Summary

Constructors
Constructor and Description

BasicSequenceMatchResult()

Constructors
Constructor and Description
`BasicSequenceMatchResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BasicSequenceMatchResult<T>`	`copy()`
`List<? extends T>`	`elements()` Returns the original sequence the match was performed on.
`int`	`end()`
`int`	`end(int group)`
`int`	`end(String var)` Returns the index of the next element after the subsequence captured by the given group during this match.
`Interval<Integer>`	`getInterval()` Returns the interval
`int`	`getOrder()`
`String`	`group()`
`String`	`group(int group)`
`String`	`group(String var)` Returns the `String` representing the matched group.
`int`	`groupCount()`
`SequenceMatchResult.MatchedGroupInfo<T>`	`groupInfo()`
`SequenceMatchResult.MatchedGroupInfo<T>`	`groupInfo(int group)`
`SequenceMatchResult.MatchedGroupInfo<T>`	`groupInfo(String var)`
`Object`	`groupMatchResult(int group, int index)` Returns an Object representing the result for the match for a particular node in a group.
`Object`	`groupMatchResult(String var, int index)` Returns an Object representing the result for the match for a particular node in a group.
`List<Object>`	`groupMatchResults()` Returns a list of Objects representing the match results for the entire sequence.
`List<Object>`	`groupMatchResults(int group)` Returns a list of Objects representing the match results for the nodes in the group.
`List<Object>`	`groupMatchResults(String var)` Returns a list of Objects representing the match results for the nodes in the group.
`List<T>`	`groupNodes()` Returns the entire matched subsequence as a list.
`List<T>`	`groupNodes(int group)` Returns the matched group as a list.
`List<? extends T>`	`groupNodes(String var)` Returns the matched group as a list.
`Object`	`groupValue()` Returns the value (some Object) associated with the entire matched sequence.
`Object`	`groupValue(int group)` Returns the value (some Object) associated with the captured group.
`Object`	`groupValue(String var)` Returns the value (some Object) associated with the captured group.
`Object`	`nodeMatchResult(int index)` Returns an Object representing the result for the match for a particular node.
`SequencePattern<T>`	`pattern()` Returns pattern used to create this sequence match result
`double`	`priority()`
`double`	`score()`
`void`	`setOrder(int order)`
`int`	`start()`
`int`	`start(int group)`
`int`	`start(String var)` Returns the start index of the subsequence captured by the given group during this match.
`BasicSequenceMatchResult<T>`	`toBasicSequenceMatchResult()`

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

- Constructor Detail
  - BasicSequenceMatchResult
```
public BasicSequenceMatchResult()
```
- Method Detail
  - elements
```
public List<? extends T> elements()
```
    Description copied from interface: SequenceMatchResult
    
    Returns the original sequence the match was performed on.
    
    Specified by:
    
    elements in interface SequenceMatchResult<T>
    
    Returns:
    
    The list that the match was performed on
  - pattern
```
public SequencePattern<T> pattern()
```
    Description copied from interface: SequenceMatchResult
    
    Returns pattern used to create this sequence match result
    
    Specified by:
    
    pattern in interface SequenceMatchResult<T>
    
    Returns:
    
    the SequencePattern against which this sequence match result was matched
  - toBasicSequenceMatchResult
```
public BasicSequenceMatchResult<T> toBasicSequenceMatchResult()
```
    Specified by:
    
    toBasicSequenceMatchResult in interface SequenceMatchResult<T>
  - copy
```
public BasicSequenceMatchResult<T> copy()
```
  - getInterval
```
public Interval<Integer> getInterval()
```
    Description copied from interface: HasInterval
    
    Returns the interval
    
    Specified by:
    
    getInterval in interface HasInterval<Integer>
    
    Returns:
    
    interval
  - getOrder
```
public int getOrder()
```
    Specified by:
    
    getOrder in interface SequenceMatchResult<T>
  - setOrder
```
public void setOrder(int order)
```
  - priority
```
public double priority()
```
    Specified by:
    
    priority in interface SequenceMatchResult<T>
  - score
```
public double score()
```
    Specified by:
    
    score in interface SequenceMatchResult<T>
  - start
```
public int start()
```
    Specified by:
    
    start in interface MatchResult
  - start
```
public int start(int group)
```
    Specified by:
    
    start in interface MatchResult
  - start
```
public int start(String var)
```
    Description copied from interface: SequenceMatchResult
    
    Returns the start index of the subsequence captured by the given group during this match.
    
    Specified by:
    
    start in interface SequenceMatchResult<T>
    
    Parameters:
    
    var - The name of the capturing group in this matcher's pattern
    
    Returns:
    
    the index of the first element captured by the group, or -1 if the match was successful but the group itself did not match anything or if there is no capturing group in the pattern with the given name
  - end
```
public int end()
```
    Specified by:
    
    end in interface MatchResult
  - end
```
public int end(int group)
```
    Specified by:
    
    end in interface MatchResult
  - end
```
public int end(String var)
```
    Description copied from interface: SequenceMatchResult
    
    Returns the index of the next element after the subsequence captured by the given group during this match.
    
    Specified by:
    
    end in interface SequenceMatchResult<T>
    
    Parameters:
    
    var - The name of the capturing group in this matcher's pattern
    
    Returns:
    
    the index of the next element after the subsequence captured by the group, or -1 if the match was successful but the group itself did not match anything or if there is no capturing group in the pattern with the given name
  - group
```
public String group()
```
    Specified by:
    
    group in interface MatchResult
  - group
```
public String group(int group)
```
    Specified by:
    
    group in interface MatchResult
  - group
```
public String group(String var)
```
    Description copied from interface: SequenceMatchResult
    
    Returns the String representing the matched group.
    
    Specified by:
    
    group in interface SequenceMatchResult<T>
    
    Parameters:
    
    var - The name of the capturing group in this matcher's pattern
    
    Returns:
    
    the matched group as a String or null if there is no capturing group in the pattern with the given name
  - groupNodes
```
public List<T> groupNodes()
```
    Description copied from interface: SequenceMatchResult
    
    Returns the entire matched subsequence as a list.
    
    Specified by:
    
    groupNodes in interface SequenceMatchResult<T>
    
    Returns:
    
    the matched subsequence as a list
  - groupNodes
```
public List<T> groupNodes(int group)
```
    Description copied from interface: SequenceMatchResult
    
    Returns the matched group as a list.
    
    Specified by:
    
    groupNodes in interface SequenceMatchResult<T>
    
    Parameters:
    
    group - The index of a capturing group in this matcher's pattern
    
    Returns:
    
    the matched group as a list
  - groupNodes
```
public List<? extends T> groupNodes(String var)
```
    Description copied from interface: SequenceMatchResult
    
    Returns the matched group as a list.
    
    Specified by:
    
    groupNodes in interface SequenceMatchResult<T>
    
    Parameters:
    
    var - The name of the capturing group in this matcher's pattern
    
    Returns:
    
    the matched group as a list or null if there is no capturing group in the pattern with the given name
  - groupValue
```
public Object groupValue()
```
    Description copied from interface: SequenceMatchResult
    
    Returns the value (some Object) associated with the entire matched sequence.
    
    Specified by:
    
    groupValue in interface SequenceMatchResult<T>
    
    Returns:
    
    value associated with the matched sequence.
  - groupValue
```
public Object groupValue(int group)
```
    Description copied from interface: SequenceMatchResult
    
    Returns the value (some Object) associated with the captured group.
    
    Specified by:
    
    groupValue in interface SequenceMatchResult<T>
    
    Parameters:
    
    group - The index of a capturing group in this matcher's pattern
    
    Returns:
    
    value associated with the captured group.
  - groupValue
```
public Object groupValue(String var)
```
    Description copied from interface: SequenceMatchResult
    
    Returns the value (some Object) associated with the captured group.
    
    Specified by:
    
    groupValue in interface SequenceMatchResult<T>
    
    Parameters:
    
    var - The name of the capturing group in this matcher's pattern
    
    Returns:
    
    value associated with the captured group.
  - groupInfo
```
public SequenceMatchResult.MatchedGroupInfo<T> groupInfo()
```
    Specified by:
    
    groupInfo in interface SequenceMatchResult<T>
  - groupInfo
```
public SequenceMatchResult.MatchedGroupInfo<T> groupInfo(int group)
```
    Specified by:
    
    groupInfo in interface SequenceMatchResult<T>
  - groupInfo
```
public SequenceMatchResult.MatchedGroupInfo<T> groupInfo(String var)
```
    Specified by:
    
    groupInfo in interface SequenceMatchResult<T>
  - groupCount
```
public int groupCount()
```
    Specified by:
    
    groupCount in interface MatchResult
  - groupMatchResults
```
public List<Object> groupMatchResults()
```
    Description copied from interface: SequenceMatchResult
    
    Returns a list of Objects representing the match results for the entire sequence.
    
    Specified by:
    
    groupMatchResults in interface SequenceMatchResult<T>
    
    Returns:
    
    the list of match results associated with the entire sequence
  - groupMatchResults
```
public List<Object> groupMatchResults(int group)
```
    Description copied from interface: SequenceMatchResult
    
    Returns a list of Objects representing the match results for the nodes in the group.
    
    Specified by:
    
    groupMatchResults in interface SequenceMatchResult<T>
    
    Parameters:
    
    group - The index of a capturing group in this matcher's pattern
    
    Returns:
    
    the list of match results associated with the nodes for the captured group.
  - groupMatchResults
```
public List<Object> groupMatchResults(String var)
```
    Description copied from interface: SequenceMatchResult
    
    Returns a list of Objects representing the match results for the nodes in the group.
    
    Specified by:
    
    groupMatchResults in interface SequenceMatchResult<T>
    
    Parameters:
    
    var - The name of the capturing group in this matcher's pattern
    
    Returns:
    
    the list of match results associated with the nodes for the captured group.
  - nodeMatchResult
```
public Object nodeMatchResult(int index)
```
    Description copied from interface: SequenceMatchResult
    
    Returns an Object representing the result for the match for a particular node. (actual Object returned depends on the type T of the nodes. For instance, for a CoreMap, the match result is returned as a Map, while for String, the match result is typically a MatchResult.
    
    Specified by:
    
    nodeMatchResult in interface SequenceMatchResult<T>
    
    Parameters:
    
    index - The index of the element in the original sequence.
    
    Returns:
    
    the match result associated with the node at the given index.
  - groupMatchResult
```
public Object groupMatchResult(int group,
                               int index)
```
    Description copied from interface: SequenceMatchResult
    
    Returns an Object representing the result for the match for a particular node in a group. (actual Object returned depends on the type T of the nodes. For instance, for a CoreMap, the match result is returned as a Map, while for String, the match result is typically a MatchResult.
    
    Specified by:
    
    groupMatchResult in interface SequenceMatchResult<T>
    
    Parameters:
    
    group - The index of a capturing group in this matcher's pattern
    
    index - The index of the element in the captured subsequence.
    
    Returns:
    
    the match result associated with the node at the given index for the captured group.
  - groupMatchResult
```
public Object groupMatchResult(String var,
                               int index)
```
    Description copied from interface: SequenceMatchResult
    
    Returns an Object representing the result for the match for a particular node in a group. (actual Object returned depends on the type T of the nodes. For instance, for a CoreMap, the match result is returned as a Map, while for String, the match result is typically a MatchResult.
    
    Specified by:
    
    groupMatchResult in interface SequenceMatchResult<T>
    
    Parameters:
    
    var - The name of the capturing group in this matcher's pattern
    
    index - The index of the element in the captured subsequence.
    
    Returns:
    
    the match result associated with the node at the given index for the captured group.

Class BasicSequenceMatchResult<T>

Nested Class Summary

Nested classes/interfaces inherited from interface edu.stanford.nlp.ling.tokensregex.SequenceMatchResult

Field Summary

Fields inherited from interface edu.stanford.nlp.ling.tokensregex.SequenceMatchResult

Fields inherited from interface edu.stanford.nlp.util.HasInterval

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BasicSequenceMatchResult

Method Detail

elements

pattern

toBasicSequenceMatchResult

copy

getInterval

getOrder

setOrder

priority

score

start

start

start

end

end

end

group

group

group

groupNodes

groupNodes

groupNodes

groupValue

groupValue

groupValue

groupInfo

groupInfo

groupInfo

groupCount

groupMatchResults

groupMatchResults

groupMatchResults

nodeMatchResult

groupMatchResult

groupMatchResult