net.esper.eql.spec
Class OutputLimitSpec

java.lang.Object
  extended by net.esper.eql.spec.OutputLimitSpec
All Implemented Interfaces:
Serializable, MetaDefItem

public class OutputLimitSpec
extends Object
implements MetaDefItem

Spec for defining an output rate

See Also:
Serialized Form

Constructor Summary
OutputLimitSpec(Double rate, String variableForRate, OutputLimitRateType rateType, OutputLimitLimitType displayLimit)
          Ctor.
 
Method Summary
 OutputLimitLimitType getDisplayLimit()
          Returns the type of output limit.
 Double getRate()
          Returns the rate, or null or -1 if a variable is used instead
 OutputLimitRateType getRateType()
          Returns the type of rate.
 String getVariableName()
          Returns the variable name if set, or null if a fixed rate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OutputLimitSpec

public OutputLimitSpec(Double rate,
                       String variableForRate,
                       OutputLimitRateType rateType,
                       OutputLimitLimitType displayLimit)
Ctor. For batching events by event count.

Parameters:
rate - is the fixed output rate, or null if by variable
displayLimit - - indicates whether to output only the first, only the last, or all events
variableForRate - - an optional variable name instead of the rate
rateType - - type of the rate
Method Detail

getDisplayLimit

public OutputLimitLimitType getDisplayLimit()
Returns the type of output limit.

Returns:
limit

getRateType

public OutputLimitRateType getRateType()
Returns the type of rate.

Returns:
rate type

getRate

public Double getRate()
Returns the rate, or null or -1 if a variable is used instead

Returns:
rate if set

getVariableName

public String getVariableName()
Returns the variable name if set, or null if a fixed rate

Returns:
variable name

© 2007 EsperTech Inc.
All rights reserved.
Visit us at espertech.com