|
|||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |
See:
Description
Interface Summary | |
---|---|
CoreAnnotation<V> | The base class for any annotation that can be marked on a CoreMap ,
parameterized by the type of the value associated with the annotation. |
CoreLabel.GenericAnnotation<T> | Class that all "generic" annotations extend. |
Datum<L,F> | Interface for Objects which can be described by their features. |
Document<L,F,T> | Represents a text document as a list of Words with a String title. |
Featurizable<F> | Interface for Objects that can be described by their features. |
HasCategory | Something that implements the HasCategory interface
knows about categories. |
HasContext | |
HasIndex | |
HasOffset | Something that implements the HasOffset interface
bears a offset reference to the original text |
HasTag | Something that implements the HasTag interface
knows about part-of-speech tags. |
HasWord | Something that implements the HasWord interface
knows about words. |
Label | Something that implements the Label interface can act as a
constituent, node, or word label with linguistic attributes. |
Labeled<E> | Interface for Objects that have a label, whose label is an Object. |
LabelFactory | A LabelFactory object acts as a factory for creating
objects of class Label , or some descendant class. |
Class Summary | |
---|---|
AnnotationLookup | |
BasicDatum<LabelType,FeatureType> | Basic implementation of Datum interface that can be constructed with a Collection of features and one more more labels. |
CategoryWordTag | A CategoryWordTag object acts as a complex Label
which contains a category, a head word, and a tag. |
CategoryWordTagFactory | A CategoryWordTagFactory is a factory that makes
a Label which is a CategoryWordTag triplet. |
CoreAnnotations |
Set of common annotations for CoreMap s. |
CoreAnnotations.AbbrAnnotation | |
CoreAnnotations.AbgeneAnnotation | |
CoreAnnotations.AbstrAnnotation | |
CoreAnnotations.AfterAnnotation | Annotation for the whitespace characters appear after this word. |
CoreAnnotations.AnswerAnnotation | The standard key for the answer which is a String |
CoreAnnotations.AnswerObjectAnnotation | |
CoreAnnotations.AntecedentAnnotation | The CoreMap key identifying the annotation's antecedent. |
CoreAnnotations.ArgDescendentAnnotation | |
CoreAnnotations.ArgumentAnnotation | The standard key for a propbank label which is of type Argument |
CoreAnnotations.BagOfWordsAnnotation | |
CoreAnnotations.BeAnnotation | annotation stolen from the lex parser |
CoreAnnotations.BeforeAnnotation | Annotation for the whitespace characters appearing before this word. |
CoreAnnotations.BeginIndexAnnotation | This indexes the beginning of a span of words, e.g., a constituent in a tree. |
CoreAnnotations.BestCliquesAnnotation | Used in Task3 Pascal system |
CoreAnnotations.BestFullAnnotation | |
CoreAnnotations.CalendarAnnotation | The CoreMap key identifying the date and time associated with an annotation. |
CoreAnnotations.CategoryAnnotation | |
CoreAnnotations.CategoryFunctionalTagAnnotation | The standard key for storing category with functional tags. |
CoreAnnotations.CharacterOffsetBeginAnnotation | The CoreMap key identifying the offset of the first character of an annotation. |
CoreAnnotations.CharacterOffsetEndAnnotation | The CoreMap key identifying the offset of the last character after the end of an annotation. |
CoreAnnotations.CharAnnotation | |
CoreAnnotations.ChineseCharAnnotation | for Chinese: character level information, segmentation |
CoreAnnotations.ChineseIsSegmentedAnnotation | Not sure exactly what this is, but it is different from ChineseSegAnnotation and seems to indicate if the text is segmented |
CoreAnnotations.ChineseOrigSegAnnotation | |
CoreAnnotations.ChineseSegAnnotation | |
CoreAnnotations.ChunkAnnotation | |
CoreAnnotations.CoarseTagAnnotation | CoNLL dep parsing - coarser POS tags. |
CoreAnnotations.CommonWordsAnnotation | |
CoreAnnotations.CoNLLDepAnnotation | CoNLL dep parsing - the dependency type |
CoreAnnotations.CoNLLDepParentIndexAnnotation | CoNLL dep parsing - the index of the word which is the parent of this word in the dependency tree |
CoreAnnotations.CoNLLDepTypeAnnotation | CoNLL dep parsing - the dependency type |
CoreAnnotations.CoNLLPredicateAnnotation | CoNLL SRL/dep parsing - whether the word is a predicate |
CoreAnnotations.CoNLLSRLAnnotation | CoNLL SRL/dep parsing - map which, for the current word, specifies its specific role for each predicate |
CoreAnnotations.ContextsAnnotation | |
CoreAnnotations.CopyAnnotation | Used in nlp.trees. |
CoreAnnotations.CostMagnificationAnnotation | Key for relative value of a word - used in RTE |
CoreAnnotations.CovertIDAnnotation | |
CoreAnnotations.D2_LBeginAnnotation | |
CoreAnnotations.D2_LEndAnnotation | |
CoreAnnotations.D2_LMiddleAnnotation | |
CoreAnnotations.DayAnnotation | |
CoreAnnotations.DependentsAnnotation | |
CoreAnnotations.DictAnnotation | |
CoreAnnotations.DistSimAnnotation | |
CoreAnnotations.DoAnnotation | annotation stolen from the lex parser |
CoreAnnotations.DocDateAnnotation | |
CoreAnnotations.DocIDAnnotation | This refers to the unique identifier for a "document", where document may vary based on your application. |
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 |
CoreAnnotations.EndIndexAnnotation | This indexes the end of a span of words, e.g., a constituent in a tree. |
CoreAnnotations.EntityClassAnnotation | |
CoreAnnotations.EntityRuleAnnotation | |
CoreAnnotations.EntityTypeAnnotation | |
CoreAnnotations.FeaturesAnnotation | The standard key for the features which is a Collection |
CoreAnnotations.FemaleGazAnnotation | |
CoreAnnotations.FirstChildAnnotation | used in binarized trees to specify the first child in the rule for which this node is the parent |
CoreAnnotations.ForcedSentenceEndAnnotation | This indicates the sentence should end at this token. |
CoreAnnotations.FreqAnnotation | |
CoreAnnotations.GazAnnotation | |
CoreAnnotations.GazetteerAnnotation | The standard key for the gazetteer information |
CoreAnnotations.GenericTokensAnnotation | The CoreMap key for getting the tokens (can be words, phrases or anything that are of type CoreMap) contained by an annotation. |
CoreAnnotations.GeniaAnnotation | |
CoreAnnotations.GoldAnswerAnnotation | The standard key for gold answer which is a String |
CoreAnnotations.GovernorAnnotation | |
CoreAnnotations.GrandparentAnnotation | specifies the base state of the parent of this node in the parse tree |
CoreAnnotations.HaveAnnotation | annotation stolen from the lex parser |
CoreAnnotations.HeadWordStringAnnotation | The key for storing a Head word as a string rather than a pointer (as in TreeCoreAnnotations.HeadWordAnnotation) |
CoreAnnotations.HeightAnnotation | Used in srl.unsup |
CoreAnnotations.IDAnnotation | |
CoreAnnotations.IDFAnnotation | Inverse document frequency of the word this label represents |
CoreAnnotations.INAnnotation | |
CoreAnnotations.IndexAnnotation | This indexes a token number inside a sentence. |
CoreAnnotations.InterpretationAnnotation | The standard key for the semantic interpretation |
CoreAnnotations.IsDateRangeAnnotation | it really seems like this should have a different name or else be a boolean |
CoreAnnotations.IsURLAnnotation | it really seems like this should have a different name or else be a boolean |
CoreAnnotations.LabelAnnotation | Used in wsd.supwsd package |
CoreAnnotations.LastGazAnnotation | |
CoreAnnotations.LastTaggedAnnotation | |
CoreAnnotations.LBeginAnnotation | Used in Gale2007ChineseSegmenter |
CoreAnnotations.LeftChildrenNodeAnnotation | used in incremental DAG parser |
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 |
CoreAnnotations.LemmaAnnotation | The CoreMap key for getting the lemma (morphological stem) of a token. |
CoreAnnotations.LEndAnnotation | |
CoreAnnotations.LengthAnnotation | |
CoreAnnotations.LMiddleAnnotation | |
CoreAnnotations.MaleGazAnnotation | |
CoreAnnotations.MarkingAnnotation | Another key used for propbank - to signify core arg nodes or predicate nodes |
CoreAnnotations.MonthAnnotation | Used in nlp.coref |
CoreAnnotations.MorphoCaseAnnotation | |
CoreAnnotations.MorphoGenAnnotation | |
CoreAnnotations.MorphoNumAnnotation | |
CoreAnnotations.MorphoPersAnnotation | |
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. |
CoreAnnotations.NeighborsAnnotation | |
CoreAnnotations.NERIDAnnotation | This is an NER ID annotation (in case the all caps parsing didn't work out for you...) |
CoreAnnotations.NormalizedNamedEntityTagAnnotation | The key for the normalized value of numeric named entities. |
CoreAnnotations.NotAnnotation | annotation stolen from the lex parser |
CoreAnnotations.NumericCompositeObjectAnnotation | |
CoreAnnotations.NumericCompositeTypeAnnotation | |
CoreAnnotations.NumericCompositeValueAnnotation | |
CoreAnnotations.NumericObjectAnnotation | |
CoreAnnotations.NumericTypeAnnotation | |
CoreAnnotations.NumericValueAnnotation | |
CoreAnnotations.NumerizedTokensAnnotation | |
CoreAnnotations.NumTxtSentencesAnnotation | Used by RTE to track number of text sentences, to determine when hyp sentences begin. |
CoreAnnotations.OriginalAnswerAnnotation | Seems like this could be consolidated with something else... |
CoreAnnotations.OriginalCharAnnotation | Seems like this could be consolidated with something else... |
CoreAnnotations.OriginalTextAnnotation | The exact original surface form of a token. |
CoreAnnotations.ParagraphAnnotation | used in dcoref. |
CoreAnnotations.ParagraphsAnnotation | The CoreMap key for getting the paragraphs contained by an annotation. |
CoreAnnotations.ParaPositionAnnotation | |
CoreAnnotations.ParentAnnotation | The standard key for the parent which is a String |
CoreAnnotations.PartOfSpeechAnnotation | The CoreMap key for getting the Penn part of speech of a token. |
CoreAnnotations.PercentAnnotation | annotation stolen from the lex parser |
CoreAnnotations.PhraseWordsAnnotation | |
CoreAnnotations.PhraseWordsTagAnnotation | |
CoreAnnotations.PolarityAnnotation | |
CoreAnnotations.PositionAnnotation | |
CoreAnnotations.PossibleAnswersAnnotation | |
CoreAnnotations.PredictedAnswerAnnotation | |
CoreAnnotations.PrevChildAnnotation | used in binarized trees to say the name of the most recent child |
CoreAnnotations.PriorAnnotation | Used in propbank.srl |
CoreAnnotations.ProjectedCategoryAnnotation | The standard key for storing a projected category in the map, as a String. |
CoreAnnotations.ProtoAnnotation | |
CoreAnnotations.RoleAnnotation | The standard key for the semantic role label of a phrase. |
CoreAnnotations.SectionAnnotation | |
CoreAnnotations.SemanticHeadTagAnnotation | The standard key for Semantic Head Word POS which is a String |
CoreAnnotations.SemanticHeadWordAnnotation | The standard key for Semantic Head Word which is a String |
CoreAnnotations.SemanticTagAnnotation | |
CoreAnnotations.SemanticWordAnnotation | |
CoreAnnotations.SentenceIDAnnotation | |
CoreAnnotations.SentenceIndexAnnotation | Unique identifier within a document for a given sentence. |
CoreAnnotations.SentencePositionAnnotation | |
CoreAnnotations.SentencesAnnotation | The CoreMap key for getting the sentences contained by an annotation. |
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. |
CoreAnnotations.SpaceBeforeAnnotation | Used in Chinese segmenters for whether there was space before a character. |
CoreAnnotations.SpanAnnotation | The standard key for span which is an IntPair |
CoreAnnotations.SpeakerAnnotation | used in dcoref. |
CoreAnnotations.SRLIDAnnotation | The key for semantic role labels (Note: please add to this description if you use this key) |
CoreAnnotations.SRLInstancesAnnotation | |
CoreAnnotations.StackedNamedEntityTagAnnotation | The CoreMap key for getting the token-level named entity tag (e.g., DATE, PERSON, etc.) from a previous NER tagger. |
CoreAnnotations.StateAnnotation | The base version of the parser state, like NP or VBZ or ... |
CoreAnnotations.StemAnnotation | Morphological stem of the word this label represents |
CoreAnnotations.SubcategorizationAnnotation | |
CoreAnnotations.TagLabelAnnotation | Used in Trees |
CoreAnnotations.TextAnnotation | The CoreMap key identifying the annotation's text. |
CoreAnnotations.TokenBeginAnnotation | The CoreMap key identifying the first token included in an annotation. |
CoreAnnotations.TokenEndAnnotation | The CoreMap key identifying the last token after the end of an annotation. |
CoreAnnotations.TokensAnnotation | The CoreMap key for getting the tokens contained by an annotation. |
CoreAnnotations.TopicAnnotation | Used for Topic Assignments from LDA or its equivalent models. |
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. |
CoreAnnotations.TrueCaseTextAnnotation | The CoreMap key identifying the annotation's true-cased text. |
CoreAnnotations.TrueTagAnnotation | |
CoreAnnotations.UBlockAnnotation | |
CoreAnnotations.UnaryAnnotation | whether the node is the parent in a unary rule |
CoreAnnotations.UnknownAnnotation | |
CoreAnnotations.UtteranceAnnotation | used in dcoref. |
CoreAnnotations.UTypeAnnotation | |
CoreAnnotations.ValueAnnotation | Contains the "value" - an ill-defined string used widely in MapLabel. |
CoreAnnotations.VerbSenseAnnotation | Probank key for the Verb sense given in the Propbank Annotation, should only be in the verbnode |
CoreAnnotations.WebAnnotation | |
CoreAnnotations.WordFormAnnotation | |
CoreAnnotations.WordnetSynAnnotation | |
CoreAnnotations.WordPositionAnnotation | |
CoreAnnotations.WordSenseAnnotation | |
CoreAnnotations.XmlContextAnnotation | |
CoreAnnotations.XmlElementAnnotation | Used in SimpleXMLAnnotator. |
CoreAnnotations.YearAnnotation | |
CoreLabel | A CoreLabel is a Map from keys (which are Class objects) to values, whose type is determined by the key. |
CyclicCoreLabel | Version of CoreLabel that allows for cycles in values/keys. |
LabeledWord | A LabeledWord object contains a word and its tag. |
RVFDatum<L,F> | A basic implementation of the Datum interface that can be constructed with a Collection of features and one more more labels. |
Sentence | Sentence holds a couple utility methods for lists. |
StringLabel | A StringLabel object acts as a Label by containing a
single String, which it sets or returns in response to requests. |
StringLabelFactory | A StringLabelFactory object makes a simple
StringLabel out of a String . |
TaggedWord | A TaggedWord object contains a word and its tag. |
TaggedWordFactory | A TaggedWordFactory acts as a factory for creating objects of
class TaggedWord . |
ValueLabel | A ValueLabel object acts as a Label with linguistic
attributes. |
Word | A Word object acts as a Label by containing a String. |
WordFactory | A WordFactory acts as a factory for creating objects of
class Word . |
WordLemmaTag | A WordLemmaTag corresponds to a pair of a tagged (e.g., for part of speech) word and its lemma. |
WordLemmaTagFactory | /**
A WordLemmaTagFactory acts as a factory for creating
objects of class WordLemmaTag . |
WordTag | A WordTag corresponds to a tagged (e.g., for part of speech) word and is implemented with String-valued word and tag. |
WordTagFactory | A WordTagFactory acts as a factory for creating
objects of class WordTag . |
Enum Summary | |
---|---|
AnnotationLookup.KeyLookup | |
CoreAnnotations.SRL_ID |
This package contains the different data structures used by JavaNLP throughout the years for dealing with linguistic objects in general, of which words are the most generally used. Most data structures in this package are deprecated. The current recommendation is to represent an annotated word as a CoreMap (e.g., an ArrayCoreMap) from the util package.
CoreMap is a basic type-safe data structure that maps keys to corresponding values, where each value's type must be consistent with the key's definition. The CoreAnnotations class in this package contains many common annotations used by different portions of JavaNLP, but you can define new keys locally to a package if they aren't of general applicability. See the CoreMap unit tests for an example usage of CoreMap and of defining a key.
The oldest code in JavaNLP uses various types of ValueLabel, and might expect data types from the Has* family (like HasWord, HasTag, et al., denoting presence or absence of that particular annotation). Second generation code made use of the MapLabel family (including AbstractMapLabel, FeatureLabel, and IndexedFeatureLabel), but this code has all been converted across to use CoreLabel. More modern code will use CoreMap as its basic data structure. CoreLabel is a CoreMap that unifies all the families of interfaces into a single view of an underlying (Array)CoreMap.
It is recommended that new code use the ArrayCoreMap class from the util package as the base representation of a word when possible. Any CoreMap can be presented as one of the older data structures (MapLabel, HasWord, etc.), by simply wrapping it in a CoreLabel "view" with CoreLabel.forCoreMap(map).
Legacy description: Classes for linguistic concepts which are common to many NLP classes, such as Word, Tag, etc. Also contains classes for building and operating on documents and data collections. Two of the basic interfaces are Document for representing a document as a list of words with meta-data, and DataCollection for representing a collection of documents. The most common document class you will probably use is BasicDocument, which provides support for constructing documents from a variety of input sources.
|
|||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |