org.cleartk.clearnlp

Class CleartkDependencyOps

java.lang.Object

org.cleartk.clearnlp.CleartkDependencyOps

All Implemented Interfaces:

DependencyOps<DependencyNode,Token,TopDependencyNode,Sentence,DependencyRelation>

@Beta
public class CleartkDependencyOps
extends Object
implements DependencyOps<DependencyNode,Token,TopDependencyNode,Sentence,DependencyRelation>

Defines common set of dependency graph data type operations used to convert and query ClearTK dependency types such as TopDependencyNode, DependencyNode and DependencyRelation

Author:

Lee Becker

Constructor Summary

Constructors

Constructor and Description
CleartkDependencyOps()

Method Summary

Modifier and Type	Method and Description
DependencyNode	createNode(org.apache.uima.jcas.JCas jCas, Token token) Creates a new dependency node for the specified span
DependencyRelation	createRelation(org.apache.uima.jcas.JCas jCas, DependencyNode head, DependencyNode child, String relation) Creates a relation between the two nodes.
TopDependencyNode	createRootNode(org.apache.uima.jcas.JCas jCas, Sentence sentence)
DependencyNode	getHead(org.apache.uima.jcas.JCas jCas, DependencyRelation relation)
List<DependencyRelation>	getHeadRelations(org.apache.uima.jcas.JCas jCas, DependencyNode node)
String	getLabel(org.apache.uima.jcas.JCas jCas, DependencyRelation relation)
List<DependencyNode>	selectNodes(org.apache.uima.jcas.JCas jCas, org.apache.uima.jcas.tcas.Annotation coveringAnnotation) Selects all dependency nodes within the annotation, excluding the root node.
TopDependencyNode	selectRootNode(org.apache.uima.jcas.JCas jCas, org.apache.uima.jcas.tcas.Annotation coveringAnnotation) Selects the single root node within the annotation.
void	setChildRelations(org.apache.uima.jcas.JCas jCas, DependencyNode node, List<DependencyRelation> childRelations) Sets the head relations for a given node.
void	setHeadRelations(org.apache.uima.jcas.JCas jCas, DependencyNode node, List<DependencyRelation> headRelations) Sets the head relations for a given node.

Methods inherited from class java.lang.Object

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

Constructor Detail

CleartkDependencyOps

public CleartkDependencyOps()

Method Detail

selectRootNode

public TopDependencyNode selectRootNode(org.apache.uima.jcas.JCas jCas,
                                        org.apache.uima.jcas.tcas.Annotation coveringAnnotation)

Description copied from interface: DependencyOps

Selects the single root node within the annotation. Should error on more than one root node.

Specified by:

selectRootNode in interface DependencyOps<DependencyNode,Token,TopDependencyNode,Sentence,DependencyRelation>

selectNodes

public List<DependencyNode> selectNodes(org.apache.uima.jcas.JCas jCas,
                                        org.apache.uima.jcas.tcas.Annotation coveringAnnotation)

Description copied from interface: DependencyOps

Selects all dependency nodes within the annotation, excluding the root node. Nodes should be ordered by their offsets.

Specified by:

selectNodes in interface DependencyOps<DependencyNode,Token,TopDependencyNode,Sentence,DependencyRelation>

getHeadRelations

public List<DependencyRelation> getHeadRelations(org.apache.uima.jcas.JCas jCas,
                                                 DependencyNode node)

Specified by:

getHeadRelations in interface DependencyOps<DependencyNode,Token,TopDependencyNode,Sentence,DependencyRelation>

getHead

public DependencyNode getHead(org.apache.uima.jcas.JCas jCas,
                              DependencyRelation relation)

Specified by:

getHead in interface DependencyOps<DependencyNode,Token,TopDependencyNode,Sentence,DependencyRelation>

getLabel

public String getLabel(org.apache.uima.jcas.JCas jCas,
                       DependencyRelation relation)

Specified by:

getLabel in interface DependencyOps<DependencyNode,Token,TopDependencyNode,Sentence,DependencyRelation>

createRootNode

public TopDependencyNode createRootNode(org.apache.uima.jcas.JCas jCas,
                                        Sentence sentence)

Specified by:

createRootNode in interface DependencyOps<DependencyNode,Token,TopDependencyNode,Sentence,DependencyRelation>

createNode

public DependencyNode createNode(org.apache.uima.jcas.JCas jCas,
                                 Token token)

Description copied from interface: DependencyOps

Creates a new dependency node for the specified span

Specified by:

createNode in interface DependencyOps<DependencyNode,Token,TopDependencyNode,Sentence,DependencyRelation>

createRelation

public DependencyRelation createRelation(org.apache.uima.jcas.JCas jCas,
                                         DependencyNode head,
                                         DependencyNode child,
                                         String relation)

Description copied from interface: DependencyOps

Creates a relation between the two nodes. If dealing with a type system where the relation is a separate object, this will likely create a new relation object. For graphs that have the relation built into the node, this will likely just set labels on head and child relation fields

Specified by:

createRelation in interface DependencyOps<DependencyNode,Token,TopDependencyNode,Sentence,DependencyRelation>

setHeadRelations

public void setHeadRelations(org.apache.uima.jcas.JCas jCas,
                             DependencyNode node,
                             List<DependencyRelation> headRelations)

Description copied from interface: DependencyOps

Sets the head relations for a given node. This is only important if the type system supports multi-head dependency parses

Specified by:

setHeadRelations in interface DependencyOps<DependencyNode,Token,TopDependencyNode,Sentence,DependencyRelation>

setChildRelations

public void setChildRelations(org.apache.uima.jcas.JCas jCas,
                              DependencyNode node,
                              List<DependencyRelation> childRelations)

Description copied from interface: DependencyOps

Sets the head relations for a given node. This is only important if the type system supports multi-child dependency parses

Specified by:

setChildRelations in interface DependencyOps<DependencyNode,Token,TopDependencyNode,Sentence,DependencyRelation>