SamplingResult (ELKI: Environment for DeveLoping KDD-Applications Supported by Index-Structures)

java.lang.Object
- elki.result.SamplingResult

```
public class SamplingResult
extends java.lang.Object
```
Wrapper for storing the current database sample.

Since:

0.5.0

Author:

Erich Schubert

Field Summary

Fields
Modifier and Type Field Description

(package private) DBIDs sample
The actual selection

Constructor Summary

Constructors
Constructor Description

SamplingResult(Relation<?> rel)
Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getLongName()`
`DBIDs`	`getSample()`
`static SamplingResult`	`getSamplingResult(Relation<?> rel)`	Get the sampling result attached to a relation
`java.lang.String`	`getShortName()`
`void`	`setSample(DBIDs sample)`	Note: trigger a resultchanged event!

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - sample
```
DBIDs sample
```
    The actual selection
- Constructor Detail
  - SamplingResult
```
public SamplingResult(Relation<?> rel)
```
    Constructor.
    
    Parameters:
    
    rel - Relation
- Method Detail
  - getSample
```
public DBIDs getSample()
```
    Returns:
    
    the current sample
  - setSample
```
public void setSample(DBIDs sample)
```
    Note: trigger a resultchanged event!
    
    Parameters:
    
    sample - the new sample
  - getLongName
```
public java.lang.String getLongName()
```
  - getShortName
```
public java.lang.String getShortName()
```
  - getSamplingResult
```
public static SamplingResult getSamplingResult(Relation<?> rel)
```
    Get the sampling result attached to a relation
    
    Parameters:
    
    rel - Relation
    
    Returns:
    
    Sampling result.