AppliesTo (Esper API Documentation)

java.lang.Object
- java.lang.Enum<AppliesTo>
- - com.espertech.esper.common.client.annotation.AppliesTo

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AppliesTo>
```
public enum AppliesTo
extends java.lang.Enum<AppliesTo>
```
Annotation to target certain constructs.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AGGREGATION_GROUPBY` Group-by for aggregations
`CONTEXT_CATEGORY` Contexts - Category Context
`CONTEXT_HASH` Contexts - Hash Context
`CONTEXT_INITTERM` Contexts - Non-overlapping and overlapping
`CONTEXT_INITTERM_DISTINCT` Contexts - Distinct for overlapping contexts
`CONTEXT_KEYED` Contexts - Keyed Context
`CONTEXT_KEYED_TERM` Contexts - Keyed Context termination
`CONTEXT_PARTITIONID` Context partition id management
`INDEX_HASH` Index hashed
`INDEX_IN` Index in-set-of-values
`INDEX_OTHER` Index spatial or other
`INDEX_SORTED` Index btree
`INDEX_UNINDEXED` Index unindexed
`PATTERN_AND` Pattern-And node
`PATTERN_EVERY` Pattern-Every node
`PATTERN_EVERYDISTINCT` Pattern every-distinct
`PATTERN_FILTER` Pattern-Filter node
`PATTERN_FOLLOWEDBY` Pattern followed-by
`PATTERN_GUARD` Pattern-Guard node
`PATTERN_MATCHUNTIL` Pattern-Match-Until node
`PATTERN_NOT` Pattern-Not node
`PATTERN_OBSERVER` Pattern-Observer node
`PATTERN_OR` Pattern-Or node
`PATTERN_ROOT` Pattern-Root node (internal use only)
`RESULTSET_AGGREGATEGROUPED_OUTPUTALL` Result Set Aggregate-Grouped Output All
`RESULTSET_AGGREGATEGROUPED_OUTPUTALL_OPT` Result Set Aggregate-Grouped Output All with Options
`RESULTSET_AGGREGATEGROUPED_OUTPUTFIRST` Result Set Aggregate-Grouped Output Limit Helper
`RESULTSET_AGGREGATEGROUPED_OUTPUTLAST_OPT` Result Set Aggregate-Grouped Output Last with Options
`RESULTSET_FULLYAGGREGATED_OUTPUTALL` Result Set Fully-Aggregated Output All
`RESULTSET_OUTPUTLIMIT` Output rate limiting
`RESULTSET_ROLLUP_OUTPUTALL` Result Set Rollup Output Limit Helper
`RESULTSET_ROLLUP_OUTPUTFIRST` Result Set Rollup Output Limit Helper
`RESULTSET_ROLLUP_OUTPUTLAST` Result Set Rollup Output Limit Helper
`RESULTSET_ROLLUP_OUTPUTSNAPSHOT` Result Set Rollup Output Limit Helper
`RESULTSET_ROWPEREVENT_OUTPUTALL` Result Set Simple Row-Per-Event Output All
`RESULTSET_ROWPERGROUP_OUTPUTALL` Result Set Row-Per-Group Output All
`RESULTSET_ROWPERGROUP_OUTPUTALL_OPT` Result Set Row-Per-Group Output All with Option
`RESULTSET_ROWPERGROUP_OUTPUTFIRST` Result Set Row-Per-Group Output Limit Helper
`RESULTSET_ROWPERGROUP_OUTPUTLAST_OPT` Result Set Row-Per-Group Output All with Option
`RESULTSET_ROWPERGROUP_UNBOUND` Result Set Row-Per-Group Unbound Helper
`RESULTSET_SIMPLE_OUTPUTALL` Result Set Simple Output All
`ROWRECOG_PARTITIONED` Match-recognize partitioned state
`ROWRECOG_SCHEDULE` Match-recognize schedule state
`ROWRECOG_UNPARTITIONED` Match-recognize unpartitioned state
`UNDEFINED` For use with annotations as a default value, not used otherwise (internal use only)
`WINDOW_CORRELATION` Correlation stat view
`WINDOW_EXPRESSION` Expression window
`WINDOW_EXPRESSIONBATCH` Expression batch window
`WINDOW_EXTTIMED` Externally-timed window
`WINDOW_EXTTIMEDBATCH` Externally-timed batch window
`WINDOW_FIRSTEVENT` First-event window
`WINDOW_FIRSTLENGTH` First-length window
`WINDOW_FIRSTTIME` First-time window
`WINDOW_FIRSTUNIQUE` First-unique window
`WINDOW_GROUP` Grouped window
`WINDOW_INTERSECT` Intersect view
`WINDOW_KEEPALL` Keep-all window
`WINDOW_LASTEVENT` Last-event window
`WINDOW_LENGTH` Length window
`WINDOW_LENGTHBATCH` Length-batch window
`WINDOW_PRIOR` Prior
`WINDOW_RANK` Rank window
`WINDOW_REGRESSIONLINEST` Regression lineest stat view
`WINDOW_ROWRECOG` Match-recognize view (internal use only)
`WINDOW_SIZE` Size stat view
`WINDOW_SORTED` Sorted window
`WINDOW_TIME` Time window
`WINDOW_TIMEACCUM` Time-accumulative window
`WINDOW_TIMEBATCH` Time-batch window
`WINDOW_TIMELENGTHBATCH` Length-batch window
`WINDOW_TIMEORDER` Time order window
`WINDOW_TIMETOLIVE` Time-to-live window
`WINDOW_UNION` Union view
`WINDOW_UNIQUE` Unique-window
`WINDOW_UNIVARIATESTAT` Univariate stat view
`WINDOW_WEIGHTEDAVG` Weighted average stat view

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static AppliesTo`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static AppliesTo[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - UNDEFINED
```
public static final AppliesTo UNDEFINED
```
    For use with annotations as a default value, not used otherwise (internal use only)
  - AGGREGATION_GROUPBY
```
public static final AppliesTo AGGREGATION_GROUPBY
```
    Group-by for aggregations
  - CONTEXT_PARTITIONID
```
public static final AppliesTo CONTEXT_PARTITIONID
```
    Context partition id management
  - CONTEXT_CATEGORY
```
public static final AppliesTo CONTEXT_CATEGORY
```
    Contexts - Category Context
  - CONTEXT_HASH
```
public static final AppliesTo CONTEXT_HASH
```
    Contexts - Hash Context
  - CONTEXT_INITTERM
```
public static final AppliesTo CONTEXT_INITTERM
```
    Contexts - Non-overlapping and overlapping
  - CONTEXT_INITTERM_DISTINCT
```
public static final AppliesTo CONTEXT_INITTERM_DISTINCT
```
    Contexts - Distinct for overlapping contexts
  - CONTEXT_KEYED
```
public static final AppliesTo CONTEXT_KEYED
```
    Contexts - Keyed Context
  - CONTEXT_KEYED_TERM
```
public static final AppliesTo CONTEXT_KEYED_TERM
```
    Contexts - Keyed Context termination
  - INDEX_HASH
```
public static final AppliesTo INDEX_HASH
```
    Index hashed
  - INDEX_IN
```
public static final AppliesTo INDEX_IN
```
    Index in-set-of-values
  - INDEX_SORTED
```
public static final AppliesTo INDEX_SORTED
```
    Index btree
  - INDEX_UNINDEXED
```
public static final AppliesTo INDEX_UNINDEXED
```
    Index unindexed
  - INDEX_OTHER
```
public static final AppliesTo INDEX_OTHER
```
    Index spatial or other
  - WINDOW_PRIOR
```
public static final AppliesTo WINDOW_PRIOR
```
    Prior
  - WINDOW_RANK
```
public static final AppliesTo WINDOW_RANK
```
    Rank window
  - PATTERN_EVERYDISTINCT
```
public static final AppliesTo PATTERN_EVERYDISTINCT
```
    Pattern every-distinct
  - PATTERN_FOLLOWEDBY
```
public static final AppliesTo PATTERN_FOLLOWEDBY
```
    Pattern followed-by
  - ROWRECOG_PARTITIONED
```
public static final AppliesTo ROWRECOG_PARTITIONED
```
    Match-recognize partitioned state
  - ROWRECOG_UNPARTITIONED
```
public static final AppliesTo ROWRECOG_UNPARTITIONED
```
    Match-recognize unpartitioned state
  - ROWRECOG_SCHEDULE
```
public static final AppliesTo ROWRECOG_SCHEDULE
```
    Match-recognize schedule state
  - PATTERN_ROOT
```
public static final AppliesTo PATTERN_ROOT
```
    Pattern-Root node (internal use only)
  - PATTERN_AND
```
public static final AppliesTo PATTERN_AND
```
    Pattern-And node
  - PATTERN_OR
```
public static final AppliesTo PATTERN_OR
```
    Pattern-Or node
  - PATTERN_GUARD
```
public static final AppliesTo PATTERN_GUARD
```
    Pattern-Guard node
  - PATTERN_MATCHUNTIL
```
public static final AppliesTo PATTERN_MATCHUNTIL
```
    Pattern-Match-Until node
  - PATTERN_FILTER
```
public static final AppliesTo PATTERN_FILTER
```
    Pattern-Filter node
  - PATTERN_OBSERVER
```
public static final AppliesTo PATTERN_OBSERVER
```
    Pattern-Observer node
  - PATTERN_NOT
```
public static final AppliesTo PATTERN_NOT
```
    Pattern-Not node
  - PATTERN_EVERY
```
public static final AppliesTo PATTERN_EVERY
```
    Pattern-Every node
  - RESULTSET_AGGREGATEGROUPED_OUTPUTFIRST
```
public static final AppliesTo RESULTSET_AGGREGATEGROUPED_OUTPUTFIRST
```
    Result Set Aggregate-Grouped Output Limit Helper
  - RESULTSET_ROWPERGROUP_OUTPUTFIRST
```
public static final AppliesTo RESULTSET_ROWPERGROUP_OUTPUTFIRST
```
    Result Set Row-Per-Group Output Limit Helper
  - RESULTSET_OUTPUTLIMIT
```
public static final AppliesTo RESULTSET_OUTPUTLIMIT
```
    Output rate limiting
  - RESULTSET_ROLLUP_OUTPUTSNAPSHOT
```
public static final AppliesTo RESULTSET_ROLLUP_OUTPUTSNAPSHOT
```
    Result Set Rollup Output Limit Helper
  - RESULTSET_ROLLUP_OUTPUTALL
```
public static final AppliesTo RESULTSET_ROLLUP_OUTPUTALL
```
    Result Set Rollup Output Limit Helper
  - RESULTSET_ROLLUP_OUTPUTFIRST
```
public static final AppliesTo RESULTSET_ROLLUP_OUTPUTFIRST
```
    Result Set Rollup Output Limit Helper
  - RESULTSET_ROLLUP_OUTPUTLAST
```
public static final AppliesTo RESULTSET_ROLLUP_OUTPUTLAST
```
    Result Set Rollup Output Limit Helper
  - RESULTSET_FULLYAGGREGATED_OUTPUTALL
```
public static final AppliesTo RESULTSET_FULLYAGGREGATED_OUTPUTALL
```
    Result Set Fully-Aggregated Output All
  - RESULTSET_SIMPLE_OUTPUTALL
```
public static final AppliesTo RESULTSET_SIMPLE_OUTPUTALL
```
    Result Set Simple Output All
  - RESULTSET_ROWPEREVENT_OUTPUTALL
```
public static final AppliesTo RESULTSET_ROWPEREVENT_OUTPUTALL
```
    Result Set Simple Row-Per-Event Output All
  - RESULTSET_ROWPERGROUP_OUTPUTALL
```
public static final AppliesTo RESULTSET_ROWPERGROUP_OUTPUTALL
```
    Result Set Row-Per-Group Output All
  - RESULTSET_ROWPERGROUP_OUTPUTALL_OPT
```
public static final AppliesTo RESULTSET_ROWPERGROUP_OUTPUTALL_OPT
```
    Result Set Row-Per-Group Output All with Option
  - RESULTSET_ROWPERGROUP_OUTPUTLAST_OPT
```
public static final AppliesTo RESULTSET_ROWPERGROUP_OUTPUTLAST_OPT
```
    Result Set Row-Per-Group Output All with Option
  - RESULTSET_ROWPERGROUP_UNBOUND
```
public static final AppliesTo RESULTSET_ROWPERGROUP_UNBOUND
```
    Result Set Row-Per-Group Unbound Helper
  - RESULTSET_AGGREGATEGROUPED_OUTPUTALL
```
public static final AppliesTo RESULTSET_AGGREGATEGROUPED_OUTPUTALL
```
    Result Set Aggregate-Grouped Output All
  - RESULTSET_AGGREGATEGROUPED_OUTPUTALL_OPT
```
public static final AppliesTo RESULTSET_AGGREGATEGROUPED_OUTPUTALL_OPT
```
    Result Set Aggregate-Grouped Output All with Options
  - RESULTSET_AGGREGATEGROUPED_OUTPUTLAST_OPT
```
public static final AppliesTo RESULTSET_AGGREGATEGROUPED_OUTPUTLAST_OPT
```
    Result Set Aggregate-Grouped Output Last with Options
  - WINDOW_UNIQUE
```
public static final AppliesTo WINDOW_UNIQUE
```
    Unique-window
  - WINDOW_TIMEACCUM
```
public static final AppliesTo WINDOW_TIMEACCUM
```
    Time-accumulative window
  - WINDOW_TIMEBATCH
```
public static final AppliesTo WINDOW_TIMEBATCH
```
    Time-batch window
  - WINDOW_TIMELENGTHBATCH
```
public static final AppliesTo WINDOW_TIMELENGTHBATCH
```
    Length-batch window
  - WINDOW_GROUP
```
public static final AppliesTo WINDOW_GROUP
```
    Grouped window
  - WINDOW_LENGTH
```
public static final AppliesTo WINDOW_LENGTH
```
    Length window
  - WINDOW_TIME
```
public static final AppliesTo WINDOW_TIME
```
    Time window
  - WINDOW_LENGTHBATCH
```
public static final AppliesTo WINDOW_LENGTHBATCH
```
    Length-batch window
  - WINDOW_EXPRESSION
```
public static final AppliesTo WINDOW_EXPRESSION
```
    Expression window
  - WINDOW_EXPRESSIONBATCH
```
public static final AppliesTo WINDOW_EXPRESSIONBATCH
```
    Expression batch window
  - WINDOW_FIRSTLENGTH
```
public static final AppliesTo WINDOW_FIRSTLENGTH
```
    First-length window
  - WINDOW_FIRSTTIME
```
public static final AppliesTo WINDOW_FIRSTTIME
```
    First-time window
  - WINDOW_FIRSTUNIQUE
```
public static final AppliesTo WINDOW_FIRSTUNIQUE
```
    First-unique window
  - WINDOW_FIRSTEVENT
```
public static final AppliesTo WINDOW_FIRSTEVENT
```
    First-event window
  - WINDOW_EXTTIMED
```
public static final AppliesTo WINDOW_EXTTIMED
```
    Externally-timed window
  - WINDOW_EXTTIMEDBATCH
```
public static final AppliesTo WINDOW_EXTTIMEDBATCH
```
    Externally-timed batch window
  - WINDOW_UNIVARIATESTAT
```
public static final AppliesTo WINDOW_UNIVARIATESTAT
```
    Univariate stat view
  - WINDOW_CORRELATION
```
public static final AppliesTo WINDOW_CORRELATION
```
    Correlation stat view
  - WINDOW_SIZE
```
public static final AppliesTo WINDOW_SIZE
```
    Size stat view
  - WINDOW_WEIGHTEDAVG
```
public static final AppliesTo WINDOW_WEIGHTEDAVG
```
    Weighted average stat view
  - WINDOW_REGRESSIONLINEST
```
public static final AppliesTo WINDOW_REGRESSIONLINEST
```
    Regression lineest stat view
  - WINDOW_UNION
```
public static final AppliesTo WINDOW_UNION
```
    Union view
  - WINDOW_INTERSECT
```
public static final AppliesTo WINDOW_INTERSECT
```
    Intersect view
  - WINDOW_LASTEVENT
```
public static final AppliesTo WINDOW_LASTEVENT
```
    Last-event window
  - WINDOW_SORTED
```
public static final AppliesTo WINDOW_SORTED
```
    Sorted window
  - WINDOW_TIMEORDER
```
public static final AppliesTo WINDOW_TIMEORDER
```
    Time order window
  - WINDOW_TIMETOLIVE
```
public static final AppliesTo WINDOW_TIMETOLIVE
```
    Time-to-live window
  - WINDOW_KEEPALL
```
public static final AppliesTo WINDOW_KEEPALL
```
    Keep-all window
  - WINDOW_ROWRECOG
```
public static final AppliesTo WINDOW_ROWRECOG
```
    Match-recognize view (internal use only)
- Method Detail
  - values
```
public static AppliesTo[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (AppliesTo c : AppliesTo.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static AppliesTo valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null

Enum AppliesTo

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

UNDEFINED

AGGREGATION_GROUPBY

CONTEXT_PARTITIONID

CONTEXT_CATEGORY

CONTEXT_HASH

CONTEXT_INITTERM

CONTEXT_INITTERM_DISTINCT

CONTEXT_KEYED

CONTEXT_KEYED_TERM

INDEX_HASH

INDEX_IN

INDEX_SORTED

INDEX_UNINDEXED

INDEX_OTHER

WINDOW_PRIOR

WINDOW_RANK

PATTERN_EVERYDISTINCT

PATTERN_FOLLOWEDBY

ROWRECOG_PARTITIONED

ROWRECOG_UNPARTITIONED

ROWRECOG_SCHEDULE

PATTERN_ROOT

PATTERN_AND

PATTERN_OR

PATTERN_GUARD

PATTERN_MATCHUNTIL

PATTERN_FILTER

PATTERN_OBSERVER

PATTERN_NOT

PATTERN_EVERY

RESULTSET_AGGREGATEGROUPED_OUTPUTFIRST

RESULTSET_ROWPERGROUP_OUTPUTFIRST

RESULTSET_OUTPUTLIMIT

RESULTSET_ROLLUP_OUTPUTSNAPSHOT

RESULTSET_ROLLUP_OUTPUTALL

RESULTSET_ROLLUP_OUTPUTFIRST

RESULTSET_ROLLUP_OUTPUTLAST

RESULTSET_FULLYAGGREGATED_OUTPUTALL

RESULTSET_SIMPLE_OUTPUTALL

RESULTSET_ROWPEREVENT_OUTPUTALL

RESULTSET_ROWPERGROUP_OUTPUTALL

RESULTSET_ROWPERGROUP_OUTPUTALL_OPT

RESULTSET_ROWPERGROUP_OUTPUTLAST_OPT

RESULTSET_ROWPERGROUP_UNBOUND

RESULTSET_AGGREGATEGROUPED_OUTPUTALL

RESULTSET_AGGREGATEGROUPED_OUTPUTALL_OPT

RESULTSET_AGGREGATEGROUPED_OUTPUTLAST_OPT

WINDOW_UNIQUE

WINDOW_TIMEACCUM

WINDOW_TIMEBATCH

WINDOW_TIMELENGTHBATCH

WINDOW_GROUP

WINDOW_LENGTH

WINDOW_TIME

WINDOW_LENGTHBATCH

WINDOW_EXPRESSION

WINDOW_EXPRESSIONBATCH

WINDOW_FIRSTLENGTH

WINDOW_FIRSTTIME

WINDOW_FIRSTUNIQUE

WINDOW_FIRSTEVENT

WINDOW_EXTTIMED

WINDOW_EXTTIMEDBATCH

WINDOW_UNIVARIATESTAT

WINDOW_CORRELATION

WINDOW_SIZE

WINDOW_WEIGHTEDAVG

WINDOW_REGRESSIONLINEST

WINDOW_UNION

WINDOW_INTERSECT

WINDOW_LASTEVENT

WINDOW_SORTED

WINDOW_TIMEORDER

WINDOW_TIMETOLIVE