de.lmu.ifi.dbs.elki.result

Class BasicResult

java.lang.Object

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

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

All Implemented Interfaces:

HierarchicalResult, Result

Direct Known Subclasses:

AssociationRuleResult, ChangePoints, Clustering, ClusterOrder, CollectionResult, EvaluationResult, FrequentItemsetsResult, OrderingFromDataStore, OutlierResult, PointerHierarchyRepresentationResult, ScalesResult, Segments, SettingsResult

public class BasicResult
extends AbstractHierarchicalResult

Basic class for a result. Much like AbstractHierarchicalResult, except it stores the required short and long result names.

Since:

0.4.0

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	name Result name, for presentation
private java.lang.String	shortname Result name, for output

Constructor Summary

Constructors

Constructor and Description
BasicResult(java.lang.String name, java.lang.String shortname) Result constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLongName() A "pretty" name for the result, for use in titles, captions and menus.
java.lang.String	getShortName() A short name for the result, useful for file names.

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

name

private java.lang.String name

Result name, for presentation

shortname

private java.lang.String shortname

Result name, for output

Constructor Detail

BasicResult

public BasicResult(java.lang.String name,
                   java.lang.String shortname)

Result constructor.

Parameters:

name - The long name (for pretty printing)

shortname - the short name (for filenames etc.)

Method Detail

getLongName

public final java.lang.String getLongName()

Description copied from interface: Result

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

Returns:

result name

getShortName

public final java.lang.String getShortName()

Description copied from interface: Result

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

Returns:

result name