ViewEnum (Esper API Documentation)

java.lang.Object
- java.lang.Enum<ViewEnum>
- - com.espertech.esper.view.ViewEnum

All Implemented Interfaces:

Serializable, Comparable<ViewEnum>
```
public enum ViewEnum
extends Enum<ViewEnum>
```
Enum for all build-in views.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CORRELATION` Correlation.
`EXPRESSION_BATCH_WINDOW` Expression batch window.
`EXPRESSION_WINDOW` Expression window.
`EXT_TIMED_BATCH` Externally timed window.
`EXT_TIMED_WINDOW` Externally timed window.
`FIRST_EVENT` First event.
`FIRST_LENGTH_WINDOW` Length first window.
`FIRST_TIME_WINDOW` Time first window.
`GROUP_MERGE` Group-by merge.
`GROUP_PROPERTY` Group-by.
`INTERNAL_INTERSECT` For retain-intersection policy.
`INTERNAL_MATCH_RECOG` Match-recognize.
`INTERNAL_UNION` For retain-union policy.
`KEEPALL_WINDOW` Keep-all data window.
`LAST_EVENT` Last event.
`LENGTH_BATCH` Length batch window.
`LENGTH_WINDOW` Length window.
`NOOP_WINDOW` No-op window.
`PRIOR_EVENT_VIEW` Prior event view.
`RANK_WINDOW` Rank window.
`REGRESSION_LINEST` Linest.
`SIZE` Size view.
`SORT_WINDOW` Sorted window.
`TIME_ACCUM` Time accumulating view.
`TIME_BATCH` Time batch.
`TIME_LENGTH_BATCH` Time length batch.
`TIME_ORDER` Time order event window.
`TIME_WINDOW` Time window.
`TIMETOLIVE` Time order event window.
`UNIQUE_BY_PROPERTY` Unique.
`UNIQUE_FIRST_BY_PROPERTY` Unique.
`UNIVARIATE_STATISTICS` Univariate statistics.
`WEIGHTED_AVERAGE` Weighted avg.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ViewEnum`	`forName(String namespace, String name)` Returns the view enumeration value given the name of the view.
`Class`	`getFactoryClass()` Returns a view's factory class.
`ViewEnum`	`getMergeView()` Returns the enumeration value of the view for merging the data generated by another view.
`String`	`getName()` Returns name of the view that can be used to reference the view in a view expression.
`String`	`getNamespace()` Returns namespace that the object belongs to.
`static ViewEnum`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ViewEnum[]`	`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
  - LENGTH_WINDOW
```
public static final ViewEnum LENGTH_WINDOW
```
    Length window.
  - FIRST_LENGTH_WINDOW
```
public static final ViewEnum FIRST_LENGTH_WINDOW
```
    Length first window.
  - LENGTH_BATCH
```
public static final ViewEnum LENGTH_BATCH
```
    Length batch window.
  - TIME_WINDOW
```
public static final ViewEnum TIME_WINDOW
```
    Time window.
  - FIRST_TIME_WINDOW
```
public static final ViewEnum FIRST_TIME_WINDOW
```
    Time first window.
  - TIME_BATCH
```
public static final ViewEnum TIME_BATCH
```
    Time batch.
  - TIME_LENGTH_BATCH
```
public static final ViewEnum TIME_LENGTH_BATCH
```
    Time length batch.
  - TIME_ACCUM
```
public static final ViewEnum TIME_ACCUM
```
    Time accumulating view.
  - EXT_TIMED_WINDOW
```
public static final ViewEnum EXT_TIMED_WINDOW
```
    Externally timed window.
  - EXT_TIMED_BATCH
```
public static final ViewEnum EXT_TIMED_BATCH
```
    Externally timed window.
  - KEEPALL_WINDOW
```
public static final ViewEnum KEEPALL_WINDOW
```
    Keep-all data window.
  - SIZE
```
public static final ViewEnum SIZE
```
    Size view.
  - LAST_EVENT
```
public static final ViewEnum LAST_EVENT
```
    Last event.
  - FIRST_EVENT
```
public static final ViewEnum FIRST_EVENT
```
    First event.
  - UNIQUE_BY_PROPERTY
```
public static final ViewEnum UNIQUE_BY_PROPERTY
```
    Unique.
  - UNIQUE_FIRST_BY_PROPERTY
```
public static final ViewEnum UNIQUE_FIRST_BY_PROPERTY
```
    Unique.
  - GROUP_MERGE
```
public static final ViewEnum GROUP_MERGE
```
    Group-by merge.
  - GROUP_PROPERTY
```
public static final ViewEnum GROUP_PROPERTY
```
    Group-by.
  - UNIVARIATE_STATISTICS
```
public static final ViewEnum UNIVARIATE_STATISTICS
```
    Univariate statistics.
  - WEIGHTED_AVERAGE
```
public static final ViewEnum WEIGHTED_AVERAGE
```
    Weighted avg.
  - CORRELATION
```
public static final ViewEnum CORRELATION
```
    Correlation.
  - REGRESSION_LINEST
```
public static final ViewEnum REGRESSION_LINEST
```
    Linest.
  - SORT_WINDOW
```
public static final ViewEnum SORT_WINDOW
```
    Sorted window.
  - RANK_WINDOW
```
public static final ViewEnum RANK_WINDOW
```
    Rank window.
  - TIME_ORDER
```
public static final ViewEnum TIME_ORDER
```
    Time order event window.
  - TIMETOLIVE
```
public static final ViewEnum TIMETOLIVE
```
    Time order event window.
  - PRIOR_EVENT_VIEW
```
public static final ViewEnum PRIOR_EVENT_VIEW
```
    Prior event view.
  - INTERNAL_UNION
```
public static final ViewEnum INTERNAL_UNION
```
    For retain-union policy.
  - INTERNAL_INTERSECT
```
public static final ViewEnum INTERNAL_INTERSECT
```
    For retain-intersection policy.
  - INTERNAL_MATCH_RECOG
```
public static final ViewEnum INTERNAL_MATCH_RECOG
```
    Match-recognize.
  - EXPRESSION_WINDOW
```
public static final ViewEnum EXPRESSION_WINDOW
```
    Expression window.
  - EXPRESSION_BATCH_WINDOW
```
public static final ViewEnum EXPRESSION_BATCH_WINDOW
```
    Expression batch window.
  - NOOP_WINDOW
```
public static final ViewEnum NOOP_WINDOW
```
    No-op window.
- Method Detail
  - values
```
public static ViewEnum[] 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 (ViewEnum c : ViewEnum.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ViewEnum valueOf(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getNamespace
```
public String getNamespace()
```
    Returns namespace that the object belongs to.
    
    Returns:
    
    namespace
  - getName
```
public String getName()
```
    Returns name of the view that can be used to reference the view in a view expression.
    
    Returns:
    
    short name of view
  - getMergeView
```
public ViewEnum getMergeView()
```
    Returns the enumeration value of the view for merging the data generated by another view.
    
    Returns:
    
    view enum for the merge view
  - getFactoryClass
```
public Class getFactoryClass()
```
    Returns a view's factory class.
    
    Returns:
    
    class of view factory
  - forName
```
public static ViewEnum forName(String namespace,
                               String name)
```
    Returns the view enumeration value given the name of the view.
    
    Parameters:
    
    namespace - is the namespace name of the view
    
    name - is the short name of the view as used in view expressions
    
    Returns:
    
    view enumeration value, or null if no such view name is among the enumerated values

Enum ViewEnum

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

LENGTH_WINDOW

FIRST_LENGTH_WINDOW

LENGTH_BATCH

TIME_WINDOW

FIRST_TIME_WINDOW

TIME_BATCH

TIME_LENGTH_BATCH

TIME_ACCUM

EXT_TIMED_WINDOW

EXT_TIMED_BATCH

KEEPALL_WINDOW

SIZE

LAST_EVENT

FIRST_EVENT

UNIQUE_BY_PROPERTY

UNIQUE_FIRST_BY_PROPERTY

GROUP_MERGE

GROUP_PROPERTY

UNIVARIATE_STATISTICS

WEIGHTED_AVERAGE

CORRELATION

REGRESSION_LINEST

SORT_WINDOW

RANK_WINDOW

TIME_ORDER

TIMETOLIVE

PRIOR_EVENT_VIEW

INTERNAL_UNION

INTERNAL_INTERSECT

INTERNAL_MATCH_RECOG

EXPRESSION_WINDOW

EXPRESSION_BATCH_WINDOW

NOOP_WINDOW

Method Detail

values

valueOf

getNamespace

getName

getMergeView

getFactoryClass

forName