grammarscope.mutable

Class ProtoGrammaticalRelation

java.lang.Object

grammarscope.mutable.ProtoGrammaticalRelation

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

MutableGrammaticalRelation

public class ProtoGrammaticalRelation
extends java.lang.Object
implements java.io.Serializable

ProtoGrammaticalRelation is used to define a standardized, hierarchical set of grammatical relations, together with patterns for identifying them in parse trees.

Author:

Bill MacCartney, Galen Andrew (refactoring English-specific stuff), Ilya Sherman (refactoring annotation-relation pairing), Bernard Bou (this class factored out of GrammaticalRelation)

See Also:

GrammaticalRelation, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<ProtoGrammaticalRelation>	children
protected java.lang.String	longName
protected ProtoGrammaticalRelation	parent
private static long	serialVersionUID
protected java.lang.String	shortName
protected java.util.regex.Pattern	sourcePattern
protected java.lang.String	specific
protected java.util.List<edu.stanford.nlp.trees.tregex.TregexPattern>	targetPatterns

Constructor Summary

Constructors

Constructor and Description
ProtoGrammaticalRelation(java.lang.String shortName, java.lang.String longName, ProtoGrammaticalRelation parent, java.lang.String sourcePattern, java.lang.String[] targetPatterns, java.lang.String specificString)

Method Summary

Modifier and Type	Method and Description
protected void	addChild(ProtoGrammaticalRelation child)
static java.util.List<edu.stanford.nlp.trees.tregex.TregexPattern>	compileTargetPatterns(java.lang.String[] patternStrings) Compile list of strings into TregexPatterns
java.util.List<? extends ProtoGrammaticalRelation>	getChildren() Returns the children of this GrammaticalRelation.
java.lang.String	getLongName()
ProtoGrammaticalRelation	getParent() Returns the parent of this GrammaticalRelation.
java.util.Collection<edu.stanford.nlp.trees.Tree>	getRelatedNodes(edu.stanford.nlp.trees.Tree tree, edu.stanford.nlp.trees.Tree root) Given a Tree node tree, attempts to return a list of nodes to which node tree has this grammatical relation.
java.lang.String	getShortName()
java.util.regex.Pattern	getSourcePattern() Returns the source patterns of this GrammaticalRelation.
java.lang.String	getSpecific()
java.util.List<edu.stanford.nlp.trees.tregex.TregexPattern>	getTargetPatterns() Returns the target patterns of this GrammaticalRelation.
boolean	isAncestor(ProtoGrammaticalRelation gr0)
boolean	isApplicable(edu.stanford.nlp.trees.Tree tree) Returns true iff the value of Tree node tree matches the sourcePattern for this GrammaticalRelation, indicating that this GrammaticalRelation is one that could hold between Tree node tree and some other node.
boolean	isFromString() This function is used to determine whether the GrammaticalRelation in question is one that was created to be a thin wrapper around a String representation by valueOf(String), or whether it is a full-fledged GrammaticalRelation created by direct invocation of the constructor.
java.lang.String	toString() Returns short name (abbreviation) for this GrammaticalRelation.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

shortName

protected java.lang.String shortName

longName

protected java.lang.String longName

parent

protected ProtoGrammaticalRelation parent

children

protected java.util.List<ProtoGrammaticalRelation> children

sourcePattern

protected java.util.regex.Pattern sourcePattern

targetPatterns

protected java.util.List<edu.stanford.nlp.trees.tregex.TregexPattern> targetPatterns

specific

protected java.lang.String specific

Constructor Detail

ProtoGrammaticalRelation

public ProtoGrammaticalRelation(java.lang.String shortName,
                                java.lang.String longName,
                                ProtoGrammaticalRelation parent,
                                java.lang.String sourcePattern,
                                java.lang.String[] targetPatterns,
                                java.lang.String specificString)

Method Detail

isFromString

public boolean isFromString()

This function is used to determine whether the GrammaticalRelation in question is one that was created to be a thin wrapper around a String representation by valueOf(String), or whether it is a full-fledged GrammaticalRelation created by direct invocation of the constructor.

Returns:

Whether this relation is just a wrapper created by valueOf(String)

addChild

protected void addChild(ProtoGrammaticalRelation child)

getRelatedNodes

public java.util.Collection<edu.stanford.nlp.trees.Tree> getRelatedNodes(edu.stanford.nlp.trees.Tree tree,
                                                                         edu.stanford.nlp.trees.Tree root)

Given a Tree node tree, attempts to return a list of nodes to which node tree has this grammatical relation.

Parameters:

tree - Target for finding governors of tree related by this GR

root - The root of the Tree

Returns:

Governor nodes to which tree bears this GR

isApplicable

public boolean isApplicable(edu.stanford.nlp.trees.Tree tree)

Returns true iff the value of Tree node tree matches the sourcePattern for this GrammaticalRelation, indicating that this GrammaticalRelation is one that could hold between Tree node tree and some other node.

Parameters:

tree - tree

Returns:

true if applicable

isAncestor

public boolean isAncestor(ProtoGrammaticalRelation gr0)

toString

public final java.lang.String toString()

Returns short name (abbreviation) for this GrammaticalRelation.

Overrides:

toString in class java.lang.Object

getLongName

public java.lang.String getLongName()

getShortName

public java.lang.String getShortName()

getSpecific

public java.lang.String getSpecific()

getParent

public ProtoGrammaticalRelation getParent()

Returns the parent of this GrammaticalRelation.

Returns:

parent

getChildren

public java.util.List<? extends ProtoGrammaticalRelation> getChildren()

Returns the children of this GrammaticalRelation.

Returns:

children

getSourcePattern

public java.util.regex.Pattern getSourcePattern()

Returns the source patterns of this GrammaticalRelation.

Returns:

source pattern

getTargetPatterns

public java.util.List<edu.stanford.nlp.trees.tregex.TregexPattern> getTargetPatterns()

Returns the target patterns of this GrammaticalRelation.

Returns:

target patterns

compileTargetPatterns

public static java.util.List<edu.stanford.nlp.trees.tregex.TregexPattern> compileTargetPatterns(java.lang.String[] patternStrings)

Compile list of strings into TregexPatterns

Parameters:

patternStrings - array of pattern strings

Returns:

list of TregexPattern