Package org.alfresco.search.model

Class RequestStats

java.lang.Object

org.alfresco.search.model.RequestStats

@Validated
public class RequestStats
extends Object

A list of stats request.

Constructor Summary

Constructors

Constructor	Description
RequestStats()

Method Summary

Modifier and Type	Method	Description
RequestStats	addExcludeFiltersItem(String excludeFiltersItem)
RequestStats	addPercentilesItem(Float percentilesItem)
RequestStats	cardinality(Boolean cardinality)
RequestStats	cardinalityAccuracy(Float cardinalityAccuracy)
RequestStats	countDistinct(Boolean countDistinct)
RequestStats	countValues(Boolean countValues)
RequestStats	distinctValues(Boolean distinctValues)
boolean	equals(Object o)
RequestStats	excludeFilters(List<String> excludeFilters)
RequestStats	field(String field)
Float	getCardinalityAccuracy()	Number between 0.0 and 1.0 indicating how aggressively the algorithm should try to be accurate.
List<String>	getExcludeFilters()	A list of filters to exclude
String	getField()	The stats field
String	getLabel()	A label to include for reference the stats field
List<Float>	getPercentiles()	A list of percentile values, e.g.
int	hashCode()
Boolean	isCardinality()	A statistical approximation of the number of distinct values
Boolean	isCountDistinct()	The number of distinct values (This can be very expensive to calculate)
Boolean	isCountValues()	The number which have a value for this field
Boolean	isDistinctValues()	The set of all distinct values for the field (This can be very expensive to calculate)
Boolean	isMax()	The maximum value of the field
Boolean	isMean()	The average
Boolean	isMin()	The minimum value of the field
Boolean	isMissing()	The number which do not have a value for this field
Boolean	isStddev()	Standard deviation
Boolean	isSum()	The sum of all values of the field
Boolean	isSumOfSquares()	Sum of all values squared
RequestStats	label(String label)
RequestStats	max(Boolean max)
RequestStats	mean(Boolean mean)
RequestStats	min(Boolean min)
RequestStats	missing(Boolean missing)
RequestStats	percentiles(List<Float> percentiles)
void	setCardinality(Boolean cardinality)
void	setCardinalityAccuracy(Float cardinalityAccuracy)
void	setCountDistinct(Boolean countDistinct)
void	setCountValues(Boolean countValues)
void	setDistinctValues(Boolean distinctValues)
void	setExcludeFilters(List<String> excludeFilters)
void	setField(String field)
void	setLabel(String label)
void	setMax(Boolean max)
void	setMean(Boolean mean)
void	setMin(Boolean min)
void	setMissing(Boolean missing)
void	setPercentiles(List<Float> percentiles)
void	setStddev(Boolean stddev)
void	setSum(Boolean sum)
void	setSumOfSquares(Boolean sumOfSquares)
RequestStats	stddev(Boolean stddev)
RequestStats	sum(Boolean sum)
RequestStats	sumOfSquares(Boolean sumOfSquares)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RequestStats

public RequestStats()

Method Detail

field

public RequestStats field(String field)

getField

public String getField()

The stats field

Returns:

field

setField

public void setField(String field)

label

public RequestStats label(String label)

getLabel

public String getLabel()

A label to include for reference the stats field

Returns:

label

setLabel

public void setLabel(String label)

min

public RequestStats min(Boolean min)

isMin

public Boolean isMin()

The minimum value of the field

Returns:

min

setMin

public void setMin(Boolean min)

max

public RequestStats max(Boolean max)

isMax

public Boolean isMax()

The maximum value of the field

Returns:

max

setMax

public void setMax(Boolean max)

sum

public RequestStats sum(Boolean sum)

isSum

public Boolean isSum()

The sum of all values of the field

Returns:

sum

setSum

public void setSum(Boolean sum)

countValues

public RequestStats countValues(Boolean countValues)

isCountValues

public Boolean isCountValues()

The number which have a value for this field

Returns:

countValues

setCountValues

public void setCountValues(Boolean countValues)

missing

public RequestStats missing(Boolean missing)

isMissing

public Boolean isMissing()

The number which do not have a value for this field

Returns:

missing

setMissing

public void setMissing(Boolean missing)

mean

public RequestStats mean(Boolean mean)

isMean

public Boolean isMean()

The average

Returns:

mean

setMean

public void setMean(Boolean mean)

stddev

public RequestStats stddev(Boolean stddev)

isStddev

public Boolean isStddev()

Standard deviation

Returns:

stddev

setStddev

public void setStddev(Boolean stddev)

sumOfSquares

public RequestStats sumOfSquares(Boolean sumOfSquares)

isSumOfSquares

public Boolean isSumOfSquares()

Sum of all values squared

Returns:

sumOfSquares

setSumOfSquares

public void setSumOfSquares(Boolean sumOfSquares)

distinctValues

public RequestStats distinctValues(Boolean distinctValues)

isDistinctValues

public Boolean isDistinctValues()

The set of all distinct values for the field (This can be very expensive to calculate)

Returns:

distinctValues

setDistinctValues

public void setDistinctValues(Boolean distinctValues)

countDistinct

public RequestStats countDistinct(Boolean countDistinct)

isCountDistinct

public Boolean isCountDistinct()

The number of distinct values (This can be very expensive to calculate)

Returns:

countDistinct

setCountDistinct

public void setCountDistinct(Boolean countDistinct)

cardinality

public RequestStats cardinality(Boolean cardinality)

isCardinality

public Boolean isCardinality()

A statistical approximation of the number of distinct values

Returns:

cardinality

setCardinality

public void setCardinality(Boolean cardinality)

cardinalityAccuracy

public RequestStats cardinalityAccuracy(Float cardinalityAccuracy)

getCardinalityAccuracy

public Float getCardinalityAccuracy()

Number between 0.0 and 1.0 indicating how aggressively the algorithm should try to be accurate. Used with boolean cardinality flag.

Returns:

cardinalityAccuracy

setCardinalityAccuracy

public void setCardinalityAccuracy(Float cardinalityAccuracy)

excludeFilters

public RequestStats excludeFilters(List<String> excludeFilters)

addExcludeFiltersItem

public RequestStats addExcludeFiltersItem(String excludeFiltersItem)

getExcludeFilters

public List<String> getExcludeFilters()

A list of filters to exclude

Returns:

excludeFilters

setExcludeFilters

public void setExcludeFilters(List<String> excludeFilters)

percentiles

public RequestStats percentiles(List<Float> percentiles)

addPercentilesItem

public RequestStats addPercentilesItem(Float percentilesItem)

getPercentiles

public List<Float> getPercentiles()

A list of percentile values, e.g. \"1,99,99.9\"

Returns:

percentiles

setPercentiles

public void setPercentiles(List<Float> percentiles)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object