OnClause.java

/**************************************************************************************
 * Copyright (C) 2008 EsperTech, Inc. All rights reserved.                            *
 * http://esper.codehaus.org                                                          *
 * http://www.espertech.com                                                           *
 * ---------------------------------------------------------------------------------- *
 * The software in this package is published under the terms of the GPL license       *
 * a copy of which has been included with this distribution in the license.txt file.  *
 **************************************************************************************/
package com.espertech.esper.client.soda;

import java.io.Serializable;
import java.io.StringWriter;
import java.util.List;

/**
 * A clause to delete from a named window based on a triggering event arriving and correlated to the named window events to be deleted.
 */
public abstract class OnClause implements Serializable
{
    private static final long serialVersionUID = 0L;

    /**
     * Ctor.
     */
    public OnClause() {
    }

    /**

     * Creates an on-delete clause for deleting from a named window.
     * @param windowName is the named window name
     * @param asName is the as-provided name of the named window
     * @return on-delete clause
     */
    public static OnDeleteClause createOnDelete(String windowName, String asName)
    {
        return OnDeleteClause.create(windowName, asName);
    }

    /**
     * Creates a split-stream clause.
     * @return split-stream on-insert clause
     */
    public static OnInsertSplitStreamClause createOnInsertSplitStream()
    {
        return OnInsertSplitStreamClause.create();
    }

    /**
     * Creates an on-select clause for selecting from a named window.
     * @param windowName is the named window name
     * @param asName is the as-provided name of the named window
     * @return on-select clause
     */
    public static OnSelectClause createOnSelect(String windowName, String asName)
    {
        return OnSelectClause.create(windowName, asName);
    }

    /**
     * Creates an on-update clause for updating a named window.
     * @param windowName is the named window name
     * @param asName is the as-provided name of the named window
     * @param variableName name of variable
     * @param expression expression
     * @return on-update clause
     */
    public static OnUpdateClause createOnUpdate(String windowName, String asName, String variableName, Expression expression)
    {
        return OnUpdateClause.create(windowName, asName).addAssignment(variableName, expression);
    }

    /**
     * Creates an on-set clause for setting variable values.
     * @param variableName is the name of the first variable to set, additional ones can be added to the clause itself
     * @param expression is the assignment expression
     * @return on-set clause
     */
    public static OnSetClause createOnSet(String variableName, Expression expression)
    {
        return OnSetClause.create(variableName, expression);
    }

    
}