Package org.dkpro.statistics.agreement

Interface IAnnotationStudy

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
ICodingAnnotationStudy, IUnitizingAnnotationStudy
All Known Implementing Classes:
AnnotationStudy, CodingAnnotationStudy, UnitizingAnnotationStudy
public interface IAnnotationStudy
extends java.io.Serializable
Basic interface representing the essential data model of any annotation study. The data model provides access to the raters participating in the annotation study, the set of categories a rater may use, and the annotation units. Each unit represents a single annotation (i.e., the decision of a single rater to assign one of the categories to a predefined or rater-defined unit). The interface acts as the common ground for any inter-rater agreement measure, whereas its two fundamental extensions - the coding and the unitizing study interfaces - provide further interface methods necessary for calculating individual measures.
Author:
Christian M. Meyer
See Also:
IAgreementMeasure, IAnnotationUnit

  • Method Summary

    Modifier and Type Method Description
    int findRater​(java.lang.String name)  
    java.lang.Iterable<java.lang.Object> getCategories()
    Returns an iterator over all annotation categories within the study.
    int getCategoryCount()
    Returns the number of annotation categories in the study.
    int getRaterCount()
    Returns the number of raters participating in this study.
    int getUnitCount()
    Returns the number of annotation units defined by the study.
    boolean isDichotomous()
    Returns true if, and only if, the categories defined by the study yield a dichotomy (i.e., there are exactly two categories).

  • Method Details

    • getRaterCount

      int getRaterCount()
      Returns the number of raters participating in this study.

    • findRater

      int findRater​(java.lang.String name)

    • getCategories

      java.lang.Iterable<java.lang.Object> getCategories()
      Returns an iterator over all annotation categories within the study. Note that the categories are not per se clear; they might need to be gathered by iterating through all associated items, which yields performance problems in large-scale annotation studies.

    • getCategoryCount

      int getCategoryCount()
      Returns the number of annotation categories in the study. Note that the categories are not per se clear; they might need to be gathered by iterating through all associated items, which yields performance problems in large-scale annotation studies.

    • isDichotomous

      boolean isDichotomous()
      Returns true if, and only if, the categories defined by the study yield a dichotomy (i.e., there are exactly two categories).

    • getUnitCount

      int getUnitCount()
      Returns the number of annotation units defined by the study. That is, the number of annotations coded by the raters.