TreebankNodeUtil (ClearTK TimeML 2.0.0 API)

java.lang.Object
- org.cleartk.syntax.constituent.type.TreebankNodeUtil

```
public class TreebankNodeUtil
extends Object
```
Copyright (c) 2011, Regents of the University of Colorado
All rights reserved.

Author:

Steven Bethard

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TreebankNodeUtil.TreebankNodePath` Representation of a path from one TreebankNode to another, via a common ancestor in the tree.

Constructor Summary

Constructors
Constructor and Description

TreebankNodeUtil()

Constructors
Constructor and Description
`TreebankNodeUtil()`

Method Summary

Methods
Modifier and Type	Method and Description
`static TreebankNode`	`getAncestorWithType(TreebankNode node, String type)`
`static int`	`getDepth(TreebankNode node)` Calculates the depth of the TreebankNode.
`static TreebankNode`	`getParent(TreebankNode node)`
`static TreebankNodeUtil.TreebankNodePath`	`getPath(TreebankNode source, TreebankNode target)` Get the path from the source TreebankNode to the target TreebankNode via the least common ancestor.
`static List<TreebankNode>`	`getPathToRoot(TreebankNode startNode)` Find the path from a TreebankNode to the root of the tree it belongs to.
`static TopTreebankNode`	`getTopNode(TreebankNode node)`
`static TreebankNode`	`newNode(JCas jCas, int begin, int end, String nodeType)` Create a leaf TreebankNode in a JCas.
`static TreebankNode`	`newNode(JCas jCas, String nodeType, TreebankNode... children)` Create a branch TreebankNode in a JCas.
`static void`	`print(PrintStream out, TreebankNode node)` A "pretty print" of this node that may be useful for e.g.
`static TreebankNode`	`selectHighestCoveredTreebankNode(JCas jCas, Annotation annotation)` Selects the highest TreebankNode in the parse tree that is at least partially covered by the given annotation.
`static TreebankNode`	`selectHighestMatchingTreebankNode(JCas jCas, Annotation annotation)` Selects the highest TreebankNode in the parse tree that has the same span as the given annotation.
`static TreebankNode`	`selectMatchingLeaf(JCas jCas, Annotation annotation)` Selects a single TreebankNode leaf that has the same span as the given annotation.
`static String`	`toTreebankString(TreebankNode node)` Format the TreebankNode as a Penn-Treebank-style parenthesized string.

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

- Constructor Detail
  - TreebankNodeUtil
```
public TreebankNodeUtil()
```
- Method Detail
  - getAncestorWithType
```
public static TreebankNode getAncestorWithType(TreebankNode node,
                               String type)
```
  - getDepth
```
public static int getDepth(TreebankNode node)
```
    Calculates the depth of the TreebankNode. The root node has depth 0, children of the root node have depth 1, etc.
    
    Parameters:
    node - The TreebankNode whose depth is to be calculated.
    
    Returns:
    The depth of the TreebankNode.
  - getParent
```
public static TreebankNode getParent(TreebankNode node)
```
  - getPath
```
public static TreebankNodeUtil.TreebankNodePath getPath(TreebankNode source,
                                        TreebankNode target)
```
    Get the path from the source TreebankNode to the target TreebankNode via the least common ancestor.
    
    Parameters:
    source - The TreebankNode where the path should start.
    target - The TreebankNode where the path should end.
    
    Returns:
    The path from the source node to the target node.
  - getPathToRoot
```
public static List<TreebankNode> getPathToRoot(TreebankNode startNode)
```
    Find the path from a TreebankNode to the root of the tree it belongs to.
    
    Parameters:
    startNode - The start node of the path
    
    Returns:
    A list of TreebankNodes that make up the path from startNode to the root of the tree
  - getTopNode
```
public static TopTreebankNode getTopNode(TreebankNode node)
```
  - newNode
```
public static TreebankNode newNode(JCas jCas,
                   int begin,
                   int end,
                   String nodeType)
```
    Create a leaf TreebankNode in a JCas.
    
    Parameters:
    jCas - The JCas which the annotation should be added to.
    begin - The begin offset of the node.
    end - The end offset of the node.
    nodeType - The part of speech tag of the node.
    
    Returns:
    The TreebankNode which was added to the JCas.
  - newNode
```
public static TreebankNode newNode(JCas jCas,
                   String nodeType,
                   TreebankNode... children)
```
    Create a branch TreebankNode in a JCas. The offsets of this node will be determined by its children.
    
    Parameters:
    jCas - The JCas which the annotation should be added to.
    nodeType - The phrase type tag of the node.
    children - The TreebankNode children of the node.
    
    Returns:
    The TreebankNode which was added to the JCas.
  - print
```
public static void print(PrintStream out,
         TreebankNode node)
```
    A "pretty print" of this node that may be useful for e.g. debugging.
  - selectHighestCoveredTreebankNode
```
public static TreebankNode selectHighestCoveredTreebankNode(JCas jCas,
                                            Annotation annotation)
```
    Selects the highest TreebankNode in the parse tree that is at least partially covered by the given annotation.
    
    Parameters:
    jCas - The JCas containing the TreebankNodes.
    annotation - The Annotation whose span should be matched.
    
    Returns:
    The highest TreebankNode at least partially covered by the given span, or null if no such annotation exists.
  - selectHighestMatchingTreebankNode
```
public static TreebankNode selectHighestMatchingTreebankNode(JCas jCas,
                                             Annotation annotation)
```
    Selects the highest TreebankNode in the parse tree that has the same span as the given annotation.
    
    Parameters:
    jCas - The JCas containing the TreebankNodes.
    annotation - The Annotation whose span should be matched.
    
    Returns:
    The highest TreebankNode matching the given span, or null if no such annotation exists.
  - selectMatchingLeaf
```
public static TreebankNode selectMatchingLeaf(JCas jCas,
                              Annotation annotation)
```
    Selects a single TreebankNode leaf that has the same span as the given annotation.
    
    Parameters:
    jCas - The JCas containing the TreebankNodes.
    annotation - The Annotation whose span should match a TreebankNode leaf.
    
    Returns:
    The single TreebankNode leaf that matches the annotation, or null if no such annotation exists.
  - toTreebankString
```
public static String toTreebankString(TreebankNode node)
```
    Format the TreebankNode as a Penn-Treebank-style parenthesized string.
    
    Parameters:
    node - The TreebankNode to be formatted.
    
    Returns:
    A parenthesized Penn-Treebank-style string.

Class TreebankNodeUtil

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TreebankNodeUtil

Method Detail

getAncestorWithType

getDepth

getParent

getPath

getPathToRoot

getTopNode

newNode

newNode

print

selectHighestCoveredTreebankNode

selectHighestMatchingTreebankNode

selectMatchingLeaf

toTreebankString