com.espertech.esper.common.client.soda

Class OnUpdateClause

java.lang.Object

com.espertech.esper.common.client.soda.OnClause

com.espertech.esper.common.client.soda.OnUpdateClause

All Implemented Interfaces:

java.io.Serializable

public class OnUpdateClause
extends OnClause

A clause to update a named window based on a triggering event arriving and correlated to the named window events to be updated.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OnUpdateClause() Ctor.
OnUpdateClause(java.lang.String windowName, java.lang.String optionalAsName) Ctor.

Method Summary

Modifier and Type	Method and Description
OnUpdateClause	addAssignment(Expression expression) Adds a variable to set to the clause.
static OnUpdateClause	create(java.lang.String windowName, java.lang.String optionalAsName) Creates an on-update clause.
java.util.List<Assignment>	getAssignments() Returns the list of variable assignments.
java.lang.String	getOptionalAsName() Returns the as-provided name for the named window.
java.lang.String	getWindowName() Returns the name of the named window to update.
void	setAssignments(java.util.List<Assignment> assignments) Sets a list of variable assignments.
void	setOptionalAsName(java.lang.String optionalAsName) Sets the as-provided for the named window.
void	setWindowName(java.lang.String windowName) Sets the name of the named window.
void	toEPL(java.io.StringWriter writer) Renders the clause in textual representation.

Methods inherited from class com.espertech.esper.common.client.soda.OnClause

createOnDelete, createOnInsertSplitStream, createOnSelect, createOnSet, createOnUpdate

Methods inherited from class java.lang.Object

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

Constructor Detail

OnUpdateClause

public OnUpdateClause()

Ctor.

OnUpdateClause

public OnUpdateClause(java.lang.String windowName,
                      java.lang.String optionalAsName)

Ctor.

Parameters:

windowName - is the named window name

optionalAsName - is the as-provided name of the named window

Method Detail

create

public static OnUpdateClause create(java.lang.String windowName,
                                    java.lang.String optionalAsName)

Creates an on-update clause.

Parameters:

windowName - is the named window name

optionalAsName - is the optional as-provided name

Returns:

on-update clause without assignments

toEPL

public void toEPL(java.io.StringWriter writer)

Renders the clause in textual representation.

Parameters:

writer - to output to

getWindowName

public java.lang.String getWindowName()

Returns the name of the named window to update.

Returns:

named window name

setWindowName

public void setWindowName(java.lang.String windowName)

Sets the name of the named window.

Parameters:

windowName - window name

getOptionalAsName

public java.lang.String getOptionalAsName()

Returns the as-provided name for the named window.

Returns:

name or null

setOptionalAsName

public void setOptionalAsName(java.lang.String optionalAsName)

Sets the as-provided for the named window.

Parameters:

optionalAsName - name to set for window

addAssignment

public OnUpdateClause addAssignment(Expression expression)

Adds a variable to set to the clause.

Parameters:

expression - expression providing the new variable value

Returns:

clause

getAssignments

public java.util.List<Assignment> getAssignments()

Returns the list of variable assignments.

Returns:

pair of variable name and expression

setAssignments

public void setAssignments(java.util.List<Assignment> assignments)

Sets a list of variable assignments.

Parameters:

assignments - list of pairs of variable name and expression