edu.unika.aifb.owltools.evaluation
Class AllLabeled

java.lang.Object
  extended by edu.unika.aifb.owltools.evaluation.Evaluation
      extended by edu.unika.aifb.owltools.evaluation.AllLabeled

public class AllLabeled
extends Evaluation

Checks if in an ontology all entities have a label. This class can also be used to implement own evaluations. It is documented heavily, so that it can be reused as a template for further evaluation measures.


Field Summary
 
Fields inherited from class edu.unika.aifb.owltools.evaluation.Evaluation
context, description, evaluationURIBase, ontology, problems
 
Constructor Summary
AllLabeled(org.semanticweb.kaon2.api.Ontology ontologyToBeEvaluated, java.lang.String URI, org.semanticweb.kaon2.api.Ontology contextOfEvaluation)
          Constructor.
 
Method Summary
protected  boolean evaluate()
          Checks if in an ontology all entities have a label.
 java.lang.String evaluationClassDescription()
          Human-readable description of the evaluation type.
 java.lang.String evaluationClassName()
          Human-readable name for the evaluation type.
 java.lang.String evaluationClassURI()
          URI for the evaluation type.
 
Methods inherited from class edu.unika.aifb.owltools.evaluation.Evaluation
addProblem, getContext, getDescription, getEvaluation, getOntology, getProblemMap, getProblems, getRandomURIProblem, getRandomURISolution, getURI, setEvaluation, succesfulEvaluation
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AllLabeled

public AllLabeled(org.semanticweb.kaon2.api.Ontology ontologyToBeEvaluated,
                  java.lang.String URI,
                  org.semanticweb.kaon2.api.Ontology contextOfEvaluation)
Constructor. Keep it the same, just change the constructor name appropriately

Parameters:
ontologyToBeEvaluated - Input ontology. This is the ontology to be evaluated. It is accessible as ontology
URI - URI for the evaluation. This is just the name for this specific evaluation. You don't have to know it, or change it.
contextOfEvaluation - Evaluation context. Also all further parameters that you need for the evaluation should be handled over the context. Accessible as context. Null if none is given
Method Detail

evaluationClassName

public java.lang.String evaluationClassName()
Human-readable name for the evaluation type. Give it a telling name that could be used in an user interface.

Specified by:
evaluationClassName in class Evaluation
Returns:
Name of the evaluation

evaluationClassURI

public java.lang.String evaluationClassURI()
URI for the evaluation type. Don't mix it with the URI for the evaluation itself. This is the kind of evaluation. Just give it some URI in your own namespace.

Specified by:
evaluationClassURI in class Evaluation
Returns:
URI of the evaluation

evaluationClassDescription

public java.lang.String evaluationClassDescription()
Human-readable description of the evaluation type. Give it a short, but useful description, that could be displayed to users in an appropriate interface to help users decide whether to use the evaluation or not.

Specified by:
evaluationClassDescription in class Evaluation
Returns:
Description of the evaluation type

evaluate

protected boolean evaluate()
Checks if in an ontology all entities have a label. This is the meat of your evaluation function. You have to set all results here, and do all the computing.

Specified by:
evaluate in class Evaluation
Returns:
true if the evaluation was succesful, else false