org.dkpro.statistics.agreement.coding

Class CodingAnnotationItem

java.lang.Object

org.dkpro.statistics.agreement.coding.CodingAnnotationItem

All Implemented Interfaces:

ICodingAnnotationItem, IAnnotationItem

public class CodingAnnotationItem
extends Object
implements ICodingAnnotationItem

Default implementation of ICodingAnnotationItem holding the set of annotation units for this item (i.e., the categories assigned to this item by all raters). When using the default implementation, it is recommended to use CodingAnnotationStudy.addItem(Object...) instead of instantiating this type.

Author:

Christian M. Meyer

See Also:

CodingAnnotationStudy, ICodingAnnotationItem

Field Summary

Fields

Modifier and Type	Field and Description
protected int	nonNullCount
protected List<IAnnotationUnit>	units

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CodingAnnotationItem(int unitCount) Initializes the item for the given number of units.

Method Summary

Modifier and Type	Method and Description
protected void	addUnit(IAnnotationUnit unit) Adds the given unit to the coding study.
int	getRaterCount() Returns the number of raters who annotated this item with a non-null category.
IAnnotationUnit	getUnit(int raterIdx) Returns the annotation unit of the rater with the specified index.
Iterable<IAnnotationUnit>	getUnits() Returns all coding units for this annotation item (i.e., the categories assigned by the individual raters).
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

units

protected List<IAnnotationUnit> units

nonNullCount

protected int nonNullCount

Constructor Detail

CodingAnnotationItem

protected CodingAnnotationItem(int unitCount)

Initializes the item for the given number of units. Normally, the method CodingAnnotationStudy.addItem(Object...) should be used to define the annotation units of an item.

Method Detail

addUnit

protected void addUnit(IAnnotationUnit unit)

Adds the given unit to the coding study. Normally, the method CodingAnnotationStudy.addItem(Object...) should be used to define the annotation units of an item.

getUnit

public IAnnotationUnit getUnit(int raterIdx)

Description copied from interface: ICodingAnnotationItem

Returns the annotation unit of the rater with the specified index. That is, the object holding the category assigned to the item by the specified rater.

Specified by:

getUnit in interface ICodingAnnotationItem

getUnits

public Iterable<IAnnotationUnit> getUnits()

Description copied from interface: ICodingAnnotationItem

Returns all coding units for this annotation item (i.e., the categories assigned by the individual raters).

Specified by:

getUnits in interface ICodingAnnotationItem

getRaterCount

public int getRaterCount()

Description copied from interface: ICodingAnnotationItem

Returns the number of raters who annotated this item with a non-null category.

Specified by:

getRaterCount in interface ICodingAnnotationItem

toString

public String toString()

Overrides:

toString in class Object