Header (ClearTK ClearNLP 2.0.0 API)

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
      - org.cleartk.test.util.type.Header

All Implemented Interfaces:

Cloneable, AnnotationBaseFS, FeatureStructure, AnnotationFS
```
public class Header
extends Annotation
```
Updated by JCasGen Wed May 07 09:06:03 EDT 2014 XML source: /Users/bethard/Code/cleartk/target/checkout/cleartk-test-util/target/jcasgen/typesystem.xml

Generated:

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

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

Constructor Summary

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

Method Summary

Methods
Modifier and Type	Method and Description
`FSArray`	`getAuthors()` getter for authors - gets
`AuthorInfo`	`getAuthors(int i)` indexed getter for authors - gets an indexed value -
`int`	`getTypeIndexID()`
`void`	`setAuthors(FSArray v)` setter for authors - sets
`void`	`setAuthors(int i, AuthorInfo v)` indexed setter for authors - sets an indexed 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, 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
  - type
```
public static final int type
```
    Generated:
    
    Ordered:
  - typeIndexID
```
public static final int typeIndexID
```
    Generated:
    
    Ordered:
- Constructor Detail
  - Header
```
protected Header()
```
    Never called. Disable default constructor
    
    Generated:
  - Header
```
public Header(int addr,
      TOP_Type type)
```
    Internal - constructor used by generator
    
    Parameters:
    addr - low level Feature Structure reference
    type - the type of this Feature Structure
    Generated:
  - Header
```
public Header(JCas jcas)
```
    Parameters:
    jcas - JCas to which this Feature Structure belongs
    Generated:
  - Header
```
public Header(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
    Generated:
- Method Detail
  - getAuthors
```
public FSArray getAuthors()
```
    getter for authors - gets
    
    Returns:
    value of the feature
    Generated:
  - getAuthors
```
public AuthorInfo getAuthors(int i)
```
    indexed getter for authors - gets an indexed value -
    
    Parameters:
    i - index in the array to get
    
    Returns:
    value of the element at index i
    Generated:
  - getTypeIndexID
```
public int getTypeIndexID()
```
    Overrides:
    
    getTypeIndexID in class Annotation
    
    Returns:
    index of the type
    Generated:
  - setAuthors
```
public void setAuthors(FSArray v)
```
    setter for authors - sets
    
    Parameters:
    v - value to set into the feature
    Generated:
  - setAuthors
```
public void setAuthors(int i,
              AuthorInfo v)
```
    indexed setter for authors - sets an indexed value -
    
    Parameters:
    i - index in the array to set
    v - value to set into the array
    Generated:

Class Header

Field Summary

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

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

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

Field Detail

type

typeIndexID

Constructor Detail

Header

Header

Header

Header

Method Detail

getAuthors

getAuthors

getTypeIndexID

setAuthors

setAuthors