Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## edu.stanford.nlp.ling
Class CoreAnnotations

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

    public class CoreAnnotations

extends Object

Set of common annotations for `CoreMap`'s. 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.WordAnnotation`.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
`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.ArgDescendentAnnotation`
`static class` | `CoreAnnotations.ArgumentAnnotation` The standard key for a propbank label which is of type Argument
`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.BestCliquesAnnotation` Used in Task3 Pascal system
`static class` | `CoreAnnotations.BestFullAnnotation`
`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 character 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`
`static class` | `CoreAnnotations.ChineseSegAnnotation`
`static class` | `CoreAnnotations.ChunkAnnotation`
`static class` | `CoreAnnotations.CoarseTagAnnotation` CoNLL dep parsing - coarser POS tags.
`static class` | `CoreAnnotations.CoNLLDepAnnotation` CoNLL dep parsing - the dependency type
`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
`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.ContextsAnnotation`
`static class` | `CoreAnnotations.CopyAnnotation` Used in nlp.trees
`static class` | `CoreAnnotations.CorefAnnotation` the standard key for the coref label.
`static class` | `CoreAnnotations.CorefDestAnnotation` Destination of the coreference link for this word (if any): it contains the index of the sentence and the index of the word that are the end of this coref link Both indeces start at 1 The sentence index is IntTuple.get(0); the token index in the sentence is IntTuple.get(1)
`static class` | `CoreAnnotations.CostMagnificationAnnotation` Key for relative value of a word - used in RTE
`static class` | `CoreAnnotations.CovertIDAnnotation`
`static class` | `CoreAnnotations.CurrentAnnotation` From the invertible PTB tokenizer - the actual, original current word.
`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.DocIDAnnotation` This refers to the unique identifier for a "document", where document may vary based on your application.
`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.EntityClassAnnotation`
`static class` | `CoreAnnotations.EntityRuleAnnotation`
`static class` | `CoreAnnotations.EntityTypeAnnotation`
`static class` | `CoreAnnotations.FeaturesAnnotation` The standard key for the features which is a Collection
`static class` | `CoreAnnotations.FemaleGazAnnotation`
`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.FreqAnnotation`
`static class` | `CoreAnnotations.GazAnnotation`
`static class` | `CoreAnnotations.GazetteerAnnotation` The standard key for the gazetteer information
`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 is generally an individual word or feature index - it is local, and may not be uniquely identifying without other identifiers such as sentence and doc.
`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.IsURLAnnotation` it really seems like this should have a different name or else be a boolean
`static class` | `CoreAnnotations.LabelAnnotation` Used in wsd.supwsd package
`static class` | `CoreAnnotations.LastGazAnnotation`
`static class` | `CoreAnnotations.LastTaggedAnnotation`
`static class` | `CoreAnnotations.LBeginAnnotation` Used in Gale2007ChineseSegmenter
`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) of a token.
`static class` | `CoreAnnotations.LEndAnnotation`
`static class` | `CoreAnnotations.LengthAnnotation`
`static class` | `CoreAnnotations.LMiddleAnnotation`
`static class` | `CoreAnnotations.MaleGazAnnotation`
`static class` | `CoreAnnotations.MarkingAnnotation` Another key used for propbank - to signify core arg nodes or predicate nodes
`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.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.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.NormalizedNERAnnotation` The key for the normalized value of numeric named entities.
`static class` | `CoreAnnotations.NotAnnotation` annotation stolen from the lex parser
`static class` | `CoreAnnotations.NumTxtSentencesAnnotation` Used by RTE to track number of text sentences, to determine when hyp sentences begin.
`static class` | `CoreAnnotations.OriginalAnswerAnnotation` Seems like this could be consolidated with something else...
`static class` | `CoreAnnotations.OriginalCharAnnotation` Seems like this could be consolidated with something else...
`static class` | `CoreAnnotations.ParaPosAnnotation`
`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.PolarityAnnotation`
`static class` | `CoreAnnotations.PositionAnnotation`
`static class` | `CoreAnnotations.PossibleAnswersAnnotation`
`static class` | `CoreAnnotations.PredictedAnswerAnnotation`
`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.ProjectedCategoryAnnotation` The standard key for storing a projected category in the map, as a String.
`static class` | `CoreAnnotations.RoleAnnotation` The standard key for the semantic role label of a phrase.
`static class` | `CoreAnnotations.SectionAnnotation`
`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.SentenceIDAnnotation`
`static class` | `CoreAnnotations.SentenceIndexAnnotation` Unique identifier within a document for a given sentence.
`static class` | `CoreAnnotations.SentencePosAnnotation`
`static class` | `CoreAnnotations.SentencesAnnotation` The CoreMap key for getting the sentences contained by 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.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.StateAnnotation` The base version of the parser state, like NP or VBZ or ...
`static class` | `CoreAnnotations.StemAnnotation` Morphological 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.TreeAnnotation` The CoreMap key for getting the syntactic parse tree of a sentence.
`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.UnknownAnnotation`
`static class` | `CoreAnnotations.UTypeAnnotation`
`static class` | `CoreAnnotations.ValueAnnotation` Contains the "value" - an ill-defined string used widely in MapLabel.
`static class` | `CoreAnnotations.ValueLabelAnnotation`
`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.WordAnnotation` The CoreMap key identifying the text of a token.
`static class` | `CoreAnnotations.WordFormAnnotation`
`static class` | `CoreAnnotations.WordPosAnnotation`
`static class` | `CoreAnnotations.WordSenseAnnotation`
`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`

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Stanford NLP Group