biz.sc.mm.dm.statistics

Interface StatisticsSettings

public interface StatisticsSettings

Specifies which statistics should be calculated.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttribute(java.lang.String s) Adds an attribute name to a list of attributes which statistics should be calculated.
void	addLeftInterval(java.lang.Double maxValue)
void	addLeftInterval(java.lang.String attributeName, java.lang.Double maxValue)
void	addLeftIntervalAsPercent(java.lang.Integer percent)
void	addLeftIntervalAsPercent(java.lang.String attributeName, java.lang.Integer percent)
void	addRightInterval(java.lang.Double minValue)
void	addRightInterval(java.lang.String attributeName, java.lang.Double minValue)
void	addRightIntervalAsPercent(java.lang.Integer percent)
void	addRightIntervalAsPercent(java.lang.String attributeName, java.lang.Integer percent)
void	addWhere(java.lang.String attribute, java.lang.String where) Adds attribute name and a where value to a list af attributes which statistics should be calculated.
void	clearWhere() Clears where map.
boolean	getApproximateQuantiles()
java.util.List	getAttributes() Returns list of attribute names (as String objects) that should be calculated.
boolean	getCalculateCategoricalHistogram() Returns whether discrete statistics should be calculated.
boolean	getCalculateCorrelationRatio()
boolean	getCalculateCramerCorrelation()
boolean	getCalculateDetailed() Returns whether detailed statistics should be calculated.
boolean	getCalculateNumericalHistogram() Returns whether continuous statistics should be calculated.
boolean	getCalculatePearsonCorrelation()
boolean	getCalculateQuantiles() Returns whether quantiles should be calculated.
boolean	getCalculateUniformityIndexes()
boolean	getCalcutateBasic()
NamePair[]	getCorrelationPairs()
Interval[]	getEffectiveIntervals(java.lang.String attributeName)
java.lang.Double	getEffectiveLeftInterval(java.lang.String attributeName)
java.lang.Integer	getEffectiveLeftIntervalAsPercent(java.lang.String attributeName)
int	getEffectiveNumberOfIntervals(java.lang.String attributeName)
java.lang.Double	getEffectiveRightInterval(java.lang.String attributeName)
java.lang.Integer	getEffectiveRightIntervalAsPercent(java.lang.String attributeName)
boolean	getExactLimitedDiscrete()
Interval[]	getIntervals()
Interval[]	getIntervals(java.lang.String attributeName)
java.lang.Double	getLeftInterval()
java.lang.Double	getLeftInterval(java.lang.String attributeName)
java.lang.Integer	getLeftIntervalAsPercent()
java.lang.Integer	getLeftIntervalAsPercent(java.lang.String attributeName)
int	getMaxValuesCount() Returns maximum values count for discrete attributes.
int	getNumberOfIntervals() Returns number of itervals to be calculated.
int	getNumberOfIntervals(java.lang.String attributeName) Returns number of itervals to be calculated for specified attribute.
java.lang.Object	getPositiveTargetValue() Returns positive value of a target attribute for which statistics should be calculated.
boolean	getRandomize()
boolean	getRecalculate()
java.lang.Double	getRightInterval()
java.lang.Double	getRightInterval(java.lang.String attributeName)
java.lang.Integer	getRightIntervalAsPercent()
java.lang.Integer	getRightIntervalAsPercent(java.lang.String attributeName)
java.lang.String	getTargetName() Returns name of a target attribute for which statistics should be calculated.
AttributeType	getTargetType() Gets the type of target attribute.
java.lang.String	getWeightName()
java.util.Map	getWhere() Returns a map containing attribute name as a key (String), and a String with a where value.
java.util.Map	getWhereList() Returns a map containing attribute name as a key (String), and a List of Strings with a 'where' statements.
void	removeAttribute(java.lang.String s) Remove an attribute name from a list of attributes that should be calculated.
void	setApproximateQuantiles(boolean b)
void	setCalculateCategoricalHistogram(boolean b) Sets whether discrete statistics should be calculated.
void	setCalculateCorrelationRatio(boolean b)
void	setCalculateCorrelations(boolean b)
void	setCalculateCramerCorrelation(boolean b)
void	setCalculateDetailed(boolean b) Sets whether detailed statistics should be calculated.
void	setCalculateNumericalHistogram(boolean b) Sets whether continuous statistics should be calculated.
void	setCalculatePearsonCorrelation(boolean b)
void	setCalculateQuantiles(boolean b) Sets whether quantiles should be calculated.
void	setCalculateUniformityIndexes(boolean b)
void	setCalcutateBasic(boolean b)
void	setCorrelationPairs(java.lang.String[] s1, java.lang.String[] s2)
void	setExactLimitedDiscrete(boolean exactDiscreteExceeded) Sets whether to choose the most frequent values when maxvalues count is exceeded.
void	setIntervals(Interval[] intervals)
void	setIntervals(java.lang.String attributeName, Interval[] intervals)
void	setMaxValuesCount(int i) Sets maximum values count for discrete attributes.
void	setNumberOfIntervals(int i) Sets number of itervals to be calculated.
void	setNumberOfIntervals(java.lang.String attributeName, java.lang.Integer i) Sets number of itervals to be calculated for specified attribute.
void	setPositiveTargetValue(java.lang.Object category) Sets positive value of a target attribute for which statistics should be calculated.
void	setRandomize(boolean randomize)
void	setRecalculate(boolean recalculate) Sets whether statistics should be recalculated.
void	setTargetName(java.lang.String targetName) Sets name of a target attribute for which statistics should be calculated.
void	setTargetType(AttributeType type) Sets the type of target attribute.
void	setWeightName(java.lang.String weightName)

Method Detail

getCalcutateBasic

boolean getCalcutateBasic()

setCalcutateBasic

void setCalcutateBasic(boolean b)

getCalculateDetailed

boolean getCalculateDetailed()

Returns whether detailed statistics should be calculated. Those statistics are statistics defined in NumericalStatistics object, excluding quantile statistics.

Returns:

true if detailed statics should be calculated.

setCalculateDetailed

void setCalculateDetailed(boolean b)

Sets whether detailed statistics should be calculated. Those statistics are statistics defined in NumericalStatistics object, excluding quantile statistics.

Parameters:

b - true if detailed statics should be calculated.

getCalculateQuantiles

boolean getCalculateQuantiles()

Returns whether quantiles should be calculated.

Returns:

true if quantiles should be calculated.

getApproximateQuantiles

boolean getApproximateQuantiles()

setCalculateQuantiles

void setCalculateQuantiles(boolean b)

Sets whether quantiles should be calculated.

Parameters:

b - true if quantiles should be calculated.

setApproximateQuantiles

void setApproximateQuantiles(boolean b)

getCalculateCategoricalHistogram

boolean getCalculateCategoricalHistogram()

Returns whether discrete statistics should be calculated.

Returns:

true if discrete statistics should be calculated.

setCalculateCategoricalHistogram

void setCalculateCategoricalHistogram(boolean b)

Sets whether discrete statistics should be calculated.

Parameters:

b - true if discrete statistics should be calculated.

getCalculateNumericalHistogram

boolean getCalculateNumericalHistogram()

Returns whether continuous statistics should be calculated.

Returns:

true if continuous statistics should be calculated.

setCalculateNumericalHistogram

void setCalculateNumericalHistogram(boolean b)

Sets whether continuous statistics should be calculated.

Parameters:

b - true if continuous statistics should be calculated.

setCalculateCorrelations

void setCalculateCorrelations(boolean b)

getCalculatePearsonCorrelation

boolean getCalculatePearsonCorrelation()

setCalculatePearsonCorrelation

void setCalculatePearsonCorrelation(boolean b)

getCalculateCramerCorrelation

boolean getCalculateCramerCorrelation()

setCalculateCramerCorrelation

void setCalculateCramerCorrelation(boolean b)

getCalculateCorrelationRatio

boolean getCalculateCorrelationRatio()

setCalculateCorrelationRatio

void setCalculateCorrelationRatio(boolean b)

getCalculateUniformityIndexes

boolean getCalculateUniformityIndexes()

setCalculateUniformityIndexes

void setCalculateUniformityIndexes(boolean b)

getNumberOfIntervals

int getNumberOfIntervals()

Returns number of itervals to be calculated. It is used lonly if continuous statistics are calculated.

Returns:

Number of itervals to be calculated.

getNumberOfIntervals

int getNumberOfIntervals(java.lang.String attributeName)

Returns number of itervals to be calculated for specified attribute. It is used lonly if continuous statistics are calculated.

Parameters:

attributeName - name of the attribute.

Returns:

Number of itervals to be calculated.

getEffectiveNumberOfIntervals

int getEffectiveNumberOfIntervals(java.lang.String attributeName)

setNumberOfIntervals

void setNumberOfIntervals(int i)

Sets number of itervals to be calculated. It is used only if continuous statistics are calculated.

Parameters:

i - number of itervals to be calculated.

setNumberOfIntervals

void setNumberOfIntervals(java.lang.String attributeName,
                        java.lang.Integer i)

Sets number of itervals to be calculated for specified attribute. It is used only if continuous statistics are calculated.

Parameters:

attributeName - name of the attribute.

i - number of itervals to be calculated.

getLeftInterval

java.lang.Double getLeftInterval(java.lang.String attributeName)

getLeftInterval

java.lang.Double getLeftInterval()

getEffectiveLeftInterval

java.lang.Double getEffectiveLeftInterval(java.lang.String attributeName)

getRightInterval

java.lang.Double getRightInterval(java.lang.String attributeName)

getRightInterval

java.lang.Double getRightInterval()

getEffectiveRightInterval

java.lang.Double getEffectiveRightInterval(java.lang.String attributeName)

addLeftInterval

void addLeftInterval(java.lang.String attributeName,
                   java.lang.Double maxValue)

addLeftInterval

void addLeftInterval(java.lang.Double maxValue)

addRightInterval

void addRightInterval(java.lang.String attributeName,
                    java.lang.Double minValue)

addRightInterval

void addRightInterval(java.lang.Double minValue)

getLeftIntervalAsPercent

java.lang.Integer getLeftIntervalAsPercent(java.lang.String attributeName)

getLeftIntervalAsPercent

java.lang.Integer getLeftIntervalAsPercent()

getEffectiveLeftIntervalAsPercent

java.lang.Integer getEffectiveLeftIntervalAsPercent(java.lang.String attributeName)

getRightIntervalAsPercent

java.lang.Integer getRightIntervalAsPercent(java.lang.String attributeName)

getRightIntervalAsPercent

java.lang.Integer getRightIntervalAsPercent()

getEffectiveRightIntervalAsPercent

java.lang.Integer getEffectiveRightIntervalAsPercent(java.lang.String attributeName)

addLeftIntervalAsPercent

void addLeftIntervalAsPercent(java.lang.String attributeName,
                            java.lang.Integer percent)

addLeftIntervalAsPercent

void addLeftIntervalAsPercent(java.lang.Integer percent)

addRightIntervalAsPercent

void addRightIntervalAsPercent(java.lang.String attributeName,
                             java.lang.Integer percent)

addRightIntervalAsPercent

void addRightIntervalAsPercent(java.lang.Integer percent)

setIntervals

void setIntervals(java.lang.String attributeName,
                Interval[] intervals)

setIntervals

void setIntervals(Interval[] intervals)

getIntervals

Interval[] getIntervals(java.lang.String attributeName)

getIntervals

Interval[] getIntervals()

getEffectiveIntervals

Interval[] getEffectiveIntervals(java.lang.String attributeName)

getAttributes

java.util.List getAttributes()

Returns list of attribute names (as String objects) that should be calculated.

Returns:

List of attribute names that should be calculated.

addAttribute

void addAttribute(java.lang.String s)

Adds an attribute name to a list of attributes which statistics should be calculated.

Parameters:

s - attribute name

removeAttribute

void removeAttribute(java.lang.String s)

Remove an attribute name from a list of attributes that should be calculated.

Parameters:

s - attribute name

getWhere

java.util.Map getWhere()

Returns a map containing attribute name as a key (String), and a String with a where value. Where value should use grammar of currently used database.

Returns:

map with attribute name, where value;

getWhereList

java.util.Map getWhereList()

Returns a map containing attribute name as a key (String), and a List of Strings with a 'where' statements. 'Where' should use grammar of currently used database. This method use if there is more than one where statements for given attribute.

Returns:

map with attribute name, list of wheres as value;

addWhere

void addWhere(java.lang.String attribute,
            java.lang.String where)

Adds attribute name and a where value to a list af attributes which statistics should be calculated. Where value should use grammar of currently used database.

Parameters:

attribute - attribute name

where - where value

clearWhere

void clearWhere()

Clears where map.

getMaxValuesCount

int getMaxValuesCount()

Returns maximum values count for discrete attributes. It is used only if discrete statistics are calculated.

Returns:

Maximum values count for discrete attributes.

setMaxValuesCount

void setMaxValuesCount(int i)

Sets maximum values count for discrete attributes. It is used only if discrete statistics are calculated.

Parameters:

i - maximum values count for discrete attributes.

getTargetName

java.lang.String getTargetName()

Returns name of a target attribute for which statistics should be calculated.

Returns:

Name of a target attribute. null if target statictics shouldn't be calculated.

setTargetName

void setTargetName(java.lang.String targetName)

Sets name of a target attribute for which statistics should be calculated.

Parameters:

targetName - name of a target attribute.

getWeightName

java.lang.String getWeightName()

setWeightName

void setWeightName(java.lang.String weightName)

getPositiveTargetValue

java.lang.Object getPositiveTargetValue()

Returns positive value of a target attribute for which statistics should be calculated.

Returns:

positive value of a target or null if not set

setPositiveTargetValue

void setPositiveTargetValue(java.lang.Object category)

Sets positive value of a target attribute for which statistics should be calculated.

Parameters:

positive - value of a target attribute.

getTargetType

AttributeType getTargetType()

Gets the type of target attribute.

Returns:

type of target attribute.

setTargetType

void setTargetType(AttributeType type)

Sets the type of target attribute.

Parameters:

type - type of target attribute.

getRecalculate

boolean getRecalculate()

setRecalculate

void setRecalculate(boolean recalculate)

Sets whether statistics should be recalculated.

Parameters:

recalculate - true if statistics should be recalculated.

getRandomize

boolean getRandomize()

setRandomize

void setRandomize(boolean randomize)

getExactLimitedDiscrete

boolean getExactLimitedDiscrete()

setExactLimitedDiscrete

void setExactLimitedDiscrete(boolean exactDiscreteExceeded)

Sets whether to choose the most frequent values when maxvalues count is exceeded.

setCorrelationPairs

void setCorrelationPairs(java.lang.String[] s1,
                       java.lang.String[] s2)

getCorrelationPairs

NamePair[] getCorrelationPairs()