edu.stanford.nlp.pipeline

Class QuoteAnnotator

java.lang.Object

edu.stanford.nlp.pipeline.QuoteAnnotator

All Implemented Interfaces:

Annotator

public class QuoteAnnotator
extends Object
implements Annotator

An annotator which picks quotations out of the given text. Allows for embedded quotations so long as they are of a different type of quote than the outer quotations (e.g. "'Gadzooks' is what he said to me" is legal whereas "They called me "Danger" when I was..." is illegal.) Uses regular-expression-like rules to find quotes and does not depend on the tokenizer, which allows quotes like ''Tis true!' to be correctly identified. Only considers " and ' characters presently (1/23/2015).

Author:

Grace Muzny

Nested Class Summary

Nested classes/interfaces inherited from interface edu.stanford.nlp.pipeline.Annotator

Annotator.Requirement

Field Summary

Fields

Modifier and Type	Field and Description
boolean	closeUnclosedQuotes
static Map<String,String>	DIRECTED_QUOTES
static String[]	QUOTES

Fields inherited from interface edu.stanford.nlp.pipeline.Annotator

BINARIZED_TREES_REQUIREMENT, CLEAN_XML_REQUIREMENT, COLUMN_DATA_CLASSIFIER, DETERMINISTIC_COREF_REQUIREMENT, GENDER_REQUIREMENT, GUTIME_REQUIREMENT, HEIDELTIME_REQUIREMENT, LEMMA_REQUIREMENT, NATLOG_REQUIREMENT, NER_REQUIREMENT, NUMBER_REQUIREMENT, PARSE_AND_TAG, PARSE_REQUIREMENT, PARSE_TAG_BINARIZED_TREES, POS_REQUIREMENT, QUANTIFIABLE_ENTITY_NORMALIZATION_REQUIREMENT, QUOTE_REQUIREMENT, RELATION_EXTRACTOR_REQUIREMENT, SSPLIT_REQUIREMENT, STANFORD_CLEAN_XML, STANFORD_COLUMN_DATA_CLASSIFIER, STANFORD_DEPENDENCIES, STANFORD_DETERMINISTIC_COREF, STANFORD_ENTITY_MENTIONS, STANFORD_GENDER, STANFORD_LEMMA, STANFORD_NATLOG, STANFORD_NER, STANFORD_PARSE, STANFORD_POS, STANFORD_QUOTE, STANFORD_REGEXNER, STANFORD_RELATION, STANFORD_SENTIMENT, STANFORD_SSPLIT, STANFORD_TOKENIZE, STANFORD_TRUECASE, STEM_REQUIREMENT, SUTIME_REQUIREMENT, TIME_WORDS_REQUIREMENT, TOKENIZE_AND_SSPLIT, TOKENIZE_REQUIREMENT, TOKENIZE_SSPLIT_NER, TOKENIZE_SSPLIT_PARSE, TOKENIZE_SSPLIT_PARSE_NER, TOKENIZE_SSPLIT_POS, TOKENIZE_SSPLIT_POS_LEMMA, TRUECASE_REQUIREMENT

Constructor Summary

Constructors

Constructor and Description
QuoteAnnotator(Properties props) Return a QuoteAnnotator that isolates quotes denoted by the ASCII characters " and '.
QuoteAnnotator(Properties props, boolean verbose) Return a QuoteAnnotator that isolates quotes denoted by the ASCII characters " and '.

Method Summary

Modifier and Type	Method and Description
void	annotate(Annotation annotation) Given an Annotation, perform a task on this Annotation.
static List<CoreMap>	getCoreMapQuotes(List<Pair<Integer,Integer>> quotes, List<CoreLabel> tokens, String text, String docID)
static Comparator<CoreMap>	getQuoteComparator()
static List<Pair<Integer,Integer>>	getQuotes(String text)
static boolean	isSingleQuote(String c)
static boolean	isWhitespaceOrPunct(String c)
static Annotation	makeQuote(String text, int begin, int end, List<CoreLabel> quoteTokens, int currQuoteSize, int tokenOffset, String docID)
static List<Pair<Integer,Integer>>	recursiveQuotes(String text, int offset, String prevQuote)
Set<Annotator.Requirement>	requirementsSatisfied() Returns a set of requirements for which tasks this annotator can provide.
Set<Annotator.Requirement>	requires() Returns the set of tasks which this annotator requires in order to perform.

Methods inherited from class java.lang.Object

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

Field Detail

DIRECTED_QUOTES

public static final Map<String,String> DIRECTED_QUOTES

QUOTES

public static final String[] QUOTES

closeUnclosedQuotes

public final boolean closeUnclosedQuotes

See Also:

Constant Field Values

Constructor Detail

QuoteAnnotator

public QuoteAnnotator(Properties props)

Return a QuoteAnnotator that isolates quotes denoted by the ASCII characters " and '. If an unclosed quote appears, by default, this quote will not be counted as a quote.

Parameters:

props - Properties object that contains the customizable properties attributes.

QuoteAnnotator

public QuoteAnnotator(Properties props,
                      boolean verbose)

Return a QuoteAnnotator that isolates quotes denoted by the ASCII characters " and '. If an unclosed quote appears, by default, this quote will not be counted as a quote.

Parameters:

props - Properties object that contains the customizable properties attributes.

verbose - whether or not to output verbose information.

Method Detail

annotate

public void annotate(Annotation annotation)

Description copied from interface: Annotator

Given an Annotation, perform a task on this Annotation.

Specified by:

annotate in interface Annotator

getQuoteComparator

public static Comparator<CoreMap> getQuoteComparator()

getCoreMapQuotes

public static List<CoreMap> getCoreMapQuotes(List<Pair<Integer,Integer>> quotes,
                                             List<CoreLabel> tokens,
                                             String text,
                                             String docID)

makeQuote

public static Annotation makeQuote(String text,
                                   int begin,
                                   int end,
                                   List<CoreLabel> quoteTokens,
                                   int currQuoteSize,
                                   int tokenOffset,
                                   String docID)

getQuotes

public static List<Pair<Integer,Integer>> getQuotes(String text)

recursiveQuotes

public static List<Pair<Integer,Integer>> recursiveQuotes(String text,
                                                          int offset,
                                                          String prevQuote)

isWhitespaceOrPunct

public static boolean isWhitespaceOrPunct(String c)

isSingleQuote

public static boolean isSingleQuote(String c)

requires

public Set<Annotator.Requirement> requires()

Description copied from interface: Annotator

Returns the set of tasks which this annotator requires in order to perform. For example, the POS annotator will return "tokenize", "ssplit".

Specified by:

requires in interface Annotator

requirementsSatisfied

public Set<Annotator.Requirement> requirementsSatisfied()

Description copied from interface: Annotator

Returns a set of requirements for which tasks this annotator can provide. For example, the POS annotator will return "pos".

Specified by:

requirementsSatisfied in interface Annotator