edu.stanford.nlp.trees
Class GrammaticalStructure

java.lang.Object
  extended by edu.stanford.nlp.trees.TreeGraph
      extended by edu.stanford.nlp.trees.GrammaticalStructure
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
EnglishGrammaticalStructure

public abstract class GrammaticalStructure
extends TreeGraph

A GrammaticalStructure is a TreeGraph (that is, a tree with additional labeled arcs between nodes) for representing the grammatical relations in a parse tree. A new GrammaticalStructure is constructed from an existing parse tree with the help of GrammaticalRelation, which defines a hierarchy of grammatical relations, along with patterns for identifying them in parse trees. The constructor for GrammaticalStructure uses these definitions to populate the new GrammaticalStructure with as many labeled grammatical relations as it can. Once constructed, the new GrammaticalStructure can be printed in various formats, or interrogated using the interface methods in this class.

Caveat emptor! This is a work in progress. Nothing in here should be relied upon to function perfectly. Feedback welcome.

Author:
Bill MacCartney, Galen Andrew (refactoring English-specific stuff), Ilya Sherman (dependencies)
See Also:
EnglishGrammaticalRelations, GrammaticalRelation, EnglishGrammaticalStructure, Serialized Form

Field Summary
protected  java.util.List<TypedDependency> allTypedDependencies
           
protected  java.util.Set<Dependency<Label,Label,java.lang.Object>> dependencies
           
protected  java.util.List<TypedDependency> typedDependencies
           
 
Fields inherited from class edu.stanford.nlp.trees.TreeGraph
root
 
Constructor Summary
GrammaticalStructure(java.util.List<TypedDependency> projectiveDependencies, TreeGraphNode root)
           
GrammaticalStructure(Tree t, java.util.Collection<GrammaticalRelation> relations, HeadFinder hf, Filter<java.lang.String> puncFilter)
           
GrammaticalStructure(Tree t, java.util.Collection<GrammaticalRelation> relations, java.util.concurrent.locks.Lock relationsLock, HeadFinder hf, Filter<java.lang.String> puncFilter)
          Create a new GrammaticalStructure, analyzing the parse tree and populate the GrammaticalStructure with as many labeled grammatical relation arcs as possible.
 
Method Summary
 java.util.Collection<TypedDependency> allTypedDependencies()
          Returns all the typed dependencies of this grammatical structure.
protected  void collapseDependencies(java.util.List<TypedDependency> list, boolean CCprocess)
          Destructively modify the Collection<TypedDependency> to collapse language-dependent transitive dependencies.
protected  void collapseDependenciesTree(java.util.List<TypedDependency> list)
          Destructively modify the Collection<TypedDependency> to collapse language-dependent transitive dependencies but keeping a tree structure.
protected  void correctDependencies(java.util.Collection<TypedDependency> list)
          Destructively modify the TypedDependencyGraph to correct language-dependent dependencies.
 java.util.Set<Dependency<Label,Label,java.lang.Object>> dependencies()
          Returns the set of (governor, dependent) dependencies in this GrammaticalStructure.
 java.util.List<java.lang.String> getDependencyPath(int nodeIndex, int rootIndex)
          Returns the dependency path as a list of String, from node to root, it is assumed that that root is an ancestor of node
 java.util.Set<TreeGraphNode> getDependents(TreeGraphNode t)
          Tries to return a Set of leaf (terminal) nodes which are the DEPENDENTs of the given node t.
static TreeGraphNode getGovernor(TreeGraphNode t)
          Tries to return a leaf (terminal) node which is the GOVERNOR of the given node t.
 GrammaticalRelation getGrammaticalRelation(int govIndex, int depIndex)
          Get GrammaticalRelation between gov and dep, and null if gov is not the governor of dep
static GrammaticalRelation getGrammaticalRelation(TreeGraphNode gov, TreeGraphNode dep)
          Get GrammaticalRelation between gov and dep, and null if gov is not the governor of dep
static java.util.List<GrammaticalRelation> getListGrammaticalRelation(TreeGraphNode gov, TreeGraphNode dep)
          Get a list of GrammaticalRelation between gov and dep.
static TreeGraphNode getNodeInRelation(TreeGraphNode t, GrammaticalRelation r)
           
static java.util.Collection<TypedDependency> getRoots(java.util.Collection<TypedDependency> list)
          Return a list of TypedDependencies which are not dependent on any node from the list.
static boolean isConnected(java.util.Collection<TypedDependency> list)
          Checks if all the typeDependencies are connected
 java.util.Collection<TypedDependency> typedDependencies()
          Returns the typed dependencies of this grammatical structure.
 java.util.List<TypedDependency> typedDependencies(boolean includeExtras)
          Returns the typed dependencies of this grammatical structure.
 java.util.List<TypedDependency> typedDependenciesCCprocessed()
          Get a list of the typed dependencies, including extras like control dependencies, collapsing them and distributing relations across coordination.
 java.util.List<TypedDependency> typedDependenciesCCprocessed(boolean includeExtras)
          Get the typed dependencies after collapsing them and processing eventual CC complements.
 java.util.Collection<TypedDependency> typedDependenciesCollapsed()
          Get the typed dependencies after collapsing them.
 java.util.List<TypedDependency> typedDependenciesCollapsed(boolean includeExtras)
          Get the typed dependencies after collapsing them.
 java.util.Collection<TypedDependency> typedDependenciesCollapsedTree()
          Get the typed dependencies after mostly collapsing them, but keep a tree structure.
 
Methods inherited from class edu.stanford.nlp.trees.TreeGraph
addNodeToIndexMap, getNodeByIndex, getNodes, main, root, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

dependencies

protected final java.util.Set<Dependency<Label,Label,java.lang.Object>> dependencies

typedDependencies

protected final java.util.List<TypedDependency> typedDependencies

allTypedDependencies

protected final java.util.List<TypedDependency> allTypedDependencies
Constructor Detail

GrammaticalStructure

public GrammaticalStructure(Tree t,
                            java.util.Collection<GrammaticalRelation> relations,
                            java.util.concurrent.locks.Lock relationsLock,
                            HeadFinder hf,
                            Filter<java.lang.String> puncFilter)
Create a new GrammaticalStructure, analyzing the parse tree and populate the GrammaticalStructure with as many labeled grammatical relation arcs as possible.

Parameters:
t - A Tree to analyze
relations - A set of GrammaticalRelations to consider
relationsLock - Something needed to make this thread-safe
hf - A HeadFinder for analysis
puncFilter - A Filter to reject punctuation. To delete punctuation dependencies, this filter should return false on punctuation word strings, and true otherwise. If punctuation dependencies should be kept, you should pass in a Filters.<String>acceptFilter().

GrammaticalStructure

public GrammaticalStructure(java.util.List<TypedDependency> projectiveDependencies,
                            TreeGraphNode root)

GrammaticalStructure

public GrammaticalStructure(Tree t,
                            java.util.Collection<GrammaticalRelation> relations,
                            HeadFinder hf,
                            Filter<java.lang.String> puncFilter)
Method Detail

dependencies

public java.util.Set<Dependency<Label,Label,java.lang.Object>> dependencies()
Returns the set of (governor, dependent) dependencies in this GrammaticalStructure.

Returns:
The set of (governor, dependent) dependencies in this GrammaticalStructure.

getDependents

public java.util.Set<TreeGraphNode> getDependents(TreeGraphNode t)
Tries to return a Set of leaf (terminal) nodes which are the DEPENDENTs of the given node t. Probably, t should be a leaf node as well.

Parameters:
t - a leaf node in this GrammaticalStructure
Returns:
a Set of nodes which are dependents of node t, or else null

getGovernor

public static TreeGraphNode getGovernor(TreeGraphNode t)
Tries to return a leaf (terminal) node which is the GOVERNOR of the given node t. Probably, t should be a leaf node as well.

Parameters:
t - a leaf node in this GrammaticalStructure
Returns:
a node which is the governor for node t, or else null

getNodeInRelation

public static TreeGraphNode getNodeInRelation(TreeGraphNode t,
                                              GrammaticalRelation r)

getGrammaticalRelation

public GrammaticalRelation getGrammaticalRelation(int govIndex,
                                                  int depIndex)
Get GrammaticalRelation between gov and dep, and null if gov is not the governor of dep


getGrammaticalRelation

public static GrammaticalRelation getGrammaticalRelation(TreeGraphNode gov,
                                                         TreeGraphNode dep)
Get GrammaticalRelation between gov and dep, and null if gov is not the governor of dep


getListGrammaticalRelation

public static java.util.List<GrammaticalRelation> getListGrammaticalRelation(TreeGraphNode gov,
                                                                             TreeGraphNode dep)
Get a list of GrammaticalRelation between gov and dep. Useful for getting extra dependencies, in which two nodes can be linked by multiple arcs.


typedDependencies

public java.util.Collection<TypedDependency> typedDependencies()
Returns the typed dependencies of this grammatical structure. These are basic word-level typed dependencies, where each word other than the root of the sentence is dependent on one other word, and the dependencies have a tree structure.

Returns:
The typed dependencies of this grammatical structure

allTypedDependencies

public java.util.Collection<TypedDependency> allTypedDependencies()
Returns all the typed dependencies of this grammatical structure. These are like the basic (uncollapsed) dependencies, but may include extra arcs for control relationships, etc.


typedDependencies

public java.util.List<TypedDependency> typedDependencies(boolean includeExtras)
Returns the typed dependencies of this grammatical structure.

If the boolean argument is true, the list of typed dependencies returned may include "extras", and does not follow a tree structure.


typedDependenciesCollapsed

public java.util.Collection<TypedDependency> typedDependenciesCollapsed()
Get the typed dependencies after collapsing them. Collapsing dependencies refers to turning certain function words such as prepositions and conjunctions into arcs, so they disappear from the set of nodes. There is no guarantee that the dependencies are a tree. While the dependencies are normally tree-like, the collapsing may introduce not only re-entrancies but even small cycles.

Returns:
A set of collapsed dependencies

typedDependenciesCollapsedTree

public java.util.Collection<TypedDependency> typedDependenciesCollapsedTree()
Get the typed dependencies after mostly collapsing them, but keep a tree structure. In order to do this, the code does:
  1. no relative clause processing
  2. no xsubj relations
  3. no propagation of conjuncts

Returns:
collapsed dependencies keeping a tree structure

typedDependenciesCollapsed

public java.util.List<TypedDependency> typedDependenciesCollapsed(boolean includeExtras)
Get the typed dependencies after collapsing them.

If the boolean argument is true, the list of typed dependencies returned may include "extras".

Returns:
collapsed dependencies

typedDependenciesCCprocessed

public java.util.List<TypedDependency> typedDependenciesCCprocessed(boolean includeExtras)
Get the typed dependencies after collapsing them and processing eventual CC complements. The effect of this part is to distributed conjoined arguments across relations or conjoined predicates across their arguments. This is generally useful, and we generally recommend using the output of this method with the second argument being true.

Parameters:
includeExtras - If true, the list of typed dependencies returned may include "extras", such as controlled subject links.
Returns:
collapsed dependencies with CC processed

typedDependenciesCCprocessed

public java.util.List<TypedDependency> typedDependenciesCCprocessed()
Get a list of the typed dependencies, including extras like control dependencies, collapsing them and distributing relations across coordination. This method is generally recommended for best representing the semantic and syntactic relations of a sentence. In general it returns a directed graph (i.e., the output may not be a tree and it may contain (small) cycles).

Returns:
collapsed dependencies with CC processed

collapseDependencies

protected void collapseDependencies(java.util.List<TypedDependency> list,
                                    boolean CCprocess)
Destructively modify the Collection<TypedDependency> to collapse language-dependent transitive dependencies.

Default is no-op; to be over-ridden in subclasses.

Parameters:
list - A list of dependencies to process for possible collapsing
CCprocess - apply CC process?

collapseDependenciesTree

protected void collapseDependenciesTree(java.util.List<TypedDependency> list)
Destructively modify the Collection<TypedDependency> to collapse language-dependent transitive dependencies but keeping a tree structure.

Default is no-op; to be over-ridden in subclasses.

Parameters:
list - A list of dependencies to process for possible collapsing

correctDependencies

protected void correctDependencies(java.util.Collection<TypedDependency> list)
Destructively modify the TypedDependencyGraph to correct language-dependent dependencies. (e.g., nsubjpass in a relative clause)

Default is no-op; to be over-ridden in subclasses.


getDependencyPath

public java.util.List<java.lang.String> getDependencyPath(int nodeIndex,
                                                          int rootIndex)
Returns the dependency path as a list of String, from node to root, it is assumed that that root is an ancestor of node

Returns:
A list of dependency labels

isConnected

public static boolean isConnected(java.util.Collection<TypedDependency> list)
Checks if all the typeDependencies are connected

Parameters:
list - a list of typedDependencies
Returns:
true if the list represents a connected graph, false otherwise

getRoots

public static java.util.Collection<TypedDependency> getRoots(java.util.Collection<TypedDependency> list)
Return a list of TypedDependencies which are not dependent on any node from the list.

Parameters:
list - The list of TypedDependencies to check
Returns:
A list of TypedDependencies which are not dependent on any node from the list


Stanford NLP Group