Package org.dkpro.statistics.agreement

Interface IAnnotationUnit

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
IUnitizingAnnotationUnit
All Known Implementing Classes:
AnnotationUnit, UnitizingAnnotationUnit
public interface IAnnotationUnit
extends java.io.Serializable
Represents a single annotation unit of an IAnnotationStudy identified and coded by a certain rater. This basic interface concentrates on modeling the rater (represented by its running index) and the category she/he assigned to this unit. Extend this interface to model additional properties of an unit, such as its content (e.g., the covered text) and the position of the unit within the continuum of an annotation study.
Author:
Christian M. Meyer
See Also:
IAnnotationStudy

  • Method Summary

    Modifier and Type Method Description
    java.lang.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).

  • Method Details

    • getRaterIdx

      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). The first rater has index 0.

    • getCategory

      java.lang.Object getCategory()
      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).