|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.base.stats.bin.RegularSequence
public class RegularSequence
Generates a regularly spaced sequence of Bins.
Constructor Summary | |
---|---|
RegularSequence(Element step)
Create a BinSequence that will generate a sequence of regularly spaced intervals. |
|
RegularSequence(Element begin,
Element step)
Create a BinSequence that will generate a sequence of regularly spaced intervals. |
Method Summary | |
---|---|
Bin |
getBin(Element element)
Get the Bin for the specified Element. |
Bin[] |
getBins(Element minElement,
Element maxElement)
Get a sequence of Bins. |
Bin[] |
getBins(Element minElement,
Element maxElement,
boolean containsMin,
boolean containsMax)
Get a sequence of bins starting at minElement and ending with maxElement. |
Bin |
getNext(Bin bin)
Get the next bin in the sequence following the specified bin |
Element |
getStep()
Get the interval step size for this sequence. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public RegularSequence(Element begin, Element step)
Create a BinSequence that will generate a sequence of regularly spaced intervals. The precision of elements is truncated to begin + K * step where K is an integer. The step parameter sets the width of the intervals to be generated.
begin
- The zero point for the sequencestep
- The step size between each intervalpublic RegularSequence(Element step)
step
- The step size between each intervalMethod Detail |
---|
public Element getStep()
public Bin getBin(Element element)
getBin
in interface BinSequence
element
- Element to be placed in a Bin
public Bin getNext(Bin bin)
getNext
in interface BinSequence
bin
- Current bin in the sequence
public Bin[] getBins(Element minElement, Element maxElement)
BinSequence
getBins
in interface BinSequence
minElement
- An element that should be contained in the first Bin.maxElement
- An element that should be contained in the last Bin.
public Bin[] getBins(Element minElement, Element maxElement, boolean containsMin, boolean containsMax)
Get a sequence of bins starting at minElement and ending with maxElement.
getBins
in interface BinSequence
minElement
- An element used to define the beginning of the sequencemaxElement
- An element used to define the end of the sequencecontainsMin
- Should the list contain the first Bin?containsMax
- Should the list contain the last Bin?
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |