Package net.vleo.timel.iterator

Class ChopUpscalableIterator<V>

java.lang.Object

net.vleo.timel.iterator.ChopUpscalableIterator<V>

All Implemented Interfaces:

TimeIterator<V>, UpscalableIterator<V>

public final class ChopUpscalableIterator<V>
extends Object
implements UpscalableIterator<V>

An implementation of UpscalableIterator that will ensure its output to be chopped over a given interval.

Author:

Andrea Leofreddi

Constructor Summary

Constructors

Constructor	Description
ChopUpscalableIterator(UpscalableIterator<V> delegate, Interval interval)	Instance a new ChopUpscalableIterator for the given delegate and interval.

Method Summary

Modifier and Type	Method	Description
boolean	hasNext()	Test if there is a next element.
Sample<V>	next()	Move forward the iterator and return the next value.
Sample<V>	peekNext()	Peek the next element without moving forward the iterator.
Sample<V>	peekUpscaleNext(Interval interval)	Retrieve a sample which contains the upscaled value, relative to the given interval, for the next value.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ChopUpscalableIterator

public ChopUpscalableIterator(UpscalableIterator<V> delegate,
                              Interval interval)

Instance a new ChopUpscalableIterator for the given delegate and interval.

Parameters:

delegate - Source iterator

interval - Chop interval

Method Detail

hasNext

public final boolean hasNext()

Description copied from interface: TimeIterator

Test if there is a next element.

Specified by:

hasNext in interface TimeIterator<V>

Returns:

True iff there is a next element

peekUpscaleNext

public final Sample<V> peekUpscaleNext(Interval interval)

Description copied from interface: UpscalableIterator

Retrieve a sample which contains the upscaled value, relative to the given interval, for the next value. As this operation peeks the next value, the iterator is not moved forward.

Specified by:

peekUpscaleNext in interface UpscalableIterator<V>

Parameters:

interval - The interval to upscaler the value with

Returns:

The upscaled next

next

public final Sample<V> next()
                     throws NoSuchElementException

Description copied from interface: TimeIterator

Move forward the iterator and return the next value.

Specified by:

next in interface TimeIterator<V>

Returns:

The next sample

Throws:

NoSuchElementException - If there is no next element

peekNext

public final Sample<V> peekNext()
                         throws NoSuchElementException

Description copied from interface: TimeIterator

Peek the next element without moving forward the iterator.

Specified by:

peekNext in interface TimeIterator<V>

Returns:

The next sample

Throws:

NoSuchElementException - If there is no next element

toString

public final String toString()

Overrides:

toString in class Object