org.dkpro.statistics.agreement.visualization

Class UnitizingStudyPrinter

java.lang.Object

org.dkpro.statistics.agreement.visualization.UnitizingStudyPrinter

public class UnitizingStudyPrinter
extends Object

Plain-text visualization for unitizing studies. The visualization prints the continuum and marks the units of each individual rater and for each category using asterisks. For category A of Krippendorff's (1995) example, the implementation prints, for instance:

                   1         2   2
 r      0123456789012345678901234
 0        ********    ******    
 1          ****       **

That is, a continuum starting at 0, ending at 24, in which two raters identified two units. By defining a PrintStream, it is possible to display a study on the console or to write the results to a text file.

References:

• Krippendorff, K.: On the reliability of unitizing contiguous data. Sociological Methodology 25:47–76, 1995.

Author:

Christian M. Meyer

See Also:

IUnitizingAnnotationStudy

Constructor Summary

Constructors

Constructor and Description
UnitizingStudyPrinter()

Method Summary

Modifier and Type	Method and Description
void	print(PrintStream out, IUnitizingAnnotationStudy study) Print a plain-text representation of the given unitizing study.
void	printContinuum(PrintStream out, IUnitizingAnnotationStudy study, String prefix) Prints an integer scale of the continuum used for the given unitzing study.
void	printUnitsForCategory(PrintStream out, IUnitizingAnnotationStudy study, Object category, String prefix) Iterate all raters, identify the corresponding annotation units, and visualize them using printUnitsForRater(PrintStream, IUnitizingAnnotationStudy, int, Object, String).
void	printUnitsForRater(PrintStream out, IUnitizingAnnotationStudy study, int raterIdx, Object category, String prefix) Identifies all annotation units of the given rater which have been coded with the given category and marks their boundaries using asterisks.

Methods inherited from class java.lang.Object

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

Constructor Detail

UnitizingStudyPrinter

public UnitizingStudyPrinter()

Method Detail

printContinuum

public void printContinuum(PrintStream out,
                           IUnitizingAnnotationStudy study,
                           String prefix)

Prints an integer scale of the continuum used for the given unitzing study. Optionally, the given prefix is printed left of the continuum scale and the output is correctly indented.

printUnitsForRater

public void printUnitsForRater(PrintStream out,
                               IUnitizingAnnotationStudy study,
                               int raterIdx,
                               Object category,
                               String prefix)

Identifies all annotation units of the given rater which have been coded with the given category and marks their boundaries using asterisks. The scale is compatible to printContinuum( PrintStream, IUnitizingAnnotationStudy, String). Optionally, the given prefix is printed left of the continuum scale and the output is correctly indented.

printUnitsForCategory

public void printUnitsForCategory(PrintStream out,
                                  IUnitizingAnnotationStudy study,
                                  Object category,
                                  String prefix)

Iterate all raters, identify the corresponding annotation units, and visualize them using printUnitsForRater(PrintStream, IUnitizingAnnotationStudy, int, Object, String). Optionally, the given prefix is printed left of the continuum scale and the output is correctly indented.

print

public void print(PrintStream out,
                  IUnitizingAnnotationStudy study)

Print a plain-text representation of the given unitizing study.