de.tudarmstadt.ukp.dkpro.core.api.metadata.type

Class MetaDataStringField

java.lang.Object

org.apache.uima.cas.impl.FeatureStructureImpl

org.apache.uima.jcas.cas.TOP

org.apache.uima.jcas.cas.AnnotationBase

org.apache.uima.jcas.tcas.Annotation

de.tudarmstadt.ukp.dkpro.core.api.metadata.type.MetaDataStringField

All Implemented Interfaces:

Cloneable, org.apache.uima.cas.AnnotationBaseFS, org.apache.uima.cas.FeatureStructure, org.apache.uima.cas.text.AnnotationFS

public class MetaDataStringField
extends org.apache.uima.jcas.tcas.Annotation

A general purpose annotation to store document-wide information in the form of arbitrary key-value string pairs.

Updated by JCasGen Wed Jan 03 03:06:21 CET 2018 XML source: /Users/bluefire/git/dkpro-core/target/checkout/dkpro-core-api-metadata-asl/target/jcasgen/typesystem.xml

Field Summary

Fields

Modifier and Type	Field and Description
static int	type
static int	typeIndexID

Fields inherited from class org.apache.uima.jcas.cas.TOP

addr, jcasType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MetaDataStringField() Never called.
	MetaDataStringField(int addr, org.apache.uima.jcas.cas.TOP_Type type) Internal - constructor used by generator
	MetaDataStringField(org.apache.uima.jcas.JCas jcas)
	MetaDataStringField(org.apache.uima.jcas.JCas jcas, int begin, int end)

Method Summary

Modifier and Type	Method and Description
String	getKey() getter for key - gets Name of a metadata field.
int	getTypeIndexID()
String	getValue() getter for value - gets The field value.
void	setKey(String v) setter for key - sets Name of a metadata field.
void	setValue(String v) setter for value - sets The field value.

Methods inherited from class org.apache.uima.jcas.tcas.Annotation

getBegin, getCoveredText, getEnd, getStart, setBegin, setEnd

Methods inherited from class org.apache.uima.jcas.cas.AnnotationBase

getSofa, getView

Methods inherited from class org.apache.uima.jcas.cas.TOP

addToIndexes, addToIndexes, equals, getAddress, getCAS, getCASImpl, getLowLevelCas, hashCode, removeFromIndexes, removeFromIndexes

Methods inherited from class org.apache.uima.cas.impl.FeatureStructureImpl

clone, getavoidcollisionTypeCode, getBooleanValue, getByteValue, getDoubleValue, getFeatureValue, getFeatureValueAsString, getFloatValue, getIntValue, getLongValue, getShortValue, getStringValue, getType, prettyPrint, prettyPrint, prettyPrint, setBooleanValue, setByteValue, setDoubleValue, setFeatureValue, setFeatureValueFromString, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue, toString, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.uima.cas.AnnotationBaseFS

getView

Methods inherited from interface org.apache.uima.cas.FeatureStructure

clone, equals, getBooleanValue, getByteValue, getCAS, getDoubleValue, getFeatureValue, getFeatureValueAsString, getFloatValue, getIntValue, getLongValue, getShortValue, getStringValue, getType, hashCode, setBooleanValue, setByteValue, setDoubleValue, setFeatureValue, setFeatureValueFromString, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue

Field Detail

typeIndexID

public static final int typeIndexID

type

public static final int type

Constructor Detail

MetaDataStringField

protected MetaDataStringField()

Never called. Disable default constructor

MetaDataStringField

public MetaDataStringField(int addr,
                           org.apache.uima.jcas.cas.TOP_Type type)

Internal - constructor used by generator

Parameters:

addr - low level Feature Structure reference

type - the type of this Feature Structure

MetaDataStringField

public MetaDataStringField(org.apache.uima.jcas.JCas jcas)

Parameters:

jcas - JCas to which this Feature Structure belongs

MetaDataStringField

public MetaDataStringField(org.apache.uima.jcas.JCas jcas,
                           int begin,
                           int end)

Parameters:

jcas - JCas to which this Feature Structure belongs

begin - offset to the begin spot in the SofA

end - offset to the end spot in the SofA

Method Detail

getTypeIndexID

public int getTypeIndexID()

Overrides:

getTypeIndexID in class org.apache.uima.jcas.tcas.Annotation

Returns:

index of the type

getKey

public String getKey()

getter for key - gets Name of a metadata field.

Returns:

value of the feature

setKey

public void setKey(String v)

setter for key - sets Name of a metadata field.

Parameters:

v - value to set into the feature

getValue

public String getValue()

getter for value - gets The field value.

Returns:

value of the feature

setValue

public void setValue(String v)

setter for value - sets The field value.

Parameters:

v - value to set into the feature