com.espertech.esper.epl.spec
Class OutputLimitSpec

java.lang.Object
  extended by com.espertech.esper.epl.spec.OutputLimitSpec
All Implemented Interfaces:
MetaDefItem, java.io.Serializable

public class OutputLimitSpec
extends java.lang.Object
implements MetaDefItem, java.io.Serializable

Spec for defining an output rate

See Also:
Serialized Form

Constructor Summary
OutputLimitSpec(java.lang.Double rate, java.lang.String variableForRate, OutputLimitRateType rateType, OutputLimitLimitType displayLimit, ExprNode whenExpressionNode, java.util.List<OnTriggerSetAssignment> thenExpressions, java.util.List<ExprNode> crontabAtSchedule, ExprTimePeriod timePeriodExpr, ExprTimePeriod afterTimePeriodExpr, java.lang.Integer afterNumberOfEvents, boolean andAfterTerminate, ExprNode andAfterTerminateExpr, java.util.List<OnTriggerSetAssignment> andAfterTerminateSetExpressions)
          Ctor.
OutputLimitSpec(OutputLimitLimitType displayLimit, OutputLimitRateType rateType)
           
 
Method Summary
 java.lang.Integer getAfterNumberOfEvents()
          Returns the after-keyword number of events.
 ExprTimePeriod getAfterTimePeriodExpr()
          Returns the after-keyword time period.
 ExprNode getAndAfterTerminateExpr()
           
 java.util.List<OnTriggerSetAssignment> getAndAfterTerminateThenExpressions()
           
 java.util.List<ExprNode> getCrontabAtSchedule()
          Returns crontab parameters, or null if not using crontab-at output.
 OutputLimitLimitType getDisplayLimit()
          Returns the type of output limit.
 java.lang.Double getRate()
          Returns the rate, or null or -1 if a variable is used instead
 OutputLimitRateType getRateType()
          Returns the type of rate.
 java.util.List<OnTriggerSetAssignment> getThenExpressions()
          Returns a list of variable assignments, or null if none made.
 ExprTimePeriod getTimePeriodExpr()
          Returns time period expression or null if none used.
 java.lang.String getVariableName()
          Returns the variable name if set, or null if a fixed rate
 ExprNode getWhenExpressionNode()
          Returns the when-keyword trigger expression, or null if not using when.
 boolean isAndAfterTerminate()
           
 void setAfterTimePeriodExpr(ExprTimePeriod afterTimePeriodExpr)
           
 void setAndAfterTerminateExpr(ExprNode andAfterTerminateExpr)
           
 void setAndAfterTerminateThenExpressions(java.util.List<OnTriggerSetAssignment> andAfterTerminateThenExpressions)
           
 void setTimePeriodExpr(ExprTimePeriod timePeriodExpr)
           
 void setWhenExpressionNode(ExprNode whenExpressionNode)
          Sets a new when-keyword trigger expression.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OutputLimitSpec

public OutputLimitSpec(java.lang.Double rate,
                       java.lang.String variableForRate,
                       OutputLimitRateType rateType,
                       OutputLimitLimitType displayLimit,
                       ExprNode whenExpressionNode,
                       java.util.List<OnTriggerSetAssignment> thenExpressions,
                       java.util.List<ExprNode> crontabAtSchedule,
                       ExprTimePeriod timePeriodExpr,
                       ExprTimePeriod afterTimePeriodExpr,
                       java.lang.Integer afterNumberOfEvents,
                       boolean andAfterTerminate,
                       ExprNode andAfterTerminateExpr,
                       java.util.List<OnTriggerSetAssignment> andAfterTerminateSetExpressions)
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
whenExpressionNode - - for controlling output by a boolean expression
thenExpressions - variable assignments, if null if none
crontabAtSchedule - - crontab parameters
timePeriodExpr - - the time period, or null if none
afterTimePeriodExpr - - after-keyword time period
afterNumberOfEvents - - after-keyword number of events

OutputLimitSpec

public OutputLimitSpec(OutputLimitLimitType displayLimit,
                       OutputLimitRateType rateType)
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 java.lang.Double getRate()
Returns the rate, or null or -1 if a variable is used instead

Returns:
rate if set

getVariableName

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

Returns:
variable name

getWhenExpressionNode

public ExprNode getWhenExpressionNode()
Returns the when-keyword trigger expression, or null if not using when.

Returns:
expression

getCrontabAtSchedule

public java.util.List<ExprNode> getCrontabAtSchedule()
Returns crontab parameters, or null if not using crontab-at output.

Returns:
schedule parameters

setWhenExpressionNode

public void setWhenExpressionNode(ExprNode whenExpressionNode)
Sets a new when-keyword trigger expression.

Parameters:
whenExpressionNode - to set

getThenExpressions

public java.util.List<OnTriggerSetAssignment> getThenExpressions()
Returns a list of variable assignments, or null if none made.

Returns:
variable assignments

getTimePeriodExpr

public ExprTimePeriod getTimePeriodExpr()
Returns time period expression or null if none used.

Returns:
time period

getAfterTimePeriodExpr

public ExprTimePeriod getAfterTimePeriodExpr()
Returns the after-keyword time period.

Returns:
after-keyword time period

getAfterNumberOfEvents

public java.lang.Integer getAfterNumberOfEvents()
Returns the after-keyword number of events.

Returns:
after-keyword number of events

getAndAfterTerminateExpr

public ExprNode getAndAfterTerminateExpr()

setAndAfterTerminateExpr

public void setAndAfterTerminateExpr(ExprNode andAfterTerminateExpr)

isAndAfterTerminate

public boolean isAndAfterTerminate()

getAndAfterTerminateThenExpressions

public java.util.List<OnTriggerSetAssignment> getAndAfterTerminateThenExpressions()

setAndAfterTerminateThenExpressions

public void setAndAfterTerminateThenExpressions(java.util.List<OnTriggerSetAssignment> andAfterTerminateThenExpressions)

setAfterTimePeriodExpr

public void setAfterTimePeriodExpr(ExprTimePeriod afterTimePeriodExpr)

setTimePeriodExpr

public void setTimePeriodExpr(ExprTimePeriod timePeriodExpr)

© 2006-2015 EsperTech Inc.
All rights reserved.
Visit us at espertech.com