oracle.dmt.odm
Class AttributeHistogram

java.lang.Object
  |
  +--oracle.dmt.odm.MiningObject
        |
        +--oracle.dmt.odm.AttributeHistogram

All Implemented Interfaces:

java.io.Serializable

public class AttributeHistogram

extends MiningObject

An instance of AttributeHistogram contains metadata used to describe one-dimensional (single attribute) histograms.

Since:

9.2.0

See Also:

Serialized Form

Constructor Summary

AttributeHistogram(MiningAttribute attribute, java.util.Vector diplayNames, java.util.Vector freq)
Creates an AttributeHistogram object for a given attribute.

Method Summary

MiningAttribute	getAttribute() Returns the MiningAttribute associated with the histogram.
java.lang.String	getDisplayName(int binNumber) Returns the display name for a bin in the histogram.
java.lang.Float	getFrequency(int binNumber) Returns the frequency for a given bin in the histogram.
int	getNumberOfBins() Returns the number of bins in the histogram.

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeHistogram

public AttributeHistogram(MiningAttribute attribute,
                          java.util.Vector diplayNames,
                          java.util.Vector freq)

Creates an AttributeHistogram object for a given attribute.

Parameters:

attribute - Mining attribute

freq - Vector of bin frequencies. Bin frequencies in a histogram sum up to one

Method Detail

getAttribute

public MiningAttribute getAttribute()

Returns the MiningAttribute associated with the histogram.

Returns:

Histogram mining attribute

getFrequency

public java.lang.Float getFrequency(int binNumber)
                             throws InvalidArgumentException

Returns the frequency for a given bin in the histogram.

Parameters:

binNumber - Histogram bin number

Returns:

Bin frequency

Throws:

InvalidArgumentException - when binNumber < 1 or more then total number of beans

InvalidArgumentException

getDisplayName

public java.lang.String getDisplayName(int binNumber)
                                throws InvalidArgumentException

Returns the display name for a bin in the histogram.

Parameters:

binNumber - Histogram bin number

Returns:

Display name string associated with the bin

Throws:

InvalidArgumentException - when binNumber < 1 or more then total number of beans

InvalidArgumentException

getNumberOfBins

public int getNumberOfBins()

Returns the number of bins in the histogram.

Returns:

Number of bins