net.esper.view
Enum ViewEnum

java.lang.Object
  extended by java.lang.Enum<ViewEnum>
      extended by net.esper.view.ViewEnum
All Implemented Interfaces:
Serializable, Comparable<ViewEnum>

public enum ViewEnum
extends Enum<ViewEnum>

Enum for all build-in views.


Enum Constant Summary
CORRELATION
          Correlation.
EXT_TIMED_WINDOW
          Externally timed window.
GROUP_MERGE
          Group-by merge.
GROUP_PROPERTY
          Group-by.
LAST_EVENT
          Last event.
LENGTH_BATCH
          Length batch window.
LENGTH_WINDOW
          Length window.
MULTIDIM_VIEW
          Cubes.
PRIOR_EVENT_VIEW
          Prior event view.
REGRESSION_LINEST
          Linest.
SIZE
          Size view.
SORT_WINDOW
          Sorted window.
TIME_BATCH
          Time batch.
TIME_WINDOW
          Time window.
UNIQUE_BY_PROPERTY
          Unique.
UNIVARIATE_STATISTICS
          Univariate statistics.
WEIGHTED_AVERAGE
          Weighted avg.
 
Method Summary
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're declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

LENGTH_WINDOW

public static final ViewEnum LENGTH_WINDOW
Length window.


LENGTH_BATCH

public static final ViewEnum LENGTH_BATCH
Length batch window.


TIME_WINDOW

public static final ViewEnum TIME_WINDOW
Time window.


TIME_BATCH

public static final ViewEnum TIME_BATCH
Time batch.


EXT_TIMED_WINDOW

public static final ViewEnum EXT_TIMED_WINDOW
Externally timed window.


SIZE

public static final ViewEnum SIZE
Size view.


LAST_EVENT

public static final ViewEnum LAST_EVENT
Last event.


UNIQUE_BY_PROPERTY

public static final ViewEnum UNIQUE_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.


MULTIDIM_VIEW

public static final ViewEnum MULTIDIM_VIEW
Cubes.


SORT_WINDOW

public static final ViewEnum SORT_WINDOW
Sorted window.


PRIOR_EVENT_VIEW

public static final ViewEnum PRIOR_EVENT_VIEW
Prior event view.

Method Detail

values

public static final ViewEnum[] values()
Returns an array containing the constants of this enum type, in the order they're 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're 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

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