org.apache.ctakes.ytex.uima.types

Class DocKey

java.lang.Object

Annotation

org.apache.ctakes.ytex.uima.types.DocKey

public class DocKey
extends Annotation

Updated by JCasGen Wed Sep 30 11:06:15 EDT 2015 XML source: /Users/pei/workspace/apache-ctakes/3.2.2/ctakes-ytex-uima/target/jcasgen/typesystem.xml

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
FSArray	getKeyValuePairs() getter for keyValuePairs - gets
KeyValuePair	getKeyValuePairs(int i) indexed getter for keyValuePairs - gets an indexed value -
int	getTypeIndexID()
private void	readObject() Write your own initialization here
void	setKeyValuePairs(FSArray v) setter for keyValuePairs - sets
void	setKeyValuePairs(int i, KeyValuePair v) indexed setter for keyValuePairs - sets an indexed value -

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

typeIndexID

public static final int typeIndexID

type

public static final int type

Constructor Detail

DocKey

protected DocKey()

Never called. Disable default constructor

DocKey

public DocKey(int addr,
      TOP_Type type)

Internal - constructor used by generator

Parameters:

addr - low level Feature Structure reference

type - the type of this Feature Structure

DocKey

public DocKey(JCas jcas)

Parameters:

jcas - JCas to which this Feature Structure belongs

DocKey

public DocKey(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()

Returns:

index of the type

readObject

private void readObject()

Write your own initialization here

getKeyValuePairs

public FSArray getKeyValuePairs()

getter for keyValuePairs - gets

Returns:

value of the feature

setKeyValuePairs

public void setKeyValuePairs(FSArray v)

setter for keyValuePairs - sets

Parameters:

v - value to set into the feature

getKeyValuePairs

public KeyValuePair getKeyValuePairs(int i)

indexed getter for keyValuePairs - gets an indexed value -

Parameters:

i - index in the array to get

Returns:

value of the element at index i

setKeyValuePairs

public void setKeyValuePairs(int i,
                    KeyValuePair v)

indexed setter for keyValuePairs - sets an indexed value -

Parameters:

i - index in the array to set

v - value to set into the array