edu.cmu.minorthird.text
Interface TextLabels

All Known Subinterfaces:

MonotonicTextLabels, MutableTextLabels

All Known Implementing Classes:

BasicTextLabels, EmptyLabels, MonotonicSubTextLabels, NestedTextLabels, SubTextLabels

public interface TextLabels

Access assertions about 'types' and 'properties' of contiguous Spans of these Seq's. TextLabels's are immutable.

Author:

William Cohen

Method Summary

void	annotateWith(java.lang.String annotationType, java.lang.String fileToLoad) Annotate labels with annotator named fileToLoad
java.util.Iterator<Span>	closureIterator(java.lang.String type) Returns the spans s for in the given type is 'closed'.
java.util.Iterator<Span>	closureIterator(java.lang.String type, java.lang.String documentId) Returns the spans S inside the given document in which the given type is 'closed'.
Details	getDetails(Span span, java.lang.String type) Retrieve additional information associated with an assertion 'span S has type T'.
java.lang.String	getProperty(Span span, java.lang.String prop) Get the value of the named property which has been associated with this Span.
java.lang.String	getProperty(Token token, java.lang.String prop) Get the property value associated with this TextToken.
java.util.Set<java.lang.String>	getSpanProperties() Get a set of all previously-defined properties.
java.util.Iterator<Span>	getSpansWithProperty(java.lang.String prop) Find all spans that have a non-null value for this property.
java.util.Iterator<Span>	getSpansWithProperty(java.lang.String prop, java.lang.String documentId) Find all spans in the named document that have a non-null value for this property.
TextBase	getTextBase() Returns the TextBase which is annotated by this TextLabels, or null if that isn't set yet.
java.util.Set<java.lang.String>	getTokenProperties() Get a set of all properties.
java.util.Set<java.lang.String>	getTypes() Return a set of all type names.
java.util.Set<Span>	getTypeSet(java.lang.String type, java.lang.String documentId) Return the Set of all Spans with a given type in a given document
boolean	hasDictionary(java.lang.String dictionary)
boolean	hasType(Span span, java.lang.String type) Query if a span has a given type.
boolean	inDict(Token token, java.lang.String dict) Returns true if the value of the Token is in the named dictionary.
java.util.Iterator<Span>	instanceIterator(java.lang.String type) Get all instances of a given type.
java.util.Iterator<Span>	instanceIterator(java.lang.String type, java.lang.String documentId) Get all instances of a given type.
boolean	isAnnotatedBy(java.lang.String s) See if the TextLabels contains a particular type of annotation
boolean	isType(java.lang.String type) True if the given string names a type.
void	require(java.lang.String annotationType, java.lang.String fileToLoad) Ensure that this TextLabels contains a particular type of annotation.
void	require(java.lang.String annotationType, java.lang.String fileToLoad, AnnotatorLoader loader) Ensure that this TextLabels contains a particular type of annotation.
java.lang.String	showTokenProp(TextBase base, java.lang.String prop) For debugging.

Method Detail

isAnnotatedBy

boolean isAnnotatedBy(java.lang.String s)

See if the TextLabels contains a particular type of annotation

require

void require(java.lang.String annotationType,
             java.lang.String fileToLoad)

Ensure that this TextLabels contains a particular type of annotation. If the annotation is not present, then either load it (if possible) or throw an error.

annotateWith

void annotateWith(java.lang.String annotationType,
                  java.lang.String fileToLoad)

Annotate labels with annotator named fileToLoad

require

void require(java.lang.String annotationType,
             java.lang.String fileToLoad,
             AnnotatorLoader loader)

Ensure that this TextLabels contains a particular type of annotation. If the annotation is not present, then either load it (if possible) or throw an error. Use the provided annotatorLoader to find annotators rather than the default one.

getTextBase

TextBase getTextBase()

Returns the TextBase which is annotated by this TextLabels, or null if that isn't set yet.

hasDictionary

boolean hasDictionary(java.lang.String dictionary)

Parameters:

dictionary - String name of the dictionary

Returns:

true if the dictionary is defined for these labels

inDict

boolean inDict(Token token,
               java.lang.String dict)

Returns true if the value of the Token is in the named dictionary.

getProperty

java.lang.String getProperty(Token token,
                             java.lang.String prop)

Get the property value associated with this TextToken.

getTokenProperties

java.util.Set<java.lang.String> getTokenProperties()

Get a set of all properties.

getProperty

java.lang.String getProperty(Span span,
                             java.lang.String prop)

Get the value of the named property which has been associated with this Span.

getSpansWithProperty

java.util.Iterator<Span> getSpansWithProperty(java.lang.String prop)

Find all spans that have a non-null value for this property.

getSpansWithProperty

java.util.Iterator<Span> getSpansWithProperty(java.lang.String prop,
                                              java.lang.String documentId)

Find all spans in the named document that have a non-null value for this property.

getSpanProperties

java.util.Set<java.lang.String> getSpanProperties()

Get a set of all previously-defined properties.

hasType

boolean hasType(Span span,
                java.lang.String type)

Query if a span has a given type.

instanceIterator

java.util.Iterator<Span> instanceIterator(java.lang.String type)

Get all instances of a given type.

instanceIterator

java.util.Iterator<Span> instanceIterator(java.lang.String type,
                                          java.lang.String documentId)

Get all instances of a given type.

getTypes

java.util.Set<java.lang.String> getTypes()

Return a set of all type names.

getTypeSet

java.util.Set<Span> getTypeSet(java.lang.String type,
                               java.lang.String documentId)

Return the Set of all Spans with a given type in a given document

isType

boolean isType(java.lang.String type)

True if the given string names a type.

closureIterator

java.util.Iterator<Span> closureIterator(java.lang.String type)

Returns the spans s for in the given type is 'closed'. If type T is close inside S, this means that one can apply the 'closed world assumption' and assume that the known set of spans of type T is complete, except for areas of the text that are not contained by any closure span S.

closureIterator

java.util.Iterator<Span> closureIterator(java.lang.String type,
                                         java.lang.String documentId)

Returns the spans S inside the given document in which the given type is 'closed'.

showTokenProp

java.lang.String showTokenProp(TextBase base,
                               java.lang.String prop)

For debugging. Returns a dump of all strings that have tokens with the given property.

getDetails

Details getDetails(Span span,
                   java.lang.String type)

Retrieve additional information associated with an assertion 'span S has type T'. Returns null if the span doesn't have the stated type.