net.esper.client.soda
Class OutputLimitClause

java.lang.Object
  extended by net.esper.client.soda.OutputLimitClause
All Implemented Interfaces:
Serializable

public class OutputLimitClause
extends Object
implements Serializable

An output limit clause defines how to limit output of statements and consists of a selector specifiying which events to select to output, a frequency and a unit.

See Also:
Serialized Form

Constructor Summary
OutputLimitClause(OutputLimitSelector selector, Double frequency, OutputLimitUnit unit)
          Ctor.
OutputLimitClause(OutputLimitSelector selector, Double frequency, String frequencyVariable, OutputLimitUnit unit)
          Ctor.
OutputLimitClause(OutputLimitSelector selector, String frequencyVariable, OutputLimitUnit unit)
          Ctor.
 
Method Summary
static OutputLimitClause create(double frequency, OutputLimitUnit unit)
          Creates an output limit clause.
static OutputLimitClause create(OutputLimitSelector selector, double frequency, OutputLimitUnit unit)
          Creates an output limit clause.
static OutputLimitClause create(OutputLimitSelector selector, String frequencyVariable, OutputLimitUnit unit)
          Creates an output limit clause.
static OutputLimitClause create(String frequencyVariable, OutputLimitUnit unit)
          Creates an output limit clause.
 Double getFrequency()
          Returns output frequency.
 String getFrequencyVariable()
          Returns the variable name of the variable providing output rate frequency values, or null if the frequency is a fixed value.
 OutputLimitSelector getSelector()
          Returns the selector indicating the events to output.
 OutputLimitUnit getUnit()
          Returns the unit the frequency is in.
 void setFrequency(double frequency)
          Sets output frequency.
 void setFrequencyVariable(String frequencyVariable)
          Sets the variable name of the variable providing output rate frequency values, or null if the frequency is a fixed value.
 void setSelector(OutputLimitSelector selector)
          Sets the selector indicating the events to output.
 void setUnit(OutputLimitUnit unit)
          Sets the unit the frequency is in.
 void toEQL(StringWriter writer)
          Renders the clause in textual representation.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OutputLimitClause

public OutputLimitClause(OutputLimitSelector selector,
                         Double frequency,
                         OutputLimitUnit unit)
Ctor.

Parameters:
selector - is the events to select
frequency - a frequency to output at
unit - the unit for the frequency

OutputLimitClause

public OutputLimitClause(OutputLimitSelector selector,
                         String frequencyVariable,
                         OutputLimitUnit unit)
Ctor.

Parameters:
selector - is the events to select
unit - the unit for the frequency
frequencyVariable - is the variable name providing output rate frequency values

OutputLimitClause

public OutputLimitClause(OutputLimitSelector selector,
                         Double frequency,
                         String frequencyVariable,
                         OutputLimitUnit unit)
Ctor.

Parameters:
selector - is the events to select
frequency - a frequency to output at
unit - the unit for the frequency
frequencyVariable - is the variable name providing output rate frequency values
Method Detail

create

public static OutputLimitClause create(OutputLimitSelector selector,
                                       double frequency,
                                       OutputLimitUnit unit)
Creates an output limit clause.

Parameters:
selector - is the events to select
frequency - a frequency to output at
unit - the unit for the frequency
Returns:
clause

create

public static OutputLimitClause create(OutputLimitSelector selector,
                                       String frequencyVariable,
                                       OutputLimitUnit unit)
Creates an output limit clause.

Parameters:
selector - is the events to select
unit - the unit for the frequency
frequencyVariable - is the variable providing the output limit frequency
Returns:
clause

create

public static OutputLimitClause create(double frequency,
                                       OutputLimitUnit unit)
Creates an output limit clause.

Parameters:
frequency - a frequency to output at
unit - the unit for the frequency
Returns:
clause

create

public static OutputLimitClause create(String frequencyVariable,
                                       OutputLimitUnit unit)
Creates an output limit clause.

Parameters:
frequencyVariable - is the variable name providing output rate frequency values
unit - the unit for the frequency
Returns:
clause

getSelector

public OutputLimitSelector getSelector()
Returns the selector indicating the events to output.

Returns:
selector

setSelector

public void setSelector(OutputLimitSelector selector)
Sets the selector indicating the events to output.

Parameters:
selector - to set

getFrequency

public Double getFrequency()
Returns output frequency.

Returns:
frequency of output

setFrequency

public void setFrequency(double frequency)
Sets output frequency.

Parameters:
frequency - is the frequency of output

getUnit

public OutputLimitUnit getUnit()
Returns the unit the frequency is in.

Returns:
unit for the frequency.

setUnit

public void setUnit(OutputLimitUnit unit)
Sets the unit the frequency is in.

Parameters:
unit - is the unit for the frequency

getFrequencyVariable

public String getFrequencyVariable()
Returns the variable name of the variable providing output rate frequency values, or null if the frequency is a fixed value.

Returns:
variable name or null if no variable is used

setFrequencyVariable

public void setFrequencyVariable(String frequencyVariable)
Sets the variable name of the variable providing output rate frequency values, or null if the frequency is a fixed value.

Parameters:
frequencyVariable - variable name or null if no variable is used

toEQL

public void toEQL(StringWriter writer)
Renders the clause in textual representation.

Parameters:
writer - to output to

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