org.cleartk.clearnlp

Interface DependencyOps<NODE_TYPE extends org.apache.uima.jcas.cas.TOP,NODE_SPAN_TYPE extends org.apache.uima.jcas.tcas.Annotation,ROOT_NODE_TYPE extends NODE_TYPE,ROOT_NODE_SPAN_TYPE extends org.apache.uima.jcas.tcas.Annotation,RELATION_TYPE extends org.apache.uima.jcas.cas.TOP>

All Known Implementing Classes:

CleartkDependencyOps

public interface DependencyOps<NODE_TYPE extends org.apache.uima.jcas.cas.TOP,NODE_SPAN_TYPE extends org.apache.uima.jcas.tcas.Annotation,ROOT_NODE_TYPE extends NODE_TYPE,ROOT_NODE_SPAN_TYPE extends org.apache.uima.jcas.tcas.Annotation,RELATION_TYPE extends org.apache.uima.jcas.cas.TOP>

Defines common set of dependency graph data type operations used to convert to and query in the target type system

Author:

Lee Becker

Method Summary

Methods

Modifier and Type	Method and Description
NODE_TYPE	createNode(org.apache.uima.jcas.JCas jCas, NODE_SPAN_TYPE span) Creates a new dependency node for the specified span
RELATION_TYPE	createRelation(org.apache.uima.jcas.JCas jCas, NODE_TYPE head, NODE_TYPE child, String relation) Creates a relation between the two nodes.
ROOT_NODE_TYPE	createRootNode(org.apache.uima.jcas.JCas jCas, ROOT_NODE_SPAN_TYPE span)
NODE_TYPE	getHead(org.apache.uima.jcas.JCas jCas, RELATION_TYPE relation)
List<RELATION_TYPE>	getHeadRelations(org.apache.uima.jcas.JCas jCas, NODE_TYPE node)
String	getLabel(org.apache.uima.jcas.JCas jCas, RELATION_TYPE relation)
List<NODE_TYPE>	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.
ROOT_NODE_TYPE	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, NODE_TYPE node, List<RELATION_TYPE> childRelations) Sets the head relations for a given node.
void	setHeadRelations(org.apache.uima.jcas.JCas jCas, NODE_TYPE node, List<RELATION_TYPE> headRelations) Sets the head relations for a given node.

Method Detail

selectRootNode

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

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

selectNodes

List<NODE_TYPE> 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. Nodes should be ordered by their offsets.

getHeadRelations

List<RELATION_TYPE> getHeadRelations(org.apache.uima.jcas.JCas jCas,
                                   NODE_TYPE node)

getHead

NODE_TYPE getHead(org.apache.uima.jcas.JCas jCas,
                RELATION_TYPE relation)

getLabel

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

createNode

NODE_TYPE createNode(org.apache.uima.jcas.JCas jCas,
                   NODE_SPAN_TYPE span)

Creates a new dependency node for the specified span

createRootNode

ROOT_NODE_TYPE createRootNode(org.apache.uima.jcas.JCas jCas,
                            ROOT_NODE_SPAN_TYPE span)

createRelation

RELATION_TYPE createRelation(org.apache.uima.jcas.JCas jCas,
                           NODE_TYPE head,
                           NODE_TYPE child,
                           String relation)

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

setHeadRelations

void setHeadRelations(org.apache.uima.jcas.JCas jCas,
                    NODE_TYPE node,
                    List<RELATION_TYPE> headRelations)

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

setChildRelations

void setChildRelations(org.apache.uima.jcas.JCas jCas,
                     NODE_TYPE node,
                     List<RELATION_TYPE> childRelations)

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