com.espertech.esper.type

Class FrequencyParameter

java.lang.Object

com.espertech.esper.type.FrequencyParameter

All Implemented Interfaces:

NumberSetParameter, MetaDefItem, Serializable

public class FrequencyParameter
extends Object
implements NumberSetParameter

Encapsulates a parameter specifying a frequency, i.e. '* / 5'.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FrequencyParameter(int frequency) Ctor.

Method Summary

Modifier and Type	Method and Description
boolean	containsPoint(int point)
String	formatted()
int	getFrequency() Returns frequency.
Set<Integer>	getValuesInRange(int min, int max) Return a set of int values representing the value of the parameter for the given range.
boolean	isWildcard(int min, int max) Returns true if all values between and including min and max are supplied by the parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

FrequencyParameter

public FrequencyParameter(int frequency)

Ctor.

Parameters:

frequency - - divisor specifying frequency

Method Detail

getFrequency

public int getFrequency()

Returns frequency.

Returns:

frequency divisor

isWildcard

public boolean isWildcard(int min,
                          int max)

Description copied from interface: NumberSetParameter

Returns true if all values between and including min and max are supplied by the parameter.

Specified by:

isWildcard in interface NumberSetParameter

Parameters:

min - - lower end of range

max - - upper end of range

Returns:

true if parameter specifies all int values between min and max, false if not

getValuesInRange

public Set<Integer> getValuesInRange(int min,
                                     int max)

Description copied from interface: NumberSetParameter

Return a set of int values representing the value of the parameter for the given range.

Specified by:

getValuesInRange in interface NumberSetParameter

Parameters:

min - - lower end of range

max - - upper end of range

Returns:

set of integer

containsPoint

public boolean containsPoint(int point)

Specified by:

containsPoint in interface NumberSetParameter

formatted

public String formatted()

Specified by:

formatted in interface NumberSetParameter