de.fu_berlin.ties.eval
Interface MultiFMetricsView

All Superinterfaces:
StorableContainer
All Known Implementing Classes:
MultiFMetrics

public interface MultiFMetricsView
extends StorableContainer

A read-only view of multiple FMetrics and the sums and averages calculated over them.

Version:
$Revision: 1.3 $, $Date: 2004/02/19 18:15:51 $, $Author: siefkes $
Author:
Christian Siefkes

Method Summary
 Set types()
          Returns the set of all types (Strings) currently stored in this instance.
 FMetricsView view(String type)
          Returns a read-only view of the FMetrics of the specified type.
 FMetricsView viewAll()
          Returns a read-only view of the FMetrics containing the sums and averages over all types.
 FMetricsSummary viewAllSummary()
          Optional operation that shows statistical summaries of precision, recall, and F1 metrics over all types, if calculated by the used implementation.
 FMetricsSummary viewSummary(String type)
          Optional operation that shows statistical summaries of precision, recall, and F1 metrics of the specified type, if calculated by the used implementation.
 
Methods inherited from interface de.fu_berlin.ties.io.StorableContainer
storeEntries
 

Method Detail

types

public Set types()
Returns the set of all types (Strings) currently stored in this instance. The set is immutable and cannot modified.

Returns:
the set of type names

view

public FMetricsView view(String type)
Returns a read-only view of the FMetrics of the specified type. This is not a snapshot but will change whenever the underlying counts are changed.

Parameters:
type - the type to check
Returns:
a view of the counts and evaluation metrics for the given type; or null if no metrics exist for the given type

viewAll

public FMetricsView viewAll()
Returns a read-only view of the FMetrics containing the sums and averages over all types. This is not a snapshot but will change whenever the underlying counts are changed.

Returns:
a view of the sums and averages over all types

viewAllSummary

public FMetricsSummary viewAllSummary()
                               throws UnsupportedOperationException
Optional operation that shows statistical summaries of precision, recall, and F1 metrics over all types, if calculated by the used implementation. This is not a snapshot but will change whenever the underlying values are changed.

Returns:
a statistical summery over the metrics of all types
Throws:
UnsupportedOperationException - if this method is not supported by the used implementation

viewSummary

public FMetricsSummary viewSummary(String type)
                            throws UnsupportedOperationException
Optional operation that shows statistical summaries of precision, recall, and F1 metrics of the specified type, if calculated by the used implementation. This is not a snapshot but will change whenever the underlying values are changed.

Parameters:
type - the type to check
Returns:
a statistical summery over the metrics of the given type
Throws:
UnsupportedOperationException - if this method is not supported by the used implementation


Copyright © 2003-2004 Christian Siefkes. All Rights Reserved.