de.lmu.ifi.dbs.elki.result

Class CollectionResult<O>

java.lang.Object

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

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

de.lmu.ifi.dbs.elki.result.CollectionResult<O>

Type Parameters:

O - data type

All Implemented Interfaces:

HierarchicalResult, IterableResult<O>, Result, java.lang.Iterable<O>

Direct Known Subclasses:

HistogramResult, IndexStatistics.IndexMetaResult, JudgeOutlierScores.ScoreResult, ReferencePointsResult

public class CollectionResult<O>
extends BasicResult
implements IterableResult<O>

Simple 'collection' type of result. For example, a list of NumberVectors.

Since:

0.2

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Collection<O>	col The collection represented.
private java.util.Collection<java.lang.String>	header Meta information (printed into the header)

Constructor Summary

Constructors

Constructor and Description
CollectionResult(java.lang.String name, java.lang.String shortname, java.util.Collection<O> col) Constructor
CollectionResult(java.lang.String name, java.lang.String shortname, java.util.Collection<O> col, java.util.Collection<java.lang.String> header) Constructor

Method Summary

Modifier and Type	Method and Description
void	addHeader(java.lang.String s) Add header information
java.util.Collection<java.lang.String>	getHeader() Get header information
java.util.Iterator<O>	iterator() Implementation of the IterableResult interface, using the backing collection.
int	size() Get the collection size.

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

Methods inherited from interface de.lmu.ifi.dbs.elki.result.Result

getLongName, getShortName

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

col

private java.util.Collection<O> col

The collection represented.

header

private java.util.Collection<java.lang.String> header

Meta information (printed into the header)

Constructor Detail

CollectionResult

public CollectionResult(java.lang.String name,
                        java.lang.String shortname,
                        java.util.Collection<O> col,
                        java.util.Collection<java.lang.String> header)

Constructor

Parameters:

name - The long name (for pretty printing)

shortname - the short name (for filenames etc.)

col - Collection represented

header - Auxiliary information for result headers

CollectionResult

public CollectionResult(java.lang.String name,
                        java.lang.String shortname,
                        java.util.Collection<O> col)

Constructor

Parameters:

name - The long name (for pretty printing)

shortname - the short name (for filenames etc.)

col - Collection represented

Method Detail

addHeader

public void addHeader(java.lang.String s)

Add header information

Parameters:

s - Header information string

getHeader

public java.util.Collection<java.lang.String> getHeader()

Get header information

Returns:

header information of the result

iterator

public java.util.Iterator<O> iterator()

Implementation of the IterableResult interface, using the backing collection.

Specified by:

iterator in interface IterableResult<O>

Specified by:

iterator in interface java.lang.Iterable<O>

Returns:

iterator

size

public int size()

Get the collection size.

Returns:

Collection size