org.dkpro.statistics.agreement

Class AnnotationUnit

java.lang.Object

org.dkpro.statistics.agreement.AnnotationUnit

All Implemented Interfaces:

IAnnotationUnit

Direct Known Subclasses:

UnitizingAnnotationUnit

public class AnnotationUnit
extends Object
implements IAnnotationUnit

Default implementation of IAnnotationUnit holding the rater's index and the category that the rater assigned to this unit.

Author:

Christian M. Meyer

See Also:

IAnnotationStudy, IAnnotationUnit

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	category
protected int	raterIdx

Constructor Summary

Constructors

Constructor and Description
AnnotationUnit(int raterIdx, Object category) Initializes the annotation unit with the given category as the annotation by the rater with the specified index.

Method Summary

Modifier and Type	Method and Description
Object	getCategory() Returns the category assigned to this unit by one of the raters.
int	getRaterIdx() Returns the index of the rater who coded this unit (in case of a coding study) or defined the boundaries of this unit (in case of a unitizing study).
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

raterIdx

protected int raterIdx

category

protected Object category

Constructor Detail

AnnotationUnit

public AnnotationUnit(int raterIdx,
                      Object category)

Initializes the annotation unit with the given category as the annotation by the rater with the specified index.

Method Detail

getRaterIdx

public int getRaterIdx()

Description copied from interface: IAnnotationUnit

Returns the index of the rater who coded this unit (in case of a coding study) or defined the boundaries of this unit (in case of a unitizing study). The first rater has index 0.

Specified by:

getRaterIdx in interface IAnnotationUnit

getCategory

public Object getCategory()

Description copied from interface: IAnnotationUnit

Returns the category assigned to this unit by one of the raters. The category might be null if, and only if, the unit represents a missing value (in case of a coding study) or a gap (in case of a unitizing study).

Specified by:

getCategory in interface IAnnotationUnit

toString

public String toString()

Overrides:

toString in class Object