edu.stanford.nlp.parser.lexparser

Class TregexPoweredTreebankParserParams

java.lang.Object

edu.stanford.nlp.parser.lexparser.AbstractTreebankParserParams

edu.stanford.nlp.parser.lexparser.TregexPoweredTreebankParserParams

All Implemented Interfaces:

TreebankLangParserParams, TreebankFactory, Serializable

Direct Known Subclasses:

FrenchTreebankParserParams, SpanishTreebankParserParams

public abstract class TregexPoweredTreebankParserParams
extends AbstractTreebankParserParams

An extension of AbstractTreebankParserParams which provides support for Tregex-powered annotations. Subclasses of this class provide collections of features which are associated with annotation behaviors that seek out and label matching trees in some way. For example, a coord feature might have an annotation behavior which searches for coordinating noun phrases and labels the associated constituent with a suffix -coordinating. The "search" in this process is conducted via Tregex, and the actual annotation is done through execution of an arbitrary Function provided by the user. This class carries as inner several classes several useful common annotation functions.

Author:

Jon Gauthier, Spence Green

See Also:

annotations, TregexPoweredTreebankParserParams.SimpleStringFunction, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	TregexPoweredTreebankParserParams.AnnotateHeadFunction Annotate a tree constituent with its lexical head.
protected static class	TregexPoweredTreebankParserParams.SimpleStringFunction Annotates all nodes that match the tregex query with some string.

Nested classes/interfaces inherited from class edu.stanford.nlp.parser.lexparser.AbstractTreebankParserParams

AbstractTreebankParserParams.AnnotatePunctuationFunction, AbstractTreebankParserParams.RemoveGFSubcategoryStripper, AbstractTreebankParserParams.SubcategoryStripper

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Pair<String,java.util.function.Function<TregexMatcher,String>>>	annotations This data structure dictates how an arbitrary tree should be annotated.

Fields inherited from class edu.stanford.nlp.parser.lexparser.AbstractTreebankParserParams

evalGF, inputEncoding, outputEncoding, tlp

Constructor Summary

Constructors

Constructor and Description
TregexPoweredTreebankParserParams(TreebankLanguagePack tlp)

Method Summary

Modifier and Type	Method and Description
protected void	addFeature(String featureName) Enable an annotation feature.
protected abstract String[]	baselineAnnotationFeatures() Features which should be enabled by default.
protected void	compileAnnotations(HeadFinder hf) Compile the annotations collection given a particular head finder.
void	display() Output a description of the current annotation configuration to standard error.
protected String	getAnnotationString(Tree t, Tree root) Build a string of annotations for the given tree.
protected void	removeFeature(String featureName) Disable a feature.
Tree	transformTree(Tree t, Tree root) This method does language-specific tree transformations such as annotating particular nodes with language-relevant features.

Methods inherited from class edu.stanford.nlp.parser.lexparser.AbstractTreebankParserParams

collinizer, collinizerEvalb, defaultCoreNLPFlags, dependencyGrammarExtractor, dependencyObjectify, diskTreebank, getGrammaticalStructure, getInputEncoding, getOutputEncoding, headFinder, isEvalGF, lex, memoryTreebank, MLEDependencyGrammarSmoothingParams, parsevalObjectify, parsevalObjectify, ppAttachmentEval, processHeadWord, pw, pw, readGrammaticalStructureFromFile, setEvalGF, setEvaluateGrammaticalFunctions, setInputEncoding, setOptionFlag, setOutputEncoding, sisterSplitters, subcategoryStripper, supportsBasicDependencies, testMemoryTreebank, treebank, treebankLanguagePack, treeTokenizerFactory, typedDependencyClasser, typedDependencyHeadFinder, typedDependencyObjectify, unorderedTypedDependencyObjectify, unorderedUntypedDependencyObjectify, untypedDependencyObjectify

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.stanford.nlp.parser.lexparser.TreebankLangParserParams

defaultTestSentence, treeReaderFactory

Field Detail

annotations

protected final Map<String,Pair<String,java.util.function.Function<TregexMatcher,String>>> annotations

This data structure dictates how an arbitrary tree should be annotated. It is a collection of features: a map from feature name to behavior, where each behavior is a tuple (t, f). t is a string form of a TregexPattern which matches subtrees corresponding to the feature, and f is a function which accepts such matches and generates an annotation which the matched subtree should be given.

See Also:

annotationPatterns, TregexPoweredTreebankParserParams.SimpleStringFunction

Constructor Detail

TregexPoweredTreebankParserParams

public TregexPoweredTreebankParserParams(TreebankLanguagePack tlp)

Method Detail

baselineAnnotationFeatures

protected abstract String[] baselineAnnotationFeatures()

Features which should be enabled by default.

compileAnnotations

protected void compileAnnotations(HeadFinder hf)

Compile the annotations collection given a particular head finder. Subclasses should call this method at least once before the class is used, and whenever the head finder is changed.

addFeature

protected void addFeature(String featureName)

Enable an annotation feature. If the provided feature has already been enabled, this method does nothing.

Parameters:

featureName -

Throws:

IllegalArgumentException - If the provided feature name is unknown (i.e., if there is no entry in the annotations collection with the same name)

removeFeature

protected void removeFeature(String featureName)

Disable a feature. If the feature was never enabled, this method returns without error.

Parameters:

featureName -

transformTree

public Tree transformTree(Tree t,
                          Tree root)

This method does language-specific tree transformations such as annotating particular nodes with language-relevant features. Such parameterizations should be inside the specific TreebankLangParserParams class. This method is recursively applied to each node in the tree (depth first, left-to-right), so you shouldn't write this method to apply recursively to tree members. This method is allowed to (and in some cases does) destructively change the input tree t. It changes both labels and the tree shape.

Specified by:

transformTree in interface TreebankLangParserParams

Specified by:

transformTree in class AbstractTreebankParserParams

Parameters:

t - The input tree (with non-language specific annotation already done, so you need to strip back to basic categories)

root - The root of the current tree (can be null for words)

Returns:

The fully annotated tree node (with daughters still as you want them in the final result)

getAnnotationString

protected String getAnnotationString(Tree t,
                                     Tree root)

Build a string of annotations for the given tree.

Parameters:

t - The input tree (with non-language specific annotation already done, so you need to strip back to basic categories)

root - The root of the current tree (can be null for words)

Returns:

A (possibly empty) string of annotations to add to the given tree

display

public void display()

Output a description of the current annotation configuration to standard error.

Specified by:

display in interface TreebankLangParserParams

Specified by:

display in class AbstractTreebankParserParams