edu.stanford.nlp.ling.tokensregex

Class MatchedExpression

java.lang.Object

edu.stanford.nlp.ling.tokensregex.MatchedExpression

Direct Known Subclasses:

TimeExpression

public class MatchedExpression
extends java.lang.Object

Matched Expression represents a chunk of text that was matched from an original segment of text.

Author:

Angel Chang

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MatchedExpression.SingleAnnotationExtractor Function that takes a CoreMap, applies an extraction function to it, to get a value.

Field Summary

Fields

Modifier and Type	Field and Description
protected CoreMap	annotation
protected Interval<java.lang.Integer>	charOffsets Character offsets (relative to original text).
protected Interval<java.lang.Integer>	chunkOffsets Chunk offsets (relative to chunking on top of original text)
protected java.lang.Object	context Function indicating how to extract an value from annotation built from this expression
static java.util.function.Function<CoreMap,Interval<java.lang.Integer>>	COREMAP_TO_CHAR_OFFSETS_INTERVAL_FUNC
static java.util.function.Function<CoreMap,Interval<java.lang.Integer>>	COREMAP_TO_TOKEN_OFFSETS_INTERVAL_FUNC
static java.util.Comparator<MatchedExpression>	EXPR_LENGTH_COMPARATOR
static java.util.Comparator<MatchedExpression>	EXPR_LENGTH_PRIORITY_COMPARATOR
static java.util.Comparator<MatchedExpression>	EXPR_ORDER_COMPARATOR
static java.util.Comparator<MatchedExpression>	EXPR_PRIORITY_COMPARATOR
static java.util.Comparator<MatchedExpression>	EXPR_PRIORITY_LENGTH_COMPARATOR
static java.util.function.Function<MatchedExpression,Interval<java.lang.Integer>>	EXPR_TO_TOKEN_OFFSETS_INTERVAL_FUNC
static java.util.Comparator<MatchedExpression>	EXPR_TOKEN_OFFSET_COMPARATOR
static java.util.Comparator<MatchedExpression>	EXPR_TOKEN_OFFSETS_NESTED_FIRST_COMPARATOR
static java.util.function.ToDoubleFunction<MatchedExpression>	EXPR_WEIGHT_SCORER
protected MatchedExpression.SingleAnnotationExtractor	extractFunc
protected java.lang.String	text Text representing the matched expression
protected Interval<java.lang.Integer>	tokenOffsets Token offsets (relative to original text tokenization)
Value	value

Constructor Summary

Constructors

Constructor and Description
MatchedExpression(Interval<java.lang.Integer> charOffsets, Interval<java.lang.Integer> tokenOffsets, MatchedExpression.SingleAnnotationExtractor extractFunc, double priority, double weight)
MatchedExpression(MatchedExpression me)

Method Summary

Modifier and Type	Method and Description
boolean	extractAnnotation(Env env, CoreMap sourceAnnotation)
boolean	extractAnnotation(Env env, java.util.List<? extends CoreMap> source)
protected boolean	extractAnnotation(java.util.List<? extends CoreMap> source, CoreMapAggregator aggregator)
CoreMap	getAnnotation()
static <T extends MatchedExpression> T	getBestMatched(java.util.List<T> matches, java.util.function.ToDoubleFunction<MatchedExpression> scorer)
Interval<java.lang.Integer>	getCharOffsets()
Interval<java.lang.Integer>	getChunkOffsets()
int	getOrder()
double	getPriority()
java.lang.String	getText()
Interval<java.lang.Integer>	getTokenOffsets()
Value	getValue()
double	getWeight()
boolean	isIncludeNested()
static <T extends MatchedExpression> java.util.List<T>	removeNested(java.util.List<T> chunks)
static <T extends MatchedExpression> java.util.List<T>	removeNullValues(java.util.List<T> chunks)
static <T extends MatchedExpression> java.util.List<T>	removeOverlapping(java.util.List<T> chunks)
static java.util.List<? extends CoreMap>	replaceMerged(java.util.List<? extends CoreMap> list, java.util.List<? extends MatchedExpression> matchedExprs)
static java.util.List<? extends CoreMap>	replaceMergedUsingTokenOffsets(java.util.List<? extends CoreMap> list, java.util.List<? extends MatchedExpression> matchedExprs)
void	setIncludeNested(boolean includeNested)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

text

protected java.lang.String text

Text representing the matched expression

charOffsets

protected Interval<java.lang.Integer> charOffsets

Character offsets (relative to original text). TODO: Fix up If matched using regular text patterns, the character offsets are with respect to the annotation (usually sentence) from which the text was matched against If matched using tokens, the character offsets are with respect to the overall document

tokenOffsets

protected Interval<java.lang.Integer> tokenOffsets

Token offsets (relative to original text tokenization)

chunkOffsets

protected Interval<java.lang.Integer> chunkOffsets

Chunk offsets (relative to chunking on top of original text)

annotation

protected CoreMap annotation

context

protected java.lang.Object context

Function indicating how to extract an value from annotation built from this expression

extractFunc

protected MatchedExpression.SingleAnnotationExtractor extractFunc

value

public Value value

COREMAP_TO_TOKEN_OFFSETS_INTERVAL_FUNC

public static final java.util.function.Function<CoreMap,Interval<java.lang.Integer>> COREMAP_TO_TOKEN_OFFSETS_INTERVAL_FUNC

COREMAP_TO_CHAR_OFFSETS_INTERVAL_FUNC

public static final java.util.function.Function<CoreMap,Interval<java.lang.Integer>> COREMAP_TO_CHAR_OFFSETS_INTERVAL_FUNC

EXPR_TO_TOKEN_OFFSETS_INTERVAL_FUNC

public static final java.util.function.Function<MatchedExpression,Interval<java.lang.Integer>> EXPR_TO_TOKEN_OFFSETS_INTERVAL_FUNC

EXPR_PRIORITY_COMPARATOR

public static final java.util.Comparator<MatchedExpression> EXPR_PRIORITY_COMPARATOR

EXPR_ORDER_COMPARATOR

public static final java.util.Comparator<MatchedExpression> EXPR_ORDER_COMPARATOR

EXPR_LENGTH_COMPARATOR

public static final java.util.Comparator<MatchedExpression> EXPR_LENGTH_COMPARATOR

EXPR_TOKEN_OFFSET_COMPARATOR

public static final java.util.Comparator<MatchedExpression> EXPR_TOKEN_OFFSET_COMPARATOR

EXPR_TOKEN_OFFSETS_NESTED_FIRST_COMPARATOR

public static final java.util.Comparator<MatchedExpression> EXPR_TOKEN_OFFSETS_NESTED_FIRST_COMPARATOR

EXPR_PRIORITY_LENGTH_COMPARATOR

public static final java.util.Comparator<MatchedExpression> EXPR_PRIORITY_LENGTH_COMPARATOR

EXPR_LENGTH_PRIORITY_COMPARATOR

public static final java.util.Comparator<MatchedExpression> EXPR_LENGTH_PRIORITY_COMPARATOR

EXPR_WEIGHT_SCORER

public static final java.util.function.ToDoubleFunction<MatchedExpression> EXPR_WEIGHT_SCORER

Constructor Detail

MatchedExpression

public MatchedExpression(MatchedExpression me)

MatchedExpression

public MatchedExpression(Interval<java.lang.Integer> charOffsets,
                         Interval<java.lang.Integer> tokenOffsets,
                         MatchedExpression.SingleAnnotationExtractor extractFunc,
                         double priority,
                         double weight)

Method Detail

extractAnnotation

public boolean extractAnnotation(Env env,
                                 CoreMap sourceAnnotation)

extractAnnotation

public boolean extractAnnotation(Env env,
                                 java.util.List<? extends CoreMap> source)

extractAnnotation

protected boolean extractAnnotation(java.util.List<? extends CoreMap> source,
                                    CoreMapAggregator aggregator)

getCharOffsets

public Interval<java.lang.Integer> getCharOffsets()

getTokenOffsets

public Interval<java.lang.Integer> getTokenOffsets()

getChunkOffsets

public Interval<java.lang.Integer> getChunkOffsets()

getPriority

public double getPriority()

getWeight

public double getWeight()

getOrder

public int getOrder()

isIncludeNested

public boolean isIncludeNested()

setIncludeNested

public void setIncludeNested(boolean includeNested)

getText

public java.lang.String getText()

getAnnotation

public CoreMap getAnnotation()

getValue

public Value getValue()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

replaceMerged

public static java.util.List<? extends CoreMap> replaceMerged(java.util.List<? extends CoreMap> list,
                                                              java.util.List<? extends MatchedExpression> matchedExprs)

replaceMergedUsingTokenOffsets

public static java.util.List<? extends CoreMap> replaceMergedUsingTokenOffsets(java.util.List<? extends CoreMap> list,
                                                                               java.util.List<? extends MatchedExpression> matchedExprs)

removeNullValues

public static <T extends MatchedExpression> java.util.List<T> removeNullValues(java.util.List<T> chunks)

removeNested

public static <T extends MatchedExpression> java.util.List<T> removeNested(java.util.List<T> chunks)

removeOverlapping

public static <T extends MatchedExpression> java.util.List<T> removeOverlapping(java.util.List<T> chunks)

getBestMatched

public static <T extends MatchedExpression> T getBestMatched(java.util.List<T> matches,
                                                             java.util.function.ToDoubleFunction<MatchedExpression> scorer)