ai.databand.log

Class HistogramRequest

java.lang.Object

ai.databand.log.HistogramRequest

public class HistogramRequest
extends java.lang.Object

Allows to customize dataframe reporting. Only boolean, numeric and string columns are supported.

Constructor Summary

Constructors

Constructor and Description
HistogramRequest() Default constructor assumes full descriptive statistics and histograms calculation
HistogramRequest(boolean all)

Method Summary

Modifier and Type	Method and Description
static HistogramRequest	ALL_BOOLEAN() Generate report only for boolean columns.
static HistogramRequest	ALL_NUMERIC() Generate report only for numeric columns.
static HistogramRequest	ALL_STRING() Generate report only for string columns.
static HistogramRequest	ALL() Generate report for all columns.
HistogramRequest	approxDistinct() Use approximate distinct calculation method.
static HistogramRequest	DEFAULT() Default request assumes all columns.
HistogramRequest	excludeColumns(java.util.Collection<java.lang.String> columns) Exclude columns from calculations.
java.util.Set<java.lang.String>	getExcludeColumns()
protected java.util.Set<java.lang.String>	getIncludeColumns()
HistogramRequest	includeAllBoolean() Include all boolean columns.
HistogramRequest	includeAllNumeric() Include all numeric columns.
HistogramRequest	includeAllString() Include all string columns.
HistogramRequest	includeColumns(java.util.Collection<java.lang.String> columns) Column names to include into report.
boolean	isApproxDistinct()
boolean	isEnabled()
boolean	isExcluded(java.lang.String column)
boolean	isIncludeAllBoolean()
boolean	isIncludeAllNumeric()
boolean	isIncludeAllString()
boolean	isOnlyStats()
static HistogramRequest	NONE() Do not generate report at all.
HistogramRequest	onlyStats() Generate only descriptive statistics.

Methods inherited from class java.lang.Object

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

Constructor Detail

HistogramRequest

public HistogramRequest()

Default constructor assumes full descriptive statistics and histograms calculation

HistogramRequest

public HistogramRequest(boolean all)

Parameters:

all -

Method Detail

includeColumns

public HistogramRequest includeColumns(java.util.Collection<java.lang.String> columns)

Column names to include into report. Unless provided, all columns will be reported, except of excluded. If provided, only these columns will be included to the report.

Parameters:

columns -

Returns:

excludeColumns

public HistogramRequest excludeColumns(java.util.Collection<java.lang.String> columns)

Exclude columns from calculations.

Parameters:

columns -

Returns:

includeAllBoolean

public HistogramRequest includeAllBoolean()

Include all boolean columns.

Returns:

includeAllNumeric

public HistogramRequest includeAllNumeric()

Include all numeric columns.

Returns:

includeAllString

public HistogramRequest includeAllString()

Include all string columns.

Returns:

onlyStats

public HistogramRequest onlyStats()

Generate only descriptive statistics.

Returns:

approxDistinct

public HistogramRequest approxDistinct()

Use approximate distinct calculation method. May speed up calculations.

Returns:

getIncludeColumns

protected java.util.Set<java.lang.String> getIncludeColumns()

getExcludeColumns

public java.util.Set<java.lang.String> getExcludeColumns()

isIncludeAllBoolean

public boolean isIncludeAllBoolean()

isIncludeAllNumeric

public boolean isIncludeAllNumeric()

isIncludeAllString

public boolean isIncludeAllString()

isOnlyStats

public boolean isOnlyStats()

isApproxDistinct

public boolean isApproxDistinct()

isEnabled

public boolean isEnabled()

isExcluded

public boolean isExcluded(java.lang.String column)

ALL

public static HistogramRequest ALL()

Generate report for all columns.

Returns:

ALL_STRING

public static HistogramRequest ALL_STRING()

Generate report only for string columns.

Returns:

ALL_BOOLEAN

public static HistogramRequest ALL_BOOLEAN()

Generate report only for boolean columns.

Returns:

ALL_NUMERIC

public static HistogramRequest ALL_NUMERIC()

Generate report only for numeric columns.

Returns:

NONE

public static HistogramRequest NONE()

Do not generate report at all.

Returns:

DEFAULT

public static HistogramRequest DEFAULT()

Default request assumes all columns.

Returns: