net.esper.type
Class FrequencyParameter

java.lang.Object
  extended by net.esper.type.FrequencyParameter
All Implemented Interfaces:
Serializable, EQLParameterType, NumberSetParameter, MetaDefItem

public class FrequencyParameter
extends Object
implements NumberSetParameter

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

See Also:
Serialized Form

Constructor Summary
FrequencyParameter(int frequency)
          Ctor.
 
Method Summary
 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.
 void toEQL(StringWriter writer)
          Returns the EQL representation of 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

toEQL

public void toEQL(StringWriter writer)
Description copied from interface: EQLParameterType
Returns the EQL representation of the parameter.

Specified by:
toEQL in interface EQLParameterType
Specified by:
toEQL in interface NumberSetParameter
Parameters:
writer - for output to