edu.illinois.cs.cogcomp.core.datastructures.textannotation

Class SpanLabelView

java.lang.Object

edu.illinois.cs.cogcomp.core.datastructures.textannotation.View

edu.illinois.cs.cogcomp.core.datastructures.textannotation.SpanLabelView

All Implemented Interfaces:

IQueryable<Constituent>, Serializable, Iterable<Constituent>

Direct Known Subclasses:

TokenLabelView

public class SpanLabelView
extends View

A SpanLabelView is a specialized view which corresponds to contiguous chunks of tokens that have a label. Each chunk corresponds to a single Consituent. In this view, there will be no Relations between the constituents.

This class is best suited for views like Shallow parse and Named Entities.

Author:

Vivek Srikumar

See Also:

Serialized Form

Field Summary

Fields inherited from class edu.illinois.cs.cogcomp.core.datastructures.textannotation.View

constituents, endSpan, relations, score, startSpan, textAnnotation, tokensToConstituents, viewGenerator, viewName

Constructor Summary

Constructors

Constructor and Description
SpanLabelView(String viewName, String viewGenerator, TextAnnotation text, double score) Create a new SpanLabelView
SpanLabelView(String viewName, String viewGenerator, TextAnnotation text, double score, boolean allowOverlappingSpans)
SpanLabelView(String viewName, TextAnnotation text) Create a new SpanLabelView with default View.viewGenerator and View.score.

Method Summary

Modifier and Type	Method and Description
void	addConstituent(Constituent constituent) Adds a new constituent to this view
Constituent	addSpanLabel(int start, int end, String label, double score) Adds a new span to this view with a given label and score and returns the newly created constituent.
String	getLabel(int tokenId)
List<Constituent>	getSpanLabels(int start, int end)
String	toString()

Methods inherited from class edu.illinois.cs.cogcomp.core.datastructures.textannotation.View

addRelation, containsConstituent, count, getConstituents, getConstituentsCovering, getConstituentsCoveringCharSpan, getConstituentsCoveringSpan, getConstituentsCoveringToken, getConstituentsCoveringTokens, getConstituentsOverlappingCharSpan, getConstituentsWithSpan, getEndSpan, getFilteredConstituents, getLabelsCovering, getLabelsCoveringSpan, getLabelsCoveringToken, getLabelsCoveringTokens, getNumberOfConstituents, getRelations, getRestrictedView, getScore, getStartSpan, getTextAnnotation, getViewCoveringSpan, getViewCoveringToken, getViewCoveringTokens, getViewGenerator, getViewName, iterator, orderBy, removeAllConsituents, removeAllRelations, removeAttributes, removeConstituent, removeRelation, select, unique, where

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SpanLabelView

public SpanLabelView(String viewName,
                     TextAnnotation text)

Create a new SpanLabelView with default View.viewGenerator and View.score.

Parameters:

viewName - the name of the view

text - the TextAnnotation to augment

SpanLabelView

public SpanLabelView(String viewName,
                     String viewGenerator,
                     TextAnnotation text,
                     double score)

Create a new SpanLabelView

SpanLabelView

public SpanLabelView(String viewName,
                     String viewGenerator,
                     TextAnnotation text,
                     double score,
                     boolean allowOverlappingSpans)

Method Detail

addConstituent

public void addConstituent(Constituent constituent)

Description copied from class: View

Adds a new constituent to this view

Overrides:

addConstituent in class View

Parameters:

constituent - The new constituent to be added.

addSpanLabel

public Constituent addSpanLabel(int start,
                                int end,
                                String label,
                                double score)

Adds a new span to this view with a given label and score and returns the newly created constituent.

If this SpanLabelView was defined not to accept overlapping spans (in the constructor), then this function will throw an IllegalArgumentException when an attempt is made to label an already existing span.

Parameters:

start - the start of the span

end - the end of the span

label - the label of the span

score - the score assigned to this label

Returns:

the newly created constituent that labels the given span.

getLabel

public String getLabel(int tokenId)

getSpanLabels

public List<Constituent> getSpanLabels(int start,
                                       int end)

toString

public String toString()

Overrides:

toString in class Object