Package org.apache.datasketches.req

Class ReqSketchBuilder

java.lang.Object

org.apache.datasketches.req.ReqSketchBuilder

public class ReqSketchBuilder
extends Object

For building a new ReqSketch

Author:

Lee Rhodes

Constructor Summary

Constructors

Constructor	Description
ReqSketchBuilder()	Constructor for the ReqSketchBuilder.

Method Summary

Modifier and Type	Method	Description
ReqSketch	build()	Returns a new ReqSketch with the current configuration of the builder.
boolean	getHighRankAccuracy()	Gets the builder confibured value of High Rank Accuracy.
int	getK()	Gets the builder configured value of k.
boolean	getLessThanOrEqual()	Gets the builder configured value of Less-Than-Or-Equal.
ReqDebug	getReqDebug()	Gets the builder configured value of ReqDebug
ReqSketchBuilder	setHighRankAccuracy(boolean hra)	This sets the parameter highRankAccuracy.
ReqSketchBuilder	setK(int k)	This sets the parameter k.
ReqSketchBuilder	setLessThanOrEqual(boolean ltEq)	Sets the parameter lessThanOrEquals.
ReqSketchBuilder	setReqDebug(ReqDebug reqDebug)	This sets the parameter reqDebug.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ReqSketchBuilder

public ReqSketchBuilder()

Constructor for the ReqSketchBuilder.

Method Detail

build

public ReqSketch build()

Returns a new ReqSketch with the current configuration of the builder.

Returns:

a new ReqSketch

getHighRankAccuracy

public boolean getHighRankAccuracy()

Gets the builder confibured value of High Rank Accuracy.

Returns:

the builder confibured value of High Rank Accuracy.

getK

public int getK()

Gets the builder configured value of k.

Returns:

the builder configured value of k.

getLessThanOrEqual

public boolean getLessThanOrEqual()

Gets the builder configured value of Less-Than-Or-Equal.

Returns:

the builder confibured value of Less-Than-Or-Equal

getReqDebug

public ReqDebug getReqDebug()

Gets the builder configured value of ReqDebug

Returns:

the builder configured value of ReqDebug, or null.

setHighRankAccuracy

public ReqSketchBuilder setHighRankAccuracy(boolean hra)

This sets the parameter highRankAccuracy.

Parameters:

hra - See ReqSketch#ReqSketch(int, boolean, ReqDebug)

Returns:

this

setK

public ReqSketchBuilder setK(int k)

This sets the parameter k.

Parameters:

k - See ReqSketch#ReqSketch(int, boolean, ReqDebug)

Returns:

this

setLessThanOrEqual

public ReqSketchBuilder setLessThanOrEqual(boolean ltEq)

Sets the parameter lessThanOrEquals. This parameter can also be modified after the sketch has been constructed. It is included here for convenience.

Parameters:

ltEq - See ReqSketch.setLessThanOrEqual(boolean)

Returns:

this

setReqDebug

public ReqSketchBuilder setReqDebug(ReqDebug reqDebug)

This sets the parameter reqDebug.

Parameters:

reqDebug - See ReqSketch#ReqSketch(int, boolean, ReqDebug)

Returns:

this

toString

public String toString()

Overrides:

toString in class Object