biz.sc.mm.dm.algorithm.abm

Interface Sample

All Superinterfaces:

Module

public interface Sample
extends Module

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getAutoRatio()
int	getMaxDiscreteCount()
int	getMaxSize()
double	getPositiveTargetCategoryRatio()
double	getRatio()
SampleResult	getResult()
boolean	getSampleTestTable()
SamplingMode	getSamplingMode()
java.lang.Integer	getSeed()
int	getSize()
StratificationMode	getStratificationMode()
void	setAutoRatio(boolean autoRatio)
void	setMaxDiscreteCount(int maxDiscreteCount)
void	setMaxSize(int maxSize)
void	setPositiveTargetCategoryRatio(double ratio)
void	setRatio(double ratio)
void	setSampleTestTable(boolean sample)
void	setSamplingMode(SamplingMode mode)
void	setSeed(java.lang.Integer seed)
void	setSize(int size)
void	setStratificationMode(StratificationMode mode)

Methods inherited from interface biz.sc.mm.dm.algorithm.abm.Module

addOut, addOutRole, getAddedOutRoles, getChangedInRole, getChangedName, getChangedOutRole, getExecutionTime, getForceRecalculate, getIn, getName, getOut, getOutTables, getProcessedTable, getValidationError, removeOut, removeOutRole, setForceRecalculate, setInRole, setName, setOutRole, setProcessedTable, unsetInRole, unsetName, unsetOutRole

Method Detail

setSamplingMode

void setSamplingMode(SamplingMode mode)

getSamplingMode

SamplingMode getSamplingMode()

setSize

void setSize(int size)

Parameters:

size - used if SamplingMode is set to SamplingMode.MANUAL

getSize

int getSize()

setMaxDiscreteCount

void setMaxDiscreteCount(int maxDiscreteCount)

Parameters:

maxDiscreteCount - maximum number of categories of a categorical attribute that allows this attribute to be used in automatic sample size calculation.

getMaxDiscreteCount

int getMaxDiscreteCount()

setAutoRatio

void setAutoRatio(boolean autoRatio)

Parameters:

autoRatio - if true validation table's size will be calculated automatically.

getAutoRatio

boolean getAutoRatio()

setRatio

void setRatio(double ratio)

Parameters:

ratio - If higher then 0 than validation table's size is equal to ratio multiplied by main table's size. Otherwise validation table isn't sampled. Is used only if autoRatio is false.

getRatio

double getRatio()

setSampleTestTable

void setSampleTestTable(boolean sample)

getSampleTestTable

boolean getSampleTestTable()

setMaxSize

void setMaxSize(int maxSize)

Parameters:

maxSize - maximum posible sample size of the main table. Ignored when SamplingMode.MANUAL is set.

getMaxSize

int getMaxSize()

setStratificationMode

void setStratificationMode(StratificationMode mode)

getStratificationMode

StratificationMode getStratificationMode()

setPositiveTargetCategoryRatio

void setPositiveTargetCategoryRatio(double ratio)

Parameters:

ratio - used if StratificationMode isn't set to StratificationMode.NONE

getPositiveTargetCategoryRatio

double getPositiveTargetCategoryRatio()

setSeed

void setSeed(java.lang.Integer seed)

getSeed

java.lang.Integer getSeed()

getResult

SampleResult getResult()