TopicDistribution (DKPro Core - Master Aggregator 1.7.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
      - de.tudarmstadt.ukp.dkpro.core.mallet.type.TopicDistribution

All Implemented Interfaces:

Cloneable, org.apache.uima.cas.AnnotationBaseFS, org.apache.uima.cas.FeatureStructure, org.apache.uima.cas.text.AnnotationFS
```
public class TopicDistribution
extends org.apache.uima.jcas.tcas.Annotation
```
Updated by JCasGen Mon Oct 20 16:34:13 CEST 2014 XML source: /home/schnober/workspace/de.tudarmstadt.ukp.dkpro.core-asl/de.tudarmstadt.ukp.dkpro.core.mallet/src/main/resources/TopicDistribution.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

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

Constructor Summary

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

Method Summary

Methods
Modifier and Type	Method and Description
`org.apache.uima.jcas.cas.IntegerArray`	`getTopicAssignment()` getter for TopicAssignment - gets Pointers to topics the document has been assigned to.
`int`	`getTopicAssignment(int i)` indexed getter for TopicAssignment - gets an indexed value - Pointers to topics the document has been assigned to.
`org.apache.uima.jcas.cas.DoubleArray`	`getTopicProportions()` getter for TopicProportions - gets Each topic's proportion in the document.
`double`	`getTopicProportions(int i)` indexed getter for TopicProportions - gets an indexed value - Each topic's proportion in the document.
`int`	`getTypeIndexID()`
`void`	`setTopicAssignment(org.apache.uima.jcas.cas.IntegerArray v)` setter for TopicAssignment - sets Pointers to topics the document has been assigned to.
`void`	`setTopicAssignment(int i, int v)` indexed setter for TopicAssignment - sets an indexed value - Pointers to topics the document has been assigned to.
`void`	`setTopicProportions(org.apache.uima.jcas.cas.DoubleArray v)` setter for TopicProportions - sets Each topic's proportion in the document.
`void`	`setTopicProportions(int i, double v)` indexed setter for TopicProportions - sets an indexed value - Each topic's proportion in the document.

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
  - typeIndexID
```
public static final int typeIndexID
```
  - type
```
public static final int type
```
- Constructor Detail
  - TopicDistribution
```
protected TopicDistribution()
```
    Never called. Disable default constructor
  - TopicDistribution
```
public TopicDistribution(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
  - TopicDistribution
```
public TopicDistribution(org.apache.uima.jcas.JCas jcas)
```
    Parameters:
    jcas - JCas to which this Feature Structure belongs
  - TopicDistribution
```
public TopicDistribution(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
  - getTopicProportions
```
public org.apache.uima.jcas.cas.DoubleArray getTopicProportions()
```
    getter for TopicProportions - gets Each topic's proportion in the document.
    
    Returns:
    value of the feature
  - setTopicProportions
```
public void setTopicProportions(org.apache.uima.jcas.cas.DoubleArray v)
```
    setter for TopicProportions - sets Each topic's proportion in the document.
    
    Parameters:
    v - value to set into the feature
  - getTopicProportions
```
public double getTopicProportions(int i)
```
    indexed getter for TopicProportions - gets an indexed value - Each topic's proportion in the document.
    
    Parameters:
    i - index in the array to get
    
    Returns:
    value of the element at index i
  - setTopicProportions
```
public void setTopicProportions(int i,
                       double v)
```
    indexed setter for TopicProportions - sets an indexed value - Each topic's proportion in the document.
    
    Parameters:
    i - index in the array to set
    v - value to set into the array
  - getTopicAssignment
```
public org.apache.uima.jcas.cas.IntegerArray getTopicAssignment()
```
    getter for TopicAssignment - gets Pointers to topics the document has been assigned to.
    
    Returns:
    value of the feature
  - setTopicAssignment
```
public void setTopicAssignment(org.apache.uima.jcas.cas.IntegerArray v)
```
    setter for TopicAssignment - sets Pointers to topics the document has been assigned to.
    
    Parameters:
    v - value to set into the feature
  - getTopicAssignment
```
public int getTopicAssignment(int i)
```
    indexed getter for TopicAssignment - gets an indexed value - Pointers to topics the document has been assigned to.
    
    Parameters:
    i - index in the array to get
    
    Returns:
    value of the element at index i
  - setTopicAssignment
```
public void setTopicAssignment(int i,
                      int v)
```
    indexed setter for TopicAssignment - sets an indexed value - Pointers to topics the document has been assigned to.
    
    Parameters:
    i - index in the array to set
    v - value to set into the array

Class TopicDistribution

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

typeIndexID

type

Constructor Detail

TopicDistribution

TopicDistribution

TopicDistribution

TopicDistribution

Method Detail

getTypeIndexID

getTopicProportions

setTopicProportions

getTopicProportions

setTopicProportions

getTopicAssignment

setTopicAssignment

getTopicAssignment

setTopicAssignment