edu.illinois.cs.cogcomp.annotation

Class BasicTextAnnotationBuilder

java.lang.Object

edu.illinois.cs.cogcomp.annotation.BasicTextAnnotationBuilder

All Implemented Interfaces:

TextAnnotationBuilder

public class BasicTextAnnotationBuilder
extends Object
implements TextAnnotationBuilder

A simple TextAnnotationBuilder that is meant to be used with pre-tokenized text (e.g. for training corpora).

To create TextAnnotations from plain text, you need a Tokenizer. See illinois-tokenizer for CogComp's default TextAnnotationBuilder.

Author:

Mark Sammons, Christos Christodoulopoulos, Narender Gupta

Field Summary

Fields inherited from interface edu.illinois.cs.cogcomp.annotation.TextAnnotationBuilder

SPLIT_ON_DASH

Constructor Summary

Constructors

Constructor and Description
BasicTextAnnotationBuilder()

Method Summary

Modifier and Type	Method and Description
TextAnnotation	createTextAnnotation(String text) A stub method that should not be call with this Builder.
TextAnnotation	createTextAnnotation(String corpusId, String textId, String text) A stub method that should not be call with this Builder.
TextAnnotation	createTextAnnotation(String corpusId, String textId, String text, Tokenizer.Tokenization tokenization) A method for creating TextAnnotation by respecting the pre-tokenization of text passed as an instance of Tokenizer.Tokenization.
static TextAnnotation	createTextAnnotationFromTokens(List<String[]> tokenizedSentences) The default way to create a TextAnnotation from pre-tokenized text.
static TextAnnotation	createTextAnnotationFromTokens(String corpusId, String textId, List<String[]> tokenizedSentences) The default way to create a TextAnnotation from pre-tokenized text.
String	getName()

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicTextAnnotationBuilder

public BasicTextAnnotationBuilder()

Method Detail

createTextAnnotationFromTokens

public static TextAnnotation createTextAnnotationFromTokens(List<String[]> tokenizedSentences)

The default way to create a TextAnnotation from pre-tokenized text.

Parameters:

tokenizedSentences - A list of sentences, each one being an array of tokens

Returns:

A TextAnnotation containing the SENTENCE and TOKENS views.

createTextAnnotationFromTokens

public static TextAnnotation createTextAnnotationFromTokens(String corpusId,
                                                            String textId,
                                                            List<String[]> tokenizedSentences)

The default way to create a TextAnnotation from pre-tokenized text.

Parameters:

tokenizedSentences - A list of sentences, each one being a list of tokens

Returns:

A TextAnnotation containing the SENTENCE and TOKENS views.

createTextAnnotation

public TextAnnotation createTextAnnotation(String text)
                                    throws IllegalArgumentException

A stub method that should not be call with this Builder. Please use createTextAnnotationFromTokens(java.util.List) instead.

To create a TextAnnotation from raw text, please use illinois-tokenizer

Specified by:

createTextAnnotation in interface TextAnnotationBuilder

Parameters:

text - Raw text string

Throws:

IllegalArgumentException

createTextAnnotation

public TextAnnotation createTextAnnotation(String corpusId,
                                           String textId,
                                           String text)
                                    throws IllegalArgumentException

A stub method that should not be call with this Builder. Please use createTextAnnotationFromTokens(java.util.List) instead.

To create a TextAnnotation from raw text, please use illinois-tokenizer

Specified by:

createTextAnnotation in interface TextAnnotationBuilder

text - Raw text string.

Throws:

IllegalArgumentException

createTextAnnotation

public TextAnnotation createTextAnnotation(String corpusId,
                                           String textId,
                                           String text,
                                           Tokenizer.Tokenization tokenization)
                                    throws IllegalArgumentException

Description copied from interface: TextAnnotationBuilder

A method for creating TextAnnotation by respecting the pre-tokenization of text passed as an instance of Tokenizer.Tokenization.

Specified by:

createTextAnnotation in interface TextAnnotationBuilder

text - Raw text string

tokenization - An instance containing tokens, character offsets, and sentence boundaries.

Throws:

IllegalArgumentException

getName

public String getName()

Specified by:

getName in interface TextAnnotationBuilder