net.esper.client
Interface EPAdministrator

All Known Implementing Classes:
EPAdministratorImpl

public interface EPAdministrator

Administrative interface to the event stream processing engine. Includes methods to create patterns and EQL statements.


Method Summary
 EPStatementObjectModel compileEQL(String eqlExpression)
          Compiles a given EQL into an object model representation of the query.
 EPStatement create(EPPreparedStatement prepared)
          Creates and starts a prepared statement.
 EPStatement create(EPPreparedStatement prepared, String statementName)
          Creates and starts a prepared statement.
 EPStatement create(EPStatementObjectModel sodaStatement)
          Creates and starts an EQL statement.
 EPStatement create(EPStatementObjectModel sodaStatement, String statementName)
          Creates and starts an EQL statement.
 EPStatement createEQL(String eqlStatement)
          Creates and starts an EQL statement.
 EPStatement createEQL(String eqlStatement, String statementName)
          Create and starts an EQL statement.
 EPStatement createPattern(String onExpression)
          Create and starts an event pattern statement for the expressing string passed.
 EPStatement createPattern(String onExpression, String statementName)
          Create and starts an event pattern statement for the expressing string passed and assign the name passed.
 void destroyAllStatements()
          Stops and destroys all statements.
 ConfigurationOperations getConfiguration()
          Returns configuration operations for runtime engine configuration.
 EPStatement getStatement(String name)
          Returns the statement by the given statement name.
 String[] getStatementNames()
          Returns the statement names of all started and stopped statements.
 EPPreparedStatement prepareEQL(String eqlExpression)
          Prepares a statement for the given EQL, which can include substitution parameters marked via question mark '?'.
 EPPreparedStatement preparePattern(String patternExpression)
          Prepares a statement for the given pattern, which can include substitution parameters marked via question mark '?'.
 void startAllStatements()
          Starts all statements that are in stopped state.
 void stopAllStatements()
          Stops all statements that are in started state.
 

Method Detail

createPattern

EPStatement createPattern(String onExpression)
                          throws EPException
Create and starts an event pattern statement for the expressing string passed.

The engine assigns a unique name to the statement.

Parameters:
onExpression - must follow the documented syntax for pattern statements
Returns:
EPStatement to poll data from or to add listeners to
Throws:
EPException - when the expression was not valid

createEQL

EPStatement createEQL(String eqlStatement)
                      throws EPException
Creates and starts an EQL statement.

The engine assigns a unique name to the statement. The returned statement is in started state.

Parameters:
eqlStatement - is the query language statement
Returns:
EPStatement to poll data from or to add listeners to
Throws:
EPException - when the expression was not valid

createPattern

EPStatement createPattern(String onExpression,
                          String statementName)
                          throws EPException
Create and starts an event pattern statement for the expressing string passed and assign the name passed.

The statement name is optimally a unique name. If a statement of the same name has already been created, the engine assigns a postfix to create a unique statement name.

Parameters:
onExpression - must follow the documented syntax for pattern statements
statementName - is the name to assign to the statement for use in manageing the statement
Returns:
EPStatement to poll data from or to add listeners to
Throws:
EPException - when the expression was not valid

createEQL

EPStatement createEQL(String eqlStatement,
                      String statementName)
                      throws EPException
Create and starts an EQL statement.

The statement name is optimally a unique name. If a statement of the same name has already been created, the engine assigns a postfix to create a unique statement name.

Parameters:
eqlStatement - is the query language statement
statementName - is the name to assign to the statement for use in manageing the statement
Returns:
EPStatement to poll data from or to add listeners to
Throws:
EPException - when the expression was not valid

create

EPStatement create(EPStatementObjectModel sodaStatement,
                   String statementName)
                   throws EPException
Creates and starts an EQL statement.

The statement name is optimally a unique name. If a statement of the same name has already been created, the engine assigns a postfix to create a unique statement name.

Parameters:
sodaStatement - is the statement object model
statementName - is the name to assign to the statement for use in managing the statement
Returns:
EPStatement to poll data from or to add listeners to
Throws:
EPException - when the expression was not valid

create

EPStatement create(EPStatementObjectModel sodaStatement)
                   throws EPException
Creates and starts an EQL statement.

Parameters:
sodaStatement - is the statement object model
Returns:
EPStatement to poll data from or to add listeners to
Throws:
EPException - when the expression was not valid

compileEQL

EPStatementObjectModel compileEQL(String eqlExpression)
                                  throws EPException
Compiles a given EQL into an object model representation of the query.

Parameters:
eqlExpression - is the statement text to compile
Returns:
object model of statement
Throws:
EPException - indicates compilation errors.

prepareEQL

EPPreparedStatement prepareEQL(String eqlExpression)
                               throws EPException
Prepares a statement for the given EQL, which can include substitution parameters marked via question mark '?'.

Parameters:
eqlExpression - is the statement text to prepare
Returns:
prepared statement
Throws:
EPException - indicates compilation errors.

preparePattern

EPPreparedStatement preparePattern(String patternExpression)
                                   throws EPException
Prepares a statement for the given pattern, which can include substitution parameters marked via question mark '?'.

Parameters:
patternExpression - is the statement text to prepare
Returns:
prepared statement
Throws:
EPException - indicates compilation errors.

create

EPStatement create(EPPreparedStatement prepared,
                   String statementName)
                   throws EPException
Creates and starts a prepared statement.

The statement name is optimally a unique name. If a statement of the same name has already been created, the engine assigns a postfix to create a unique statement name.

Parameters:
prepared - is the prepared statement for which all substitution values have been provided
statementName - is the name to assign to the statement for use in manageing the statement
Returns:
EPStatement to poll data from or to add listeners to
Throws:
EPException - when the prepared statement was not valid

create

EPStatement create(EPPreparedStatement prepared)
                   throws EPException
Creates and starts a prepared statement.

Parameters:
prepared - is the prepared statement for which all substitution values have been provided
Returns:
EPStatement to poll data from or to add listeners to
Throws:
EPException - when the expression was not valid

getStatement

EPStatement getStatement(String name)
Returns the statement by the given statement name. Returns null if a statement of that name has not been created, or if the statement by that name has been destroyed.

Parameters:
name - is the statement name to return the statement for
Returns:
statement for the given name, or null if no such started or stopped statement exists

getStatementNames

String[] getStatementNames()
Returns the statement names of all started and stopped statements.

This excludes the name of destroyed statements.

Returns:
statement names

startAllStatements

void startAllStatements()
                        throws EPException
Starts all statements that are in stopped state. Statements in started state are not affected by this method.

Throws:
EPException - when an error occured starting statements.

stopAllStatements

void stopAllStatements()
                       throws EPException
Stops all statements that are in started state. Statements in stopped state are not affected by this method.

Throws:
EPException - when an error occured stopping statements

destroyAllStatements

void destroyAllStatements()
                          throws EPException
Stops and destroys all statements.

Throws:
EPException - when an error occured stopping or destroying statements

getConfiguration

ConfigurationOperations getConfiguration()
Returns configuration operations for runtime engine configuration.

Returns:
runtime engine configuration operations