de.lmu.ifi.dbs.elki.result

Class EvaluationResult

java.lang.Object

de.lmu.ifi.dbs.elki.result.AbstractHierarchicalResult

de.lmu.ifi.dbs.elki.result.BasicResult

de.lmu.ifi.dbs.elki.result.EvaluationResult

All Implemented Interfaces:

HierarchicalResult, Result, TextWriteable, Iterable<EvaluationResult.MeasurementGroup>

Direct Known Subclasses:

EvaluateClustering.ScoreResult, RepresentativeUncertainClustering.RepresentativenessEvaluation

public class EvaluationResult
extends BasicResult
implements TextWriteable, Iterable<EvaluationResult.MeasurementGroup>

Abstract evaluation result.

Author:

Erich Schubert

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EvaluationResult.Measurement Class representing a single measurement.
static class	EvaluationResult.MeasurementGroup A group of evaluation measurements.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) ArrayList<EvaluationResult.MeasurementGroup>	groups Measurements.
(package private) ArrayList<String>	header Header lines.

Constructor Summary

Constructors

Constructor and Description
EvaluationResult(String name, String shortname) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addHeader(String line) Add a header line to this result.
static EvaluationResult	findOrCreate(ResultHierarchy hierarchy, Result parent, String name, String shortname) Find or create an evaluation result.
EvaluationResult.MeasurementGroup	findOrCreateGroup(String label) Find or add a new measurement group.
Iterable<String>	getHeaderLines() Get the header lines.
Iterator<EvaluationResult.MeasurementGroup>	iterator()
EvaluationResult.MeasurementGroup	newGroup(String string) Add a new measurement group.
int	numLines() Number of lines recommended for display.
boolean	visualizeSingleton() Flag to indicate that these results should be visualized using a single visualizer.
void	writeToText(TextWriterStream out, String label) Write self to the given TextWriterStream

Methods inherited from class de.lmu.ifi.dbs.elki.result.BasicResult

getLongName, getShortName

Methods inherited from class de.lmu.ifi.dbs.elki.result.AbstractHierarchicalResult

addChildResult, getHierarchy, setHierarchy

Methods inherited from class java.lang.Object

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

Field Detail

groups

ArrayList<EvaluationResult.MeasurementGroup> groups

Measurements.

header

ArrayList<String> header

Header lines.

Constructor Detail

EvaluationResult

public EvaluationResult(String name,
                String shortname)

Constructor.

Parameters:

name - Evaluation name

shortname - Short name

Method Detail

newGroup

public EvaluationResult.MeasurementGroup newGroup(String string)

Add a new measurement group.

Parameters:

string - Group name

Returns:

Measurement group.

findOrCreateGroup

public EvaluationResult.MeasurementGroup findOrCreateGroup(String label)

Find or add a new measurement group.

Parameters:

label - Group name

Returns:

Measurement group.

writeToText

public void writeToText(TextWriterStream out,
               String label)

Description copied from interface: TextWriteable

Write self to the given TextWriterStream

Specified by:

writeToText in interface TextWriteable

Parameters:

out - Output writer

label - Label

addHeader

public void addHeader(String line)

Add a header line to this result.

Parameters:

line - Header line

getHeaderLines

public Iterable<String> getHeaderLines()

Get the header lines.

Returns:

Header lines

iterator

public Iterator<EvaluationResult.MeasurementGroup> iterator()

Specified by:

iterator in interface Iterable<EvaluationResult.MeasurementGroup>

numLines

public int numLines()

Number of lines recommended for display.

Returns:

Number of lines

findOrCreate

public static EvaluationResult findOrCreate(ResultHierarchy hierarchy,
                            Result parent,
                            String name,
                            String shortname)

Find or create an evaluation result.

Parameters:

hierarchy - Result hierarchy.

parent - Parent result

name - Long name

shortname - Short name

Returns:

Evaluation result

visualizeSingleton

public boolean visualizeSingleton()

Flag to indicate that these results should be visualized using a single visualizer.

Returns:

Singleton