com.espertech.esper.epl.core
Interface StreamTypeService

All Known Implementing Classes:
StreamTypeServiceImpl

public interface StreamTypeService

Service supplying stream number and property type information.


Method Summary
 java.lang.String getEngineURIQualifier()
           
 EventType[] getEventTypes()
          Returns an array of event types for each event stream in the order declared.
 boolean[] getIStreamOnly()
          Returns true for each stream without a data window.
 java.lang.String[] getStreamNames()
          Returns an array of event stream names in the order declared.
 int getStreamNumForStreamName(java.lang.String streamWildcard)
           
 boolean hasPropertyAgnosticType()
           
 boolean hasTableTypes()
           
 boolean isOnDemandStreams()
           
 boolean isStreamZeroUnambigous()
           
 PropertyResolutionDescriptor resolveByPropertyName(java.lang.String propertyName, boolean obtainFragment)
          Returns the offset of the stream and the type of the property for the given property name, by looking through the types offered and matching up.
 PropertyResolutionDescriptor resolveByPropertyNameExplicitProps(java.lang.String propertyName, boolean obtainFragment)
          Returns the offset of the stream and the type of the property for the given property name, by looking through the types offered considering only explicitly listed properties and matching up.
 PropertyResolutionDescriptor resolveByStreamAndPropName(java.lang.String streamAndPropertyName, boolean obtainFragment)
          Returns the offset of the stream and the type of the property for the given property name, by looking through the types offered and matching up.
 PropertyResolutionDescriptor resolveByStreamAndPropName(java.lang.String streamName, java.lang.String propertyName, boolean obtainFragment)
          Returns the offset of the stream and the type of the property for the given property name, by using the specified stream name to resolve the property.
 PropertyResolutionDescriptor resolveByStreamAndPropNameExplicitProps(java.lang.String streamName, java.lang.String propertyName, boolean obtainFragment)
          Returns the offset of the stream and the type of the property for the given property name, by using the specified stream name to resolve the property and considering only explicitly listed properties.
 

Method Detail

resolveByPropertyName

PropertyResolutionDescriptor resolveByPropertyName(java.lang.String propertyName,
                                                   boolean obtainFragment)
                                                   throws DuplicatePropertyException,
                                                          PropertyNotFoundException
Returns the offset of the stream and the type of the property for the given property name, by looking through the types offered and matching up.

This method considers only a property name and looks at all streams to resolve the property name.

Parameters:
propertyName - - property name in event
obtainFragment -
Returns:
descriptor with stream number, property type and property name
Throws:
DuplicatePropertyException - to indicate property was found twice
PropertyNotFoundException - to indicate property could not be resolved

resolveByPropertyNameExplicitProps

PropertyResolutionDescriptor resolveByPropertyNameExplicitProps(java.lang.String propertyName,
                                                                boolean obtainFragment)
                                                                throws PropertyNotFoundException,
                                                                       DuplicatePropertyException
Returns the offset of the stream and the type of the property for the given property name, by looking through the types offered considering only explicitly listed properties and matching up.

This method considers only a property name and looks at all streams to resolve the property name.

Parameters:
propertyName - - property name in event
obtainFragment -
Returns:
descriptor with stream number, property type and property name
Throws:
DuplicatePropertyException - to indicate property was found twice
PropertyNotFoundException - to indicate property could not be resolved

resolveByStreamAndPropName

PropertyResolutionDescriptor resolveByStreamAndPropName(java.lang.String streamName,
                                                        java.lang.String propertyName,
                                                        boolean obtainFragment)
                                                        throws PropertyNotFoundException,
                                                               StreamNotFoundException
Returns the offset of the stream and the type of the property for the given property name, by using the specified stream name to resolve the property.

This method considers and explicit stream name and property name, both parameters are required.

Parameters:
streamName - - name of stream, required
propertyName - - property name in event, , required
obtainFragment -
Returns:
descriptor with stream number, property type and property name
Throws:
PropertyNotFoundException - to indicate property could not be resolved
StreamNotFoundException - to indicate stream name could not be resolved

resolveByStreamAndPropNameExplicitProps

PropertyResolutionDescriptor resolveByStreamAndPropNameExplicitProps(java.lang.String streamName,
                                                                     java.lang.String propertyName,
                                                                     boolean obtainFragment)
                                                                     throws PropertyNotFoundException,
                                                                            StreamNotFoundException
Returns the offset of the stream and the type of the property for the given property name, by using the specified stream name to resolve the property and considering only explicitly listed properties.

This method considers and explicit stream name and property name, both parameters are required.

Parameters:
streamName - - name of stream, required
propertyName - - property name in event, , required
obtainFragment -
Returns:
descriptor with stream number, property type and property name
Throws:
PropertyNotFoundException - to indicate property could not be resolved
StreamNotFoundException - to indicate stream name could not be resolved

resolveByStreamAndPropName

PropertyResolutionDescriptor resolveByStreamAndPropName(java.lang.String streamAndPropertyName,
                                                        boolean obtainFragment)
                                                        throws DuplicatePropertyException,
                                                               PropertyNotFoundException
Returns the offset of the stream and the type of the property for the given property name, by looking through the types offered and matching up.

This method considers a single property name that may or may not be prefixed by a stream name. The resolution first attempts to find the property name itself, then attempts to consider a stream name that may be part of the property name.

Parameters:
streamAndPropertyName - - stream name and property name (e.g. s0.p0) or just a property name (p0)
obtainFragment -
Returns:
descriptor with stream number, property type and property name
Throws:
DuplicatePropertyException - to indicate property was found twice
PropertyNotFoundException - to indicate property could not be resolved

getStreamNames

java.lang.String[] getStreamNames()
Returns an array of event stream names in the order declared.

Returns:
stream names

getEventTypes

EventType[] getEventTypes()
Returns an array of event types for each event stream in the order declared.

Returns:
event types

getIStreamOnly

boolean[] getIStreamOnly()
Returns true for each stream without a data window.

Returns:
true for non-windowed streams.

getStreamNumForStreamName

int getStreamNumForStreamName(java.lang.String streamWildcard)

isOnDemandStreams

boolean isOnDemandStreams()

getEngineURIQualifier

java.lang.String getEngineURIQualifier()

hasPropertyAgnosticType

boolean hasPropertyAgnosticType()

hasTableTypes

boolean hasTableTypes()

isStreamZeroUnambigous

boolean isStreamZeroUnambigous()

© 2006-2014 EsperTech Inc.
All rights reserved.
Visit us at espertech.com