com.pervasive.datarush.analytics.stats

Class UnivariateStats

java.lang.Object

com.pervasive.datarush.analytics.stats.UnivariateStats

public final class UnivariateStats
extends Object

Object representation of the PMML UnivariateStats element.

See Also:

PMMLSummaryStatisticsModel

Constructor Summary

Constructors

Constructor and Description
UnivariateStats(String field) Create a new UnivariateStats element for the given field.

Method Summary

Methods

Modifier and Type	Method and Description
Long	getCardinality() Returns the value of the "cardinality" attribute of the Counts sub-element.
AbstractContinuousStatistics<? extends Number>	getContinuousStatistics() Returns the value of the ContStats sub-element.
DiscreteStatistics	getDiscreteStatistics() Returns the value of the DiscrStats sub-element.
String	getField() Returns the value of the "field" attribute
Long	getInvalidFrequency() Returns the value of the "invalidFreq" attribute of the Counts sub-element.
String	getMaxValue() Get the maximum value of the field.
String	getMinValue() Get the minimum value of the field.
Long	getMissingFrequency() Returns the value of the "missingFreq" attribute of the Counts sub-element.
AbstractNumericInfo<? extends Number>	getNumericInfo() Returns the value of the NumericInfo sub-element.
long	getTestFailureCount(String testName) Returns the test failure count for the given test name.
Map<String,Long>	getTestFailureCounts() Returns a mapping of test failures counts.
long	getTotalFrequency() Returns the value of the "totalFreq" attribute of the Counts sub-element.
void	setCardinality(Long cardinality) Sets the value of the "cardinality" attribute of the Counts sub-element.
void	setContinuousStatistics(AbstractContinuousStatistics<? extends Number> continuousStatistics) Sets the value of the ContStats sub-element.
void	setDiscreteStatistics(DiscreteStatistics discreteStatistics) Sets the value of the DiscrStats sub-element.
void	setInvalidFrequency(Long invalidFrequency) Sets the value of the "invalidFreq" attribute of the Counts sub-element.
void	setMaxValue(String maxValue) Set the maximum value of the field.
void	setMinValue(String minValue) Set the minimum value of the field.
void	setMissingFrequency(Long missingFrequency) Sets the value of the "missingFreq" attribute of the Counts sub-element.
void	setNumericInfo(AbstractNumericInfo<? extends Number> numericInfo) Sets the value of the NumericInfo sub-element.
void	setTestFailureCount(String testName, long failureCount) Sets the test failure count for the given test name.
void	setTestFailureCounts(Map<String,Long> testFailureCounts) Sets a mapping of test failures counts.
void	setTotalFrequency(long totalFrequency) Sets the value of the "totalFreq" attribute of the Counts sub-element.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

UnivariateStats

public UnivariateStats(String field)

Create a new UnivariateStats element for the given field.

Parameters:

field - the value for the "field" attribute

Method Detail

getField

public String getField()

Returns the value of the "field" attribute

Returns:

the value of the "field" attribute

getTotalFrequency

public long getTotalFrequency()

Returns the value of the "totalFreq" attribute of the Counts sub-element.

Returns:

the value of the "totalFreq" attribute

setTotalFrequency

public void setTotalFrequency(long totalFrequency)

Sets the value of the "totalFreq" attribute of the Counts sub-element.

Parameters:

totalFrequency - the value of the "totalFreq" attribute

getTestFailureCounts

public Map<String,Long> getTestFailureCounts()

Returns a mapping of test failures counts. Test failures are a PMML extension that captures the results of the DataQualityAnalyzer. Keys in the map correspond to test names. Values in the map provide a count of the number of test failures.

Returns:

a mapping of test failures counts

setTestFailureCounts

public void setTestFailureCounts(Map<String,Long> testFailureCounts)

Sets a mapping of test failures counts. Test failures are a PMML extension that captures the results of the DataQualityAnalyzer. Keys in the map correspond to test names. Values in the map provide a count of the number of test failures.

Parameters:

testFailureCounts - a mapping of test failures counts

getTestFailureCount

public long getTestFailureCount(String testName)

Returns the test failure count for the given test name. Test failures are a PMML extension that captures the results of the DataQualityAnalyzer.

Parameters:

testName - the name of the test that (potentially) failed

Returns:

a count of the number of failures or zero if no failures

setTestFailureCount

public void setTestFailureCount(String testName,
                       long failureCount)

Sets the test failure count for the given test name. Test failures are a PMML extension that captures the results of the DataQualityAnalyzer.

Parameters:

testName - the name of the test that (potentially) failed

failureCount - a count of the number of failures or zero if no failures

getMissingFrequency

public Long getMissingFrequency()

Returns the value of the "missingFreq" attribute of the Counts sub-element.

Returns:

the value of the "missingFreq" attribute

setMissingFrequency

public void setMissingFrequency(Long missingFrequency)

Sets the value of the "missingFreq" attribute of the Counts sub-element.

Parameters:

missingFrequency - the value of the "missingFreq" attribute

getNumericInfo

public AbstractNumericInfo<? extends Number> getNumericInfo()

Returns the value of the NumericInfo sub-element.

Returns:

the value of the NumericInfo sub-element.

setNumericInfo

public void setNumericInfo(AbstractNumericInfo<? extends Number> numericInfo)

Sets the value of the NumericInfo sub-element.

Parameters:

numericInfo - the value of the NumericInfo sub-element.

getInvalidFrequency

public Long getInvalidFrequency()

Returns the value of the "invalidFreq" attribute of the Counts sub-element.

Returns:

the value of the "invalidFreq" attribute

setInvalidFrequency

public void setInvalidFrequency(Long invalidFrequency)

Sets the value of the "invalidFreq" attribute of the Counts sub-element.

Parameters:

invalidFrequency - the value of the "invalidFreq" attribute

getCardinality

public Long getCardinality()

Returns the value of the "cardinality" attribute of the Counts sub-element.

Returns:

the value of the "cardinality" attribute

setCardinality

public void setCardinality(Long cardinality)

Sets the value of the "cardinality" attribute of the Counts sub-element.

Parameters:

cardinality - the value of the "cardinality" attribute

getDiscreteStatistics

public DiscreteStatistics getDiscreteStatistics()

Returns the value of the DiscrStats sub-element.

Returns:

the value of the DiscrStats sub-element.

setDiscreteStatistics

public void setDiscreteStatistics(DiscreteStatistics discreteStatistics)

Sets the value of the DiscrStats sub-element.

Parameters:

discreteStatistics - the value of the DiscrStats sub-element.

getContinuousStatistics

public AbstractContinuousStatistics<? extends Number> getContinuousStatistics()

Returns the value of the ContStats sub-element.

Returns:

the value of the ContStats sub-element.

setContinuousStatistics

public void setContinuousStatistics(AbstractContinuousStatistics<? extends Number> continuousStatistics)

Sets the value of the ContStats sub-element.

Parameters:

continuousStatistics - the value of the ContStats sub-element.

setMinValue

public void setMinValue(String minValue)

Set the minimum value of the field. This is only useful for non-numeric data type. Numeric types support more detailed numeric information that can be obtained with getNumericInfo().

Parameters:

minValue - minimum value (converted to a String)

getMinValue

public String getMinValue()

Get the minimum value of the field. This is only useful for non-numeric data type. Numeric types support more detailed numeric information that can be obtained with getNumericInfo().

Returns:

minimum value (converted to String)

setMaxValue

public void setMaxValue(String maxValue)

Set the maximum value of the field. This is only useful for non-numeric data type. Numeric types support more detailed numeric information that can be obtained with getNumericInfo().

Parameters:

maxValue - maximum value (converted to a String)

getMaxValue

public String getMaxValue()

Get the maximum value of the field. This is only useful for non-numeric data type. Numeric types support more detailed numeric information that can be obtained with getNumericInfo().

Returns:

maximum value (converted to String)

toString

public String toString()

Overrides:

toString in class Object