de.uka.ipd.sdq.codegen.simudatavisualisation.datatypes
Class Histogram

java.lang.Object
  de.uka.ipd.sdq.codegen.simudatavisualisation.datatypes.Histogram

public class Histogram
extends Object

This class stores the information necessary to display a histogram. The histogram can be visualized using the information about the bucket width and the probability for the buckets.

Author:

groenda

Field Summary

protected List<HistogramBucketInformation>	bucketInformation List of the entities, that describe the probability for each of the buckets
protected double	bucketWidth Contains the width of each bucket of the histogram.
static double	DEFAULT_BUCKET_WIDTH The default width for histogram classes
static double	MAXIMUM_NUMBER_OF_BUCKETS The maximum number of buckets to show when initialising the diagram.

Constructor Summary

Histogram(String title)
Creates a new histogram without buckets and default bucket width.

Histogram(String title, double bucketWidth)
Creates a new histogram without buckets.

Method Summary

void	addEntity(HistogramBucketInformation entity) Adds a new bucket to the histogram.
List<HistogramBucketInformation>	getBucketInformation() Returns the list of the buckets and their respective probability.
double	getBucketWidth() Receives the bucket width of the histogram.
String	getTitle() Receives the title or name of the histogram.
void	removeEntity(HistogramBucketInformation entity) Removes a bucket from the histogram.
void	setBucketWidth(double bucketWidth) Sets the bucket width of the histogram.
void	setTitle(String title) Sets the title or name of the histogram.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BUCKET_WIDTH

public static final double DEFAULT_BUCKET_WIDTH

The default width for histogram classes

See Also:

Constant Field Values

MAXIMUM_NUMBER_OF_BUCKETS

public static final double MAXIMUM_NUMBER_OF_BUCKETS

The maximum number of buckets to show when initialising the diagram. The user can decide to show more.

See Also:

Constant Field Values

bucketInformation

protected List<HistogramBucketInformation> bucketInformation

List of the entities, that describe the probability for each of the buckets

See Also:

HistogramBucketInformation

bucketWidth

protected double bucketWidth

Contains the width of each bucket of the histogram.

Constructor Detail

Histogram

public Histogram(String title)

Creates a new histogram without buckets and default bucket width.

Parameters:

title - Title od name of the histogram.

Histogram

public Histogram(String title,
                 double bucketWidth)

Creates a new histogram without buckets.

Parameters:

title - Title or name of the histogram.

bucketWidth - Width of a bucket of the histogram.

Method Detail

addEntity

public void addEntity(HistogramBucketInformation entity)

Adds a new bucket to the histogram.

Parameters:

entity - information about the bucket.

removeEntity

public void removeEntity(HistogramBucketInformation entity)

Removes a bucket from the histogram.

Parameters:

entity - bucket to remove.

getBucketInformation

public List<HistogramBucketInformation> getBucketInformation()

Returns the list of the buckets and their respective probability.

Returns:

the list of the entities.

getTitle

public String getTitle()

Receives the title or name of the histogram.

Returns:

Title or name of the histogram.

setTitle

public void setTitle(String title)

Sets the title or name of the histogram.

Parameters:

title - The new title.

getBucketWidth

public double getBucketWidth()

Receives the bucket width of the histogram.

Returns:

the bucket width.

setBucketWidth

public void setBucketWidth(double bucketWidth)

Sets the bucket width of the histogram.

Parameters:

bucketWidth - the new bucket width.