|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.stanford.nlp.util.ArrayCoreMap
edu.stanford.nlp.ling.CoreLabel
public class CoreLabel
A CoreLabel is a Map from keys (which are Class objects) to values, whose type is determined by the key. That is, it is a heterogeneous typesafe Map (see Josh Bloch, Effective Java, 2nd edition).
The CoreLabel class in particular bridges the gap between old-style JavaNLP
Labels and the new CoreMap infrastructure. Instances of this class can be
used (almost) anywhere that the now-defunct FeatureLabel family could be
used. This data structure is backed by an ArrayCoreMap
.
Nested Class Summary | |
---|---|
static interface |
CoreLabel.GenericAnnotation<T>
Class that all "generic" annotations extend. |
Nested classes/interfaces inherited from interface edu.stanford.nlp.util.TypesafeMap |
---|
TypesafeMap.Key<BASE,VALUE> |
Field Summary | |
---|---|
static HashMap<String,Class<? extends CoreLabel.GenericAnnotation>> |
genericKeys
|
static HashMap<Class<? extends CoreLabel.GenericAnnotation>,String> |
genericValues
|
static String |
TAG_SEPARATOR
Tag separator to use by default |
Constructor Summary | |
---|---|
CoreLabel()
Default constructor, calls super() |
|
CoreLabel(CoreLabel label)
Returns a new CoreLabel instance based on the contents of the given CoreLabel. |
|
CoreLabel(CoreMap label)
Returns a new CoreLabel instance based on the contents of the given CoreMap. |
|
CoreLabel(int capacity)
Initializes this CoreLabel, pre-allocating arrays to hold up to capacity key,value pairs. |
|
CoreLabel(Label label)
Returns a new CoreLabel instance based on the contents of the given label. |
|
CoreLabel(String[] keys,
String[] values)
This constructor attempts to parse the String keys into Class keys. |
Method Summary | ||
---|---|---|
String |
after()
Return the whitespace String after the word. |
|
String |
before()
|
|
int |
beginPosition()
Return the beginning character offset of the label (or -1 if none). |
|
String |
category()
Return the category value of the label (or null if none). |
|
String |
docID()
|
|
int |
endPosition()
Return the ending character offset of the label (or -1 if none). |
|
static LabelFactory |
factory()
Return a factory for this kind of label |
|
|
getString(Class<KEY> key)
Return a non-null String value for a key. |
|
int |
index()
|
|
LabelFactory |
labelFactory()
Returns a factory that makes labels of the exact same type as this one. |
|
String |
lemma()
Return the lemma of the label (or null if none). |
|
String |
ner()
Return the named entity class of the label (or null if none). |
|
String |
originalText()
Return the String which is the original character sequence of the token. |
|
int |
sentIndex()
|
|
void |
setAfter(String after)
Set the whitespace String after the word. |
|
void |
setBefore(String before)
Set the whitespace String before the word. |
|
void |
setBeginPosition(int beginPos)
Set the beginning character offset for the label. |
|
void |
setCategory(String category)
Set the category value for the label (if one is stored). |
|
void |
setDocID(String docID)
|
|
void |
setEndPosition(int endPos)
Set the ending character offset of the label (or -1 if none). |
|
void |
setFromString(String labelStr)
Set the contents of this label to this String
representing the
complete contents of the label. |
|
void |
setIndex(int index)
|
|
void |
setLemma(String lemma)
|
|
void |
setNER(String ner)
|
|
void |
setOriginalText(String originalText)
Set the String which is the original character sequence of the token. |
|
void |
setSentIndex(int sentIndex)
|
|
void |
setTag(String tag)
Set the tag value for the label (if one is stored). |
|
void |
setValue(String value)
Set the value for the label (if one is stored). |
|
void |
setWord(String word)
Set the word value for the label (if one is stored). |
|
String |
tag()
Return the tag value of the label (or null if none). |
|
String |
value()
Return a String representation of just the "main" value of this label. |
|
String |
word()
Return the word value of the label (or null if none). |
Methods inherited from class edu.stanford.nlp.util.ArrayCoreMap |
---|
compact, containsKey, equals, get, has, hashCode, keySet, remove, set, setCapacity, size, toShorterString, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface edu.stanford.nlp.ling.Label |
---|
toString |
Field Detail |
---|
public static HashMap<String,Class<? extends CoreLabel.GenericAnnotation>> genericKeys
public static HashMap<Class<? extends CoreLabel.GenericAnnotation>,String> genericValues
public static final String TAG_SEPARATOR
Constructor Detail |
---|
public CoreLabel()
public CoreLabel(int capacity)
capacity
- Initial capacity of object in key,value pairspublic CoreLabel(CoreLabel label)
label
- The CoreLabel to copypublic CoreLabel(CoreMap label)
label
- The CoreMap to copypublic CoreLabel(Label label)
label
- Basis for this labelpublic CoreLabel(String[] keys, String[] values)
CoreAnnotations
.
keys
- Array of Strings that are class namesvalues
- Array of values (as String)Method Detail |
---|
public static LabelFactory factory()
public LabelFactory labelFactory()
null
if no appropriate factory is known.
labelFactory
in interface Label
public <KEY extends TypesafeMap.Key<CoreMap,String>> String getString(Class<KEY> key)
KEY
- A key type with a String valuekey
- The key to return the value of.
null
and the String value of the key otherwisepublic void setFromString(String labelStr)
String
representing the
complete contents of the label. A class implementing label may
throw an UnsupportedOperationException
for this
method (only). Typically, this method would do
some appropriate decoding of the string in a way that sets
multiple fields in an inverse of the toString()
method.
setFromString
in interface Label
labelStr
- the String that translates into the content of the
labelpublic final void setValue(String value)
setValue
in interface Label
value
- - the value for the labelpublic final String value()
value
in interface Label
public void setWord(String word)
setWord
in interface HasWord
word
- The word value for the labelpublic String word()
word
in interface HasWord
public void setTag(String tag)
setTag
in interface HasTag
tag
- The tag value for the labelpublic String tag()
tag
in interface HasTag
public void setCategory(String category)
setCategory
in interface HasCategory
category
- The category value for the labelpublic String category()
category
in interface HasCategory
public void setAfter(String after)
setAfter
in interface HasContext
after
- The whitespace String after the wordpublic String after()
after
in interface HasContext
public void setBefore(String before)
setBefore
in interface HasContext
before
- the whitespace String before the wordpublic String before()
before
in interface HasContext
public void setOriginalText(String originalText)
setOriginalText
in interface HasContext
originalText
- The original character sequence of the tokenpublic String originalText()
originalText
in interface HasContext
public String docID()
docID
in interface HasIndex
public void setDocID(String docID)
setDocID
in interface HasIndex
public String ner()
public void setNER(String ner)
public String lemma()
public void setLemma(String lemma)
public int index()
index
in interface HasIndex
public void setIndex(int index)
setIndex
in interface HasIndex
public int sentIndex()
sentIndex
in interface HasIndex
public void setSentIndex(int sentIndex)
setSentIndex
in interface HasIndex
public int beginPosition()
HasOffset
beginPosition
in interface HasOffset
public int endPosition()
HasOffset
endPosition
in interface HasOffset
public void setBeginPosition(int beginPos)
HasOffset
setBeginPosition
in interface HasOffset
beginPos
- The beginning positionpublic void setEndPosition(int endPos)
HasOffset
setEndPosition
in interface HasOffset
endPos
- The end character offset for the label
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |