de.lmu.ifi.dbs.elki.result

Class SelectionResult

java.lang.Object

de.lmu.ifi.dbs.elki.result.SelectionResult

All Implemented Interfaces:

Result

public class SelectionResult
extends java.lang.Object
implements Result

Selection result wrapper. Note: we did not make the DBIDSelection a result in itself. Instead, the DBIDSelection object should be seen as static contents of this result.

Since:

0.4.0

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field and Description
(package private) DBIDSelection	selection The actual selection

Constructor Summary

Constructors

Constructor and Description
SelectionResult() Constructor.

Method Summary

Modifier and Type	Method and Description
static SelectionResult	ensureSelectionResult(Database db) Ensure that there also is a selection container object.
java.lang.String	getLongName() A "pretty" name for the result, for use in titles, captions and menus.
DBIDSelection	getSelection()
java.lang.String	getShortName() A short name for the result, useful for file names.
void	setSelection(DBIDSelection selection)

Methods inherited from class java.lang.Object

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

Field Detail

selection

DBIDSelection selection

The actual selection

Constructor Detail

SelectionResult

public SelectionResult()

Constructor.

Method Detail

getSelection

public DBIDSelection getSelection()

Returns:

the selection

setSelection

public void setSelection(DBIDSelection selection)

Parameters:

selection - the selection to set

getLongName

public java.lang.String getLongName()

Description copied from interface: Result

A "pretty" name for the result, for use in titles, captions and menus.

Specified by:

getLongName in interface Result

Returns:

result name

getShortName

public java.lang.String getShortName()

Description copied from interface: Result

A short name for the result, useful for file names.

Specified by:

getShortName in interface Result

Returns:

result name

ensureSelectionResult

public static SelectionResult ensureSelectionResult(Database db)

Ensure that there also is a selection container object.

Parameters:

db - Database

Returns:

selection result