CoreAnnotations (Stanford JavaNLP API)

java.lang.Object
- edu.stanford.nlp.ling.CoreAnnotations

```
public class CoreAnnotations
extends java.lang.Object
```
Set of common annotations for CoreMaps. The classes defined here are typesafe keys for getting and setting annotation values. These classes need not be instantiated outside of this class. e.g CoreAnnotations.TextAnnotation.class serves as the key and a String serves as the value containing the corresponding word.
New types of CoreAnnotation can be defined anywhere that is convenient in the source tree - they are just classes. This file exists to hold widely used "core" annotations and others inherited from the Label family. In general, most keys should be placed in this file as they may often be reused throughout the code. This architecture allows for flexibility, but in many ways it should be considered as equivalent to an enum in which everything should be defined
The getType method required by CoreAnnotation must return the same class type as its value type parameter. It feels like one should be able to get away without that method, but because Java erases the generic type signature, that info disappears at runtime. See CoreAnnotations.ValueAnnotation for an example.

Author:

dramage, rafferty, bethard

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CoreAnnotations.AbbrAnnotation`
`static class`	`CoreAnnotations.AbgeneAnnotation`
`static class`	`CoreAnnotations.AbstrAnnotation`
`static class`	`CoreAnnotations.AfterAnnotation` Annotation for the whitespace characters appear after this word.
`static class`	`CoreAnnotations.AnswerAnnotation` The standard key for the answer which is a String
`static class`	`CoreAnnotations.AnswerObjectAnnotation`
`static class`	`CoreAnnotations.AnswerProbAnnotation` The matching probability for the AnswerAnnotation
`static class`	`CoreAnnotations.AntecedentAnnotation` The CoreMap key identifying the annotation's antecedent.
`static class`	`CoreAnnotations.ArabicCharAnnotation` for Arabic: character level information, segmentation
`static class`	`CoreAnnotations.ArabicSegAnnotation` For Arabic: the segmentation information from the segmenter.
`static class`	`CoreAnnotations.ArgDescendentAnnotation`
`static class`	`CoreAnnotations.ArgumentAnnotation` The standard key for a propbank label which is of type Argument
`static class`	`CoreAnnotations.AuthorAnnotation` Author for the document (really should be a set of authors, but just have single string for simplicity)
`static class`	`CoreAnnotations.BagOfWordsAnnotation`
`static class`	`CoreAnnotations.BeAnnotation` annotation stolen from the lex parser
`static class`	`CoreAnnotations.BeforeAnnotation` Annotation for the whitespace characters appearing before this word.
`static class`	`CoreAnnotations.BeginIndexAnnotation` This indexes the beginning of a span of words, e.g., a constituent in a tree.
`static class`	`CoreAnnotations.BestCliquesAnnotation` Used in Task3 Pascal system
`static class`	`CoreAnnotations.BestFullAnnotation`
`static class`	`CoreAnnotations.CalendarAnnotation` The CoreMap key identifying the date and time associated with an annotation.
`static class`	`CoreAnnotations.CanonicalEntityMentionIndexAnnotation` Index into the list of entity mentions in a document for canonical entity mention.
`static class`	`CoreAnnotations.CategoryAnnotation`
`static class`	`CoreAnnotations.CategoryFunctionalTagAnnotation` The standard key for storing category with functional tags.
`static class`	`CoreAnnotations.CharacterOffsetBeginAnnotation` The CoreMap key identifying the offset of the first char of an annotation.
`static class`	`CoreAnnotations.CharacterOffsetEndAnnotation` The CoreMap key identifying the offset of the last character after the end of an annotation.
`static class`	`CoreAnnotations.CharAnnotation`
`static class`	`CoreAnnotations.ChineseCharAnnotation` For Chinese: character level information, segmentation.
`static class`	`CoreAnnotations.ChineseIsSegmentedAnnotation` Not sure exactly what this is, but it is different from ChineseSegAnnotation and seems to indicate if the text is segmented
`static class`	`CoreAnnotations.ChineseOrigSegAnnotation` For Chinese: the segmentation info existing in the original text.
`static class`	`CoreAnnotations.ChineseSegAnnotation` For Chinese: the segmentation information from the segmenter.
`static class`	`CoreAnnotations.ChunkAnnotation`
`static class`	`CoreAnnotations.CoarseNamedEntityTagAnnotation` The CoreMap key for getting the coarse named entity tag (i.e.
`static class`	`CoreAnnotations.CoarseTagAnnotation` CoNLL dep parsing - coarser POS tags.
`static class`	`CoreAnnotations.CodepointOffsetBeginAnnotation` Some codepoints count as more than one character.
`static class`	`CoreAnnotations.CodepointOffsetEndAnnotation` Some codepoints count as more than one character.
`static class`	`CoreAnnotations.ColumnDataClassifierAnnotation`
`static class`	`CoreAnnotations.CommonWordsAnnotation`
`static class`	`CoreAnnotations.CoNLLDepAnnotation` CoNLL dep parsing - the dependency type, such as SBJ or OBJ.
`static class`	`CoreAnnotations.CoNLLDepParentIndexAnnotation` CoNLL dep parsing - the index of the word which is the parent of this word in the dependency tree
`static class`	`CoreAnnotations.CoNLLDepTypeAnnotation` CoNLL dep parsing - the dependency type, such as SBJ or OBJ.
`static class`	`CoreAnnotations.CoNLLPredicateAnnotation` CoNLL SRL/dep parsing - whether the word is a predicate
`static class`	`CoreAnnotations.CoNLLSRLAnnotation` CoNLL SRL/dep parsing - map which, for the current word, specifies its specific role for each predicate
`static class`	`CoreAnnotations.CoNLLUFeats` CoNLL-U dep parsing - List of morphological features
`static class`	`CoreAnnotations.CoNLLUMisc` CoNLL-U dep parsing - Any other annotation
`static class`	`CoreAnnotations.CoNLLUSecondaryDepsAnnotation` CoNLL-U dep parsing - List of secondary dependencies
`static class`	`CoreAnnotations.CoNLLUTokenSpanAnnotation` CoNLL-U dep parsing - span of multiword tokens
`static class`	`CoreAnnotations.ContextsAnnotation`
`static class`	`CoreAnnotations.CorefMentionToEntityMentionMappingAnnotation` mapping from coref mentions to corresponding ner derived entity mentions
`static class`	`CoreAnnotations.CostMagnificationAnnotation` Key for relative value of a word - used in RTE
`static class`	`CoreAnnotations.CovertIDAnnotation`
`static class`	`CoreAnnotations.D2_LBeginAnnotation`
`static class`	`CoreAnnotations.D2_LEndAnnotation`
`static class`	`CoreAnnotations.D2_LMiddleAnnotation`
`static class`	`CoreAnnotations.DayAnnotation`
`static class`	`CoreAnnotations.DependentsAnnotation`
`static class`	`CoreAnnotations.DictAnnotation`
`static class`	`CoreAnnotations.DistSimAnnotation`
`static class`	`CoreAnnotations.DoAnnotation` annotation stolen from the lex parser
`static class`	`CoreAnnotations.DocDateAnnotation`
`static class`	`CoreAnnotations.DocIDAnnotation` This refers to the unique identifier for a "document", where document may vary based on your application.
`static class`	`CoreAnnotations.DocSourceTypeAnnotation` Document source type What kind of place did the document come from: newswire, discussion forum, web...
`static class`	`CoreAnnotations.DocTitleAnnotation` Document title What is the document title
`static class`	`CoreAnnotations.DocTypeAnnotation` Document type What kind of document is it: story, multi-part article, listing, email, etc
`static class`	`CoreAnnotations.DomainAnnotation` Used in CRFClassifier stuff PositionAnnotation should possibly be an int - it's present as either an int or string depending on context CharAnnotation may be "CharacterAnnotation" - not sure
`static class`	`CoreAnnotations.EndIndexAnnotation` This indexes the end of a span of words, e.g., a constituent in a tree.
`static class`	`CoreAnnotations.EntityClassAnnotation`
`static class`	`CoreAnnotations.EntityMentionIndexAnnotation` index into the list of entity mentions in a document
`static class`	`CoreAnnotations.EntityMentionToCorefMentionMappingAnnotation` Mapping from NER-derived entity mentions to coref mentions.
`static class`	`CoreAnnotations.EntityRuleAnnotation`
`static class`	`CoreAnnotations.EntityTypeAnnotation`
`static class`	`CoreAnnotations.ExceptionAnnotation` Stores an exception associated with processing this document
`static class`	`CoreAnnotations.FeaturesAnnotation` The standard key for the features which is a Collection
`static class`	`CoreAnnotations.FemaleGazAnnotation`
`static class`	`CoreAnnotations.FineGrainedNamedEntityTagAnnotation` The CoreMap key for getting the fine grained named entity tag (i.e.
`static class`	`CoreAnnotations.FirstChildAnnotation` used in binarized trees to specify the first child in the rule for which this node is the parent
`static class`	`CoreAnnotations.ForcedSentenceEndAnnotation` This indicates the sentence should end at this token.
`static class`	`CoreAnnotations.ForcedSentenceUntilEndAnnotation` This indicates that starting at this token, the sentence should not be ended until we see a ForcedSentenceEndAnnotation.
`static class`	`CoreAnnotations.FreqAnnotation`
`static class`	`CoreAnnotations.GazAnnotation` Possibly this should be grouped with gazetteer annotation - original key was "gaz".
`static class`	`CoreAnnotations.GazetteerAnnotation` The standard key for the gazetteer information
`static class`	`CoreAnnotations.GenderAnnotation` The CoreMap key identifying an entity mention's potential gender.
`static class`	`CoreAnnotations.GenericTokensAnnotation` The CoreMap key for getting the tokens (can be words, phrases or anything that are of type CoreMap) contained by an annotation.
`static class`	`CoreAnnotations.GeniaAnnotation`
`static class`	`CoreAnnotations.GoldAnswerAnnotation` The standard key for gold answer which is a String
`static class`	`CoreAnnotations.GovernorAnnotation`
`static class`	`CoreAnnotations.GrandparentAnnotation` specifies the base state of the parent of this node in the parse tree
`static class`	`CoreAnnotations.HaveAnnotation` annotation stolen from the lex parser
`static class`	`CoreAnnotations.HeadWordStringAnnotation` The key for storing a Head word as a string rather than a pointer (as in TreeCoreAnnotations.HeadWordAnnotation)
`static class`	`CoreAnnotations.HeightAnnotation` Used in srl.unsup
`static class`	`CoreAnnotations.IDAnnotation`
`static class`	`CoreAnnotations.IDFAnnotation` Inverse document frequency of the word this label represents
`static class`	`CoreAnnotations.INAnnotation`
`static class`	`CoreAnnotations.IndexAnnotation` This indexes a token number inside a sentence.
`static class`	`CoreAnnotations.InterpretationAnnotation` The standard key for the semantic interpretation
`static class`	`CoreAnnotations.IsDateRangeAnnotation` it really seems like this should have a different name or else be a boolean
`static class`	`CoreAnnotations.IsFirstWordOfMWTAnnotation` The CoreLabel key identifying whether a token is the first word derived from a multi-word-token.
`static class`	`CoreAnnotations.IsMultiWordTokenAnnotation` The CoreLabel key identifying whether a token is a multi-word-token This is attached to `CoreLabel`s.
`static class`	`CoreAnnotations.IsNewlineAnnotation` The CoreLabel key identifying whether a token is a newline or not This is attached to `CoreLabel`s.
`static class`	`CoreAnnotations.IsURLAnnotation` it really seems like this should have a different name or else be a boolean
`static class`	`CoreAnnotations.KBPTriplesAnnotation` An annotation for a sentence tagged with its KBP relation.
`static class`	`CoreAnnotations.LabelAnnotation` Used in wsd.supwsd package
`static class`	`CoreAnnotations.LabelIDAnnotation`
`static class`	`CoreAnnotations.LabelWeightAnnotation`
`static class`	`CoreAnnotations.LastGazAnnotation`
`static class`	`CoreAnnotations.LastTaggedAnnotation`
`static class`	`CoreAnnotations.LBeginAnnotation` Used in Gale2007ChineseSegmenter
`static class`	`CoreAnnotations.LeftChildrenNodeAnnotation` used in incremental DAG parser
`static class`	`CoreAnnotations.LeftTermAnnotation` The Standard key for storing the left terminal number relative to the root of the tree of the leftmost terminal dominated by the current node
`static class`	`CoreAnnotations.LemmaAnnotation` The CoreMap key for getting the lemma (morphological stem, lexeme form) of a token.
`static class`	`CoreAnnotations.LEndAnnotation`
`static class`	`CoreAnnotations.LengthAnnotation`
`static class`	`CoreAnnotations.LineNumberAnnotation` Line number for a sentence in a document delimited by newlines instead of punctuation.
`static class`	`CoreAnnotations.LinkAnnotation`
`static class`	`CoreAnnotations.LMiddleAnnotation`
`static class`	`CoreAnnotations.LocationAnnotation` Reference location for the document
`static class`	`CoreAnnotations.MaleGazAnnotation`
`static class`	`CoreAnnotations.MarkingAnnotation` Another key used for propbank - to signify core arg nodes or predicate nodes
`static class`	`CoreAnnotations.MentionsAnnotation`
`static class`	`CoreAnnotations.MentionTokenAnnotation` used in dcoref.
`static class`	`CoreAnnotations.MonthAnnotation` Used in nlp.coref
`static class`	`CoreAnnotations.MorphoCaseAnnotation`
`static class`	`CoreAnnotations.MorphoGenAnnotation`
`static class`	`CoreAnnotations.MorphoNumAnnotation`
`static class`	`CoreAnnotations.MorphoPersAnnotation`
`static class`	`CoreAnnotations.MWTTokenTextAnnotation` Text of the token that was used to create this word during a multi word token split.
`static class`	`CoreAnnotations.NamedEntityTagAnnotation` The CoreMap key for getting the token-level named entity tag (e.g., DATE, PERSON, etc.) This key is typically set on token annotations.
`static class`	`CoreAnnotations.NamedEntityTagProbsAnnotation` Label and probability pair representing the coarse grained label and probability
`static class`	`CoreAnnotations.NeighborsAnnotation`
`static class`	`CoreAnnotations.NERIDAnnotation` This is an NER ID annotation (in case the all caps parsing didn't work out for you...)
`static class`	`CoreAnnotations.NormalizedNamedEntityTagAnnotation` The key for the normalized value of numeric named entities.
`static class`	`CoreAnnotations.NotAnnotation` annotation stolen from the lex parser
`static class`	`CoreAnnotations.NumericCompositeObjectAnnotation` Annotation indicating the numeric object associated with an annotation.
`static class`	`CoreAnnotations.NumericCompositeTypeAnnotation` Annotation indicating the numeric value of the phrase the token is part of (twenty first => 21 21 ).
`static class`	`CoreAnnotations.NumericCompositeValueAnnotation` Annotation indicating whether the numeric phrase the token is part of represents a NUMBER or ORDINAL (twenty first => ORDINAL ORDINAL).
`static class`	`CoreAnnotations.NumericObjectAnnotation`
`static class`	`CoreAnnotations.NumericTypeAnnotation`
`static class`	`CoreAnnotations.NumericValueAnnotation`
`static class`	`CoreAnnotations.NumerizedTokensAnnotation`
`static class`	`CoreAnnotations.NumTxtSentencesAnnotation` Used by RTE to track number of text sentences, to determine when hyp sentences begin.
`static class`	`CoreAnnotations.OriginalCharAnnotation` Seems like this could be consolidated with something else...
`static class`	`CoreAnnotations.OriginalTextAnnotation` The exact original surface form of a token.
`static class`	`CoreAnnotations.ParagraphAnnotation` used in dcoref.
`static class`	`CoreAnnotations.ParagraphIndexAnnotation` used in ParagraphAnnotator.
`static class`	`CoreAnnotations.ParagraphsAnnotation` The CoreMap key for getting the paragraphs contained by an annotation.
`static class`	`CoreAnnotations.ParaPositionAnnotation`
`static class`	`CoreAnnotations.ParentAnnotation` The standard key for the parent which is a String
`static class`	`CoreAnnotations.PartOfSpeechAnnotation` The CoreMap key for getting the Penn part of speech of a token.
`static class`	`CoreAnnotations.PercentAnnotation` annotation stolen from the lex parser
`static class`	`CoreAnnotations.PhraseWordsAnnotation`
`static class`	`CoreAnnotations.PhraseWordsTagAnnotation`
`static class`	`CoreAnnotations.PolarityAnnotation`
`static class`	`CoreAnnotations.PositionAnnotation`
`static class`	`CoreAnnotations.PossibleAnswersAnnotation`
`static class`	`CoreAnnotations.PredictedAnswerAnnotation`
`static class`	`CoreAnnotations.PresetAnswerAnnotation` The standard key for the answer which is a String
`static class`	`CoreAnnotations.PrevChildAnnotation` used in binarized trees to say the name of the most recent child
`static class`	`CoreAnnotations.PriorAnnotation` Used in propbank.srl
`static class`	`CoreAnnotations.ProtoAnnotation`
`static class`	`CoreAnnotations.QuotationIndexAnnotation` Unique identifier within a document for a given quotation.
`static class`	`CoreAnnotations.QuotationsAnnotation` The CoreMap key for getting the quotations contained by an annotation.
`static class`	`CoreAnnotations.QuotedAnnotation` Indicate whether a sentence is quoted
`static class`	`CoreAnnotations.QuotesAnnotation` Store a list of CoreMaps representing quotes
`static class`	`CoreAnnotations.RoleAnnotation` The standard key for the semantic role label of a phrase.
`static class`	`CoreAnnotations.SectionAnnotation` Section of a document
`static class`	`CoreAnnotations.SectionAuthorCharacterOffsetBeginAnnotation` Store the beginning of the author mention for this section
`static class`	`CoreAnnotations.SectionAuthorCharacterOffsetEndAnnotation` Store the end of the author mention for this section
`static class`	`CoreAnnotations.SectionDateAnnotation` Date for a section of a document
`static class`	`CoreAnnotations.SectionEndAnnotation` Indicates that the token end a section and the label of the section
`static class`	`CoreAnnotations.SectionIDAnnotation` Id for a section of a document
`static class`	`CoreAnnotations.SectionIndexAnnotation` Store an index into a list of sections
`static class`	`CoreAnnotations.SectionsAnnotation` Store a list of sections in the document
`static class`	`CoreAnnotations.SectionStartAnnotation` Indicates that the token starts a new section and the attributes that should go into that section
`static class`	`CoreAnnotations.SectionTagAnnotation` Store the xml tag for the section as a CoreLabel
`static class`	`CoreAnnotations.SemanticHeadTagAnnotation` The standard key for Semantic Head Word POS which is a String
`static class`	`CoreAnnotations.SemanticHeadWordAnnotation` The standard key for Semantic Head Word which is a String
`static class`	`CoreAnnotations.SemanticTagAnnotation`
`static class`	`CoreAnnotations.SemanticWordAnnotation`
`static class`	`CoreAnnotations.SentenceBeginAnnotation` The index of the sentence that this annotation begins in.
`static class`	`CoreAnnotations.SentenceEndAnnotation` The index of the sentence that this annotation begins in.
`static class`	`CoreAnnotations.SentenceIDAnnotation`
`static class`	`CoreAnnotations.SentenceIndexAnnotation` Unique identifier within a document for a given sentence.
`static class`	`CoreAnnotations.SentencePositionAnnotation`
`static class`	`CoreAnnotations.SentencesAnnotation` The CoreMap key for getting the sentences contained in an annotation.
`static class`	`CoreAnnotations.ShapeAnnotation` The standard key for the "shape" of a word: a String representing the type of characters in a word, such as "Xx" for a capitalized word.
`static class`	`CoreAnnotations.SpaceBeforeAnnotation` Used in Chinese segmenters for whether there was space before a character.
`static class`	`CoreAnnotations.SpanAnnotation` The standard key for span which is an IntPair
`static class`	`CoreAnnotations.SpeakerAnnotation` used in dcoref.
`static class`	`CoreAnnotations.SpeakerTypeAnnotation` used to store speaker type information for coref
`static class`	`CoreAnnotations.SRL_ID`
`static class`	`CoreAnnotations.SRLIDAnnotation` The key for semantic role labels (Note: please add to this description if you use this key)
`static class`	`CoreAnnotations.SRLInstancesAnnotation`
`static class`	`CoreAnnotations.StackedNamedEntityTagAnnotation` The CoreMap key for getting the token-level named entity tag (e.g., DATE, PERSON, etc.) from a previous NER tagger.
`static class`	`CoreAnnotations.StateAnnotation` The base version of the parser state, like NP or VBZ or ...
`static class`	`CoreAnnotations.StatementTextAnnotation` The CoreMap key identifying the annotation's text, as formatted by the `QuestionToStatementTranslator`.
`static class`	`CoreAnnotations.StemAnnotation` Stem of the word this label represents.
`static class`	`CoreAnnotations.SubcategorizationAnnotation`
`static class`	`CoreAnnotations.TagLabelAnnotation` Used in Trees
`static class`	`CoreAnnotations.TextAnnotation` The CoreMap key identifying the annotation's text.
`static class`	`CoreAnnotations.TokenBeginAnnotation` The CoreMap key identifying the first token included in an annotation.
`static class`	`CoreAnnotations.TokenEndAnnotation` The CoreMap key identifying the last token after the end of an annotation.
`static class`	`CoreAnnotations.TokensAnnotation` The CoreMap key for getting the tokens contained by an annotation.
`static class`	`CoreAnnotations.TopicAnnotation` Used for Topic Assignments from LDA or its equivalent models.
`static class`	`CoreAnnotations.TrueCaseAnnotation` The CoreMap key for getting the token-level true case annotation (e.g., INIT_UPPER) This key is typically set on token annotations.
`static class`	`CoreAnnotations.TrueCaseTextAnnotation` The CoreMap key identifying the annotation's true-cased text.
`static class`	`CoreAnnotations.TrueTagAnnotation`
`static class`	`CoreAnnotations.UBlockAnnotation`
`static class`	`CoreAnnotations.UnaryAnnotation` whether the node is the parent in a unary rule
`static class`	`CoreAnnotations.UnclosedQuotationsAnnotation` The CoreMap key for getting the quotations contained by an annotation.
`static class`	`CoreAnnotations.UnknownAnnotation` Note: this is not a catchall "unknown" annotation but seems to have a specific meaning for sequence classifiers
`static class`	`CoreAnnotations.UseMarkedDiscourseAnnotation` used in dcoref.
`static class`	`CoreAnnotations.UtteranceAnnotation` used in dcoref.
`static class`	`CoreAnnotations.UTypeAnnotation`
`static class`	`CoreAnnotations.ValueAnnotation` Contains the "value" - an ill-defined string used widely in MapLabel.
`static class`	`CoreAnnotations.VerbSenseAnnotation` Probank key for the Verb sense given in the Propbank Annotation, should only be in the verbnode
`static class`	`CoreAnnotations.WebAnnotation`
`static class`	`CoreAnnotations.WikipediaEntityAnnotation` An annotation for the Wikipedia page (i.e., canonical name) associated with this token.
`static class`	`CoreAnnotations.WordFormAnnotation`
`static class`	`CoreAnnotations.WordnetSynAnnotation`
`static class`	`CoreAnnotations.WordPositionAnnotation`
`static class`	`CoreAnnotations.WordSenseAnnotation`
`static class`	`CoreAnnotations.XmlContextAnnotation` Used in CleanXMLAnnotator.
`static class`	`CoreAnnotations.XmlElementAnnotation` Used in SimpleXMLAnnotator.
`static class`	`CoreAnnotations.YearAnnotation`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Class CoreAnnotations

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object