de.tudarmstadt.ukp.dkpro.core.api.frequency.tfidf.type

Class Tfidf

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.frequency.tfidf.type.Tfidf

All Implemented Interfaces:

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

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

Annotates the tf.idf score of a token, stem, or lemma. Updated by JCasGen Wed Jan 03 03:06:23 CET 2018 XML source: /Users/bluefire/git/dkpro-core/target/checkout/dkpro-core-api-frequency-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	Tfidf() Never called.
	Tfidf(int addr, org.apache.uima.jcas.cas.TOP_Type type) Internal - constructor used by generator
	Tfidf(org.apache.uima.jcas.JCas jcas)
	Tfidf(org.apache.uima.jcas.JCas jcas, int begin, int end)

Method Summary

Modifier and Type	Method and Description
String	getTerm() getter for term - gets The string that was used to compute this tf.idf score.
double	getTfidfValue() getter for tfidfValue - gets The tf.idf score.
int	getTypeIndexID()
void	setTerm(String v) setter for term - sets The string that was used to compute this tf.idf score.
void	setTfidfValue(double v) setter for tfidfValue - sets The tf.idf score.

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

Tfidf

protected Tfidf()

Never called. Disable default constructor

Tfidf

public Tfidf(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

Tfidf

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

Parameters:

jcas - JCas to which this Feature Structure belongs

Tfidf

public Tfidf(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

getTfidfValue

public double getTfidfValue()

getter for tfidfValue - gets The tf.idf score.

Returns:

value of the feature

setTfidfValue

public void setTfidfValue(double v)

setter for tfidfValue - sets The tf.idf score.

Parameters:

v - value to set into the feature

getTerm

public String getTerm()

getter for term - gets The string that was used to compute this tf.idf score. If a stem or lemma was used, the covered text of this annotation does not need to be equal to this string. This string can be used to construct a vector space with the right terms without having to access the indexes again.

Returns:

value of the feature

setTerm

public void setTerm(String v)

setter for term - sets The string that was used to compute this tf.idf score. If a stem or lemma was used, the covered text of this annotation does not need to be equal to this string. This string can be used to construct a vector space with the right terms without having to access the indexes again.

Parameters:

v - value to set into the feature