Package org.dkpro.statistics.agreement.coding

Interface ICodingAnnotationStudy

All Superinterfaces:
IAnnotationStudy, java.io.Serializable
All Known Implementing Classes:
CodingAnnotationStudy
public interface ICodingAnnotationStudy
extends IAnnotationStudy
Data model for coding studies. Coding studies are characterized by a set of fixed annotation items which a number of (human) raters are asked code with a certain category. The individual annotations represent the annotation units. The set of annotation units of an annotation item is represented by the IAnnotationItem interface. Note that this interface allows reusing existing data representations by implementing the required methods. Use CodingAnnotationStudy as a default implementation if no existing data representation exists. The default implementation facilitates adding the individual units.
Author:
Christian M. Meyer
See Also:
CodingAnnotationStudy, ICodingAnnotationItem

  • Method Details

    • hasMissingValues

      boolean hasMissingValues()
      Returns true if, and only if, the annotation study contains at least one item with a missing value (i.e., an annotation item containing an annotation unit with category null).

    • getItem

      ICodingAnnotationItem getItem​(int index)
      Returns the annotation item with the given index. The first item has index 0.

    • getItems

      java.lang.Iterable<ICodingAnnotationItem> getItems()
      Allows iterating all annotation items of this study.

    • getItemCount

      int getItemCount()
      Returns the number of annotation items defined by the study.

    • getUnitCount

      int getUnitCount()
      Returns the number of annotation units defined by the study. That is, the number of annotations coded by the raters. If there are no missing values, the unit count equals the item count multiplied with the number of raters.
      Specified by:
      getUnitCount in interface IAnnotationStudy