org.semanticweb.owlapi.metrics

Interface OWLMetric<M>

Type Parameters:

M - the metric type

All Known Implementing Classes:

AbstractOWLMetric, AverageAssertedNamedSuperclassCount, AxiomCount, AxiomCountMetric, AxiomTypeMetric, DLExpressivity, DoubleValuedMetric, GCICount, HiddenGCICount, ImportClosureSize, IntegerValuedMetric, LogicalAxiomCount, MaximumNumberOfNamedSuperclasses, NumberOfClassesWithMultipleInheritance, ObjectCountMetric, ReferencedClassCount, ReferencedDataPropertyCount, ReferencedIndividualCount, ReferencedObjectPropertyCount, UnsatisfiableClassCountMetric

public interface OWLMetric<M>

Represents a metric about some aspect of an ontology and possibly its imports closure.

Since:

2.1.0

Author:

Matthew Horridge, The University Of Manchester, Bio-Health Informatics Group

Method Summary

Modifier and Type	Method and Description
void	dispose() Disposes of the metric.
OWLOntologyManager	getManager() Gets the ontology manager which, amongst other things can be used to obtain the imports closure of the current ontology.
String	getName() Gets the human readable name of this metric.
OWLOntology	getOntology() Gets the ontology which the value of the metric should be based on.
M	getValue() Gets the value of this metric.
boolean	isImportsClosureUsed() Determines if the computation of the metric should take into account the imports closure of the current ontology.
void	setImportsClosureUsed(boolean b) Sets whether this metric uses the imports closure of the current ontology.
void	setOntology(OWLOntology ontology) Sets the "root" ontology.

Method Detail

getName

@Nonnull
String getName()

Gets the human readable name of this metric.

Returns:

A label which represents the human readable name of this metric.

getValue

@Nonnull
M getValue()

Gets the value of this metric. This value is computed w.r.t. the current ontology and possibly the imports closure (if specified).

Returns:

An object which represents the value of this metric - calling the toString method of the object returned by this method will result in a human readable string that displays the value of the metric.

setOntology

void setOntology(@Nonnull
                 OWLOntology ontology)

Sets the "root" ontology. The metric will be recomputed from this ontology (and potentially its imports closure if selected).

Parameters:

ontology - The ontology for which the metric should be computed.

getOntology

@Nonnull
OWLOntology getOntology()

Gets the ontology which the value of the metric should be based on.

Returns:

The ontology.

isImportsClosureUsed

boolean isImportsClosureUsed()

Determines if the computation of the metric should take into account the imports closure of the current ontology.

Returns:

true if the imports closure of the current ontology is taken into account when computing the value of this metric, or false if the imports closure isn't taken into account when computing this metric.

setImportsClosureUsed

void setImportsClosureUsed(boolean b)

Sets whether this metric uses the imports closure of the current ontology.

Parameters:

b - the new imports closure used true if this metric uses the imports closure of the current ontology, otherwise false.

getManager

@Nonnull
OWLOntologyManager getManager()

Gets the ontology manager which, amongst other things can be used to obtain the imports closure of the current ontology.

Returns:

An OWLOntologyManager.

dispose

void dispose()

Disposes of the metric. If the metric attaches itself as a listener to an ontology manager then this will cause the metric to detach itself and stop listening for ontology changes.