SequenceMatchRules.AnnotationExtractRule (Stanford CoreNLP API)

java.lang.Object
- edu.stanford.nlp.ling.tokensregex.SequenceMatchRules.AnnotationExtractRule<S,T>

Type Parameters:
T - Output type (MatchedExpression)

All Implemented Interfaces:

SequenceMatchRules.ExtractRule<S,T>, SequenceMatchRules.Rule, Filter<T>, Serializable

Enclosing class:

SequenceMatchRules
```
public static class SequenceMatchRules.AnnotationExtractRule<S,T extends MatchedExpression>
extends Object
implements SequenceMatchRules.Rule, SequenceMatchRules.ExtractRule<S,T>, Filter<T>
```
Rule that specifies how to extract sequence of MatchedExpression from an annotation (CoreMap).

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`active`
`Class`	`annotationField` Annotation field to apply rule over: text or tokens or numerizedtokens
`SequenceMatchRules.ExtractRule<S,T>`	`extractRule` Actual rule performing the extraction (converting annotation to MatchedExpression)
`Filter<T>`	`filterRule`
`boolean`	`includeNested`
`boolean`	`isComposite`
`int`	`matchedExpressionGroup`
`SequenceMatcher.FindType`	`matchFindType`
`boolean`	`matchWithResults`
`String`	`name` Name of the rule
`double`	`priority` Priority in which this rule should be applied with respect to others
`List<Class>`	`resultAnnotationField` Annotation field(s) to put new annotation
`Class`	`resultNestedAnnotationField` Annotation field for child/nested annotations
`String`	`ruleType` Type of rule to apply: token string match, pattern string match
`int`	`stage` Stage in which this rule should be applied with respect to others
`Class`	`tokensAnnotationField`
`List<Class>`	`tokensResultAnnotationField` Annotation field(s) on individual tokens to put new annotation
`double`	`weight` Weight given to the rule (how likely is this rule to fire)

Constructor Summary

Constructors
Constructor and Description

SequenceMatchRules.AnnotationExtractRule()

Constructors
Constructor and Description
`SequenceMatchRules.AnnotationExtractRule()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`accept(T obj)` Checks if the given object passes the filter.
`boolean`	`extract(S in, List<T> out)`
`void`	`update(Env env, Map<String,Object> attributes)`

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

- Field Detail
  - name
```
public String name
```
    Name of the rule
  - stage
```
public int stage
```
    Stage in which this rule should be applied with respect to others
  - priority
```
public double priority
```
    Priority in which this rule should be applied with respect to others
  - weight
```
public double weight
```
    Weight given to the rule (how likely is this rule to fire)
  - annotationField
```
public Class annotationField
```
    Annotation field to apply rule over: text or tokens or numerizedtokens
  - tokensAnnotationField
```
public Class tokensAnnotationField
```
  - tokensResultAnnotationField
```
public List<Class> tokensResultAnnotationField
```
    Annotation field(s) on individual tokens to put new annotation
  - resultAnnotationField
```
public List<Class> resultAnnotationField
```
    Annotation field(s) to put new annotation
  - resultNestedAnnotationField
```
public Class resultNestedAnnotationField
```
    Annotation field for child/nested annotations
  - matchFindType
```
public SequenceMatcher.FindType matchFindType
```
  - matchedExpressionGroup
```
public int matchedExpressionGroup
```
  - matchWithResults
```
public boolean matchWithResults
```
  - ruleType
```
public String ruleType
```
    Type of rule to apply: token string match, pattern string match
  - isComposite
```
public boolean isComposite
```
  - includeNested
```
public boolean includeNested
```
  - active
```
public boolean active
```
  - extractRule
```
public SequenceMatchRules.ExtractRule<S,T extends MatchedExpression> extractRule
```
    Actual rule performing the extraction (converting annotation to MatchedExpression)
  - filterRule
```
public Filter<T extends MatchedExpression> filterRule
```
- Constructor Detail
  - SequenceMatchRules.AnnotationExtractRule
```
public SequenceMatchRules.AnnotationExtractRule()
```
- Method Detail
  - update
```
public void update(Env env,
          Map<String,Object> attributes)
```
  - extract
```
public boolean extract(S in,
              List<T> out)
```
    Specified by:
    
    extract in interface SequenceMatchRules.ExtractRule<S,T extends MatchedExpression>
  - accept
```
public boolean accept(T obj)
```
    Description copied from interface: Filter
    
    Checks if the given object passes the filter.
    
    Specified by:
    
    accept in interface Filter<T extends MatchedExpression>
    
    Parameters:
    obj - an object to test
    
    Returns:
    Whether the object should be accepted (for some processing)

Class SequenceMatchRules.AnnotationExtractRule<S,T extends MatchedExpression>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

stage

priority

weight

annotationField

tokensAnnotationField

tokensResultAnnotationField

resultAnnotationField

resultNestedAnnotationField

matchFindType

matchedExpressionGroup

matchWithResults

ruleType

isComposite

includeNested

active

extractRule

filterRule

Constructor Detail

SequenceMatchRules.AnnotationExtractRule

Method Detail

update

extract

accept