com.espertech.esper.epl.spec

Class DBStatementStreamSpec

java.lang.Object

com.espertech.esper.epl.spec.StreamSpecBase

com.espertech.esper.epl.spec.DBStatementStreamSpec

All Implemented Interfaces:

StreamSpec, StreamSpecCompiled, StreamSpecRaw, java.io.Serializable

public class DBStatementStreamSpec
extends StreamSpecBase
implements StreamSpecRaw, StreamSpecCompiled, java.io.Serializable

Specification object for historical data poll via database SQL statement.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.espertech.esper.epl.spec.StreamSpecCompiled

EMPTY_STREAM_ARRAY

Constructor Summary

Constructors

Constructor and Description
DBStatementStreamSpec(java.lang.String optionalStreamName, ViewSpec[] viewSpecs, java.lang.String databaseName, java.lang.String sqlWithSubsParams, java.lang.String metadataSQL) Ctor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDatabaseName() Returns the database name.
java.lang.String	getMetadataSQL() Returns the optional sample metadata SQL
java.lang.String	getSqlWithSubsParams() Returns the SQL with substitution parameters.

Methods inherited from class com.espertech.esper.epl.spec.StreamSpecBase

getOptionalStreamName, getOptions, getViewSpecs

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.espertech.esper.epl.spec.StreamSpec

getOptionalStreamName, getOptions, getViewSpecs

Constructor Detail

DBStatementStreamSpec

public DBStatementStreamSpec(java.lang.String optionalStreamName,
                             ViewSpec[] viewSpecs,
                             java.lang.String databaseName,
                             java.lang.String sqlWithSubsParams,
                             java.lang.String metadataSQL)

Ctor.

Parameters:

optionalStreamName - is a stream name optionally given to stream

viewSpecs - is a list of views onto the stream

databaseName - is the database name to poll

sqlWithSubsParams - is the SQL with placeholder parameters

metadataSQL - is the sample SQL to retrieve statement metadata, if any was supplied

Method Detail

getDatabaseName

public java.lang.String getDatabaseName()

Returns the database name.

Returns:

name of database.

getSqlWithSubsParams

public java.lang.String getSqlWithSubsParams()

Returns the SQL with substitution parameters.

Returns:

SQL with parameters embedded as ${stream.param}

getMetadataSQL

public java.lang.String getMetadataSQL()

Returns the optional sample metadata SQL

Returns:

null if not supplied, or SQL to fire to retrieve metadata