org.cleartk.clearnlp

Class CleartkDependencyOps

java.lang.Object

org.cleartk.clearnlp.CleartkDependencyOps

All Implemented Interfaces:

DependencyOps<org.cleartk.syntax.dependency.type.DependencyNode,org.cleartk.token.type.Token,org.cleartk.syntax.dependency.type.TopDependencyNode,org.cleartk.token.type.Sentence,org.cleartk.syntax.dependency.type.DependencyRelation>

public class CleartkDependencyOps
extends Object
implements DependencyOps<org.cleartk.syntax.dependency.type.DependencyNode,org.cleartk.token.type.Token,org.cleartk.syntax.dependency.type.TopDependencyNode,org.cleartk.token.type.Sentence,org.cleartk.syntax.dependency.type.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

Methods

Modifier and Type	Method and Description
org.cleartk.syntax.dependency.type.DependencyNode	createNode(org.apache.uima.jcas.JCas jCas, org.cleartk.token.type.Token token) Creates a new dependency node for the specified span
org.cleartk.syntax.dependency.type.DependencyRelation	createRelation(org.apache.uima.jcas.JCas jCas, org.cleartk.syntax.dependency.type.DependencyNode head, org.cleartk.syntax.dependency.type.DependencyNode child, String relation) Creates a relation between the two nodes.
org.cleartk.syntax.dependency.type.TopDependencyNode	createRootNode(org.apache.uima.jcas.JCas jCas, org.cleartk.token.type.Sentence sentence)
org.cleartk.syntax.dependency.type.DependencyNode	getHead(org.apache.uima.jcas.JCas jCas, org.cleartk.syntax.dependency.type.DependencyRelation relation)
List<org.cleartk.syntax.dependency.type.DependencyRelation>	getHeadRelations(org.apache.uima.jcas.JCas jCas, org.cleartk.syntax.dependency.type.DependencyNode node)
String	getLabel(org.apache.uima.jcas.JCas jCas, org.cleartk.syntax.dependency.type.DependencyRelation relation)
List<org.cleartk.syntax.dependency.type.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.
org.cleartk.syntax.dependency.type.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, org.cleartk.syntax.dependency.type.DependencyNode node, List<org.cleartk.syntax.dependency.type.DependencyRelation> childRelations) Sets the head relations for a given node.
void	setHeadRelations(org.apache.uima.jcas.JCas jCas, org.cleartk.syntax.dependency.type.DependencyNode node, List<org.cleartk.syntax.dependency.type.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 org.cleartk.syntax.dependency.type.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<org.cleartk.syntax.dependency.type.DependencyNode,org.cleartk.token.type.Token,org.cleartk.syntax.dependency.type.TopDependencyNode,org.cleartk.token.type.Sentence,org.cleartk.syntax.dependency.type.DependencyRelation>

selectNodes

public List<org.cleartk.syntax.dependency.type.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<org.cleartk.syntax.dependency.type.DependencyNode,org.cleartk.token.type.Token,org.cleartk.syntax.dependency.type.TopDependencyNode,org.cleartk.token.type.Sentence,org.cleartk.syntax.dependency.type.DependencyRelation>

getHeadRelations

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

Specified by:

getHeadRelations in interface DependencyOps<org.cleartk.syntax.dependency.type.DependencyNode,org.cleartk.token.type.Token,org.cleartk.syntax.dependency.type.TopDependencyNode,org.cleartk.token.type.Sentence,org.cleartk.syntax.dependency.type.DependencyRelation>

getHead

public org.cleartk.syntax.dependency.type.DependencyNode getHead(org.apache.uima.jcas.JCas jCas,
                                                        org.cleartk.syntax.dependency.type.DependencyRelation relation)

Specified by:

getHead in interface DependencyOps<org.cleartk.syntax.dependency.type.DependencyNode,org.cleartk.token.type.Token,org.cleartk.syntax.dependency.type.TopDependencyNode,org.cleartk.token.type.Sentence,org.cleartk.syntax.dependency.type.DependencyRelation>

getLabel

public String getLabel(org.apache.uima.jcas.JCas jCas,
              org.cleartk.syntax.dependency.type.DependencyRelation relation)

Specified by:

getLabel in interface DependencyOps<org.cleartk.syntax.dependency.type.DependencyNode,org.cleartk.token.type.Token,org.cleartk.syntax.dependency.type.TopDependencyNode,org.cleartk.token.type.Sentence,org.cleartk.syntax.dependency.type.DependencyRelation>

createRootNode

public org.cleartk.syntax.dependency.type.TopDependencyNode createRootNode(org.apache.uima.jcas.JCas jCas,
                                                                  org.cleartk.token.type.Sentence sentence)

Specified by:

createRootNode in interface DependencyOps<org.cleartk.syntax.dependency.type.DependencyNode,org.cleartk.token.type.Token,org.cleartk.syntax.dependency.type.TopDependencyNode,org.cleartk.token.type.Sentence,org.cleartk.syntax.dependency.type.DependencyRelation>

createNode

public org.cleartk.syntax.dependency.type.DependencyNode createNode(org.apache.uima.jcas.JCas jCas,
                                                           org.cleartk.token.type.Token token)

Description copied from interface: DependencyOps

Creates a new dependency node for the specified span

Specified by:

createNode in interface DependencyOps<org.cleartk.syntax.dependency.type.DependencyNode,org.cleartk.token.type.Token,org.cleartk.syntax.dependency.type.TopDependencyNode,org.cleartk.token.type.Sentence,org.cleartk.syntax.dependency.type.DependencyRelation>

createRelation

public org.cleartk.syntax.dependency.type.DependencyRelation createRelation(org.apache.uima.jcas.JCas jCas,
                                                                   org.cleartk.syntax.dependency.type.DependencyNode head,
                                                                   org.cleartk.syntax.dependency.type.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<org.cleartk.syntax.dependency.type.DependencyNode,org.cleartk.token.type.Token,org.cleartk.syntax.dependency.type.TopDependencyNode,org.cleartk.token.type.Sentence,org.cleartk.syntax.dependency.type.DependencyRelation>

setHeadRelations

public void setHeadRelations(org.apache.uima.jcas.JCas jCas,
                    org.cleartk.syntax.dependency.type.DependencyNode node,
                    List<org.cleartk.syntax.dependency.type.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<org.cleartk.syntax.dependency.type.DependencyNode,org.cleartk.token.type.Token,org.cleartk.syntax.dependency.type.TopDependencyNode,org.cleartk.token.type.Sentence,org.cleartk.syntax.dependency.type.DependencyRelation>

setChildRelations

public void setChildRelations(org.apache.uima.jcas.JCas jCas,
                     org.cleartk.syntax.dependency.type.DependencyNode node,
                     List<org.cleartk.syntax.dependency.type.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<org.cleartk.syntax.dependency.type.DependencyNode,org.cleartk.token.type.Token,org.cleartk.syntax.dependency.type.TopDependencyNode,org.cleartk.token.type.Sentence,org.cleartk.syntax.dependency.type.DependencyRelation>