Environment for
DeveLoping
KDD-Applications
Supported by Index-Structures

de.lmu.ifi.dbs.elki.utilities
Class Description

java.lang.Object
  extended by de.lmu.ifi.dbs.elki.utilities.Description

public class Description
extends Object

Class to provide a description wrapper for CLI information concerning an algorithm.

Author:
Arthur Zimek

Field Summary
private static int[] columns
          Width of columns.
private static String indent
          Indent for printing.
private  String longTitle
          Long title of an algorithm.
static String NEWLINE
          Newline String according to the system.
private static PrettyPrinter prettyPrinter
          A PrettyPrinter for the defined columns.
private  String purpose
          A description of the purpose of an algorithm.
private  String reference
          A reference how to cite an algorithm.
private  String shortTitle
          Short title of an algorithm.
 
Constructor Summary
Description(String shortTitle, String longTitle, String purposeAndDescription, String reference)
          Wrapper to provide a description wrapper for CLI information concerning an algorithm.
 
Method Summary
 String getShortTitle()
          Returns the short title of this description.
 String toString()
          Returns a String for printing the description.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

NEWLINE

public static final String NEWLINE
Newline String according to the system.


shortTitle

private String shortTitle
Short title of an algorithm.


longTitle

private String longTitle
Long title of an algorithm.


purpose

private String purpose
A description of the purpose of an algorithm.


reference

private String reference
A reference how to cite an algorithm.


indent

private static String indent
Indent for printing.


columns

private static int[] columns
Width of columns.


prettyPrinter

private static PrettyPrinter prettyPrinter
A PrettyPrinter for the defined columns.

Constructor Detail

Description

public Description(String shortTitle,
                   String longTitle,
                   String purposeAndDescription,
                   String reference)
Wrapper to provide a description wrapper for CLI information concerning an algorithm.

The parameters are to describe desired informations.

Parameters:
shortTitle - a short title for the algorithm
longTitle - a long title for the algorithm
purposeAndDescription - a description of purpose and functionality of the algorithm
reference - a reference to literature to be cited when using this algorithm
Method Detail

toString

public String toString()
Returns a String for printing the description.

Overrides:
toString in class Object
See Also:
Object.toString()

getShortTitle

public String getShortTitle()
Returns the short title of this description.

Returns:
the short title of this description

Release 0.1 (2008-07-10_1838)