Package com.espertech.esper.common.client.annotation

Enum Class HintEnum

java.lang.Object
java.lang.Enum<HintEnum>
com.espertech.esper.common.client.annotation.HintEnum
All Implemented Interfaces:
Serializable, Comparable<HintEnum>, Constable
public enum HintEnum extends Enum<HintEnum>
Enumeration of hint values. Since hints may be a comma-separate list in a single @Hint annotation they are listed as enumeration values here.

  • Enum Constant Details

    • ITERATE_ONLY

      public static final HintEnum ITERATE_ONLY
      For use with match_recognize, iterate-only matching.

    • DISABLE_RECLAIM_GROUP

      public static final HintEnum DISABLE_RECLAIM_GROUP
      For use with group-by, disabled reclaim groups.

    • RECLAIM_GROUP_AGED

      public static final HintEnum RECLAIM_GROUP_AGED
      For use with group-by and std:groupwin, reclaim groups for unbound streams based on time. The number of seconds after which a groups is reclaimed if inactive.

    • RECLAIM_GROUP_FREQ

      public static final HintEnum RECLAIM_GROUP_FREQ
      For use with group-by and std:groupwin, reclaim groups for unbound streams based on time, this number is the frequency in seconds at which a sweep occurs for aged groups, if not provided then the sweep frequency is the same number as the age.

    • ENABLE_WINDOW_SUBQUERY_INDEXSHARE

      public static final HintEnum ENABLE_WINDOW_SUBQUERY_INDEXSHARE
      For use with create-named-window statements only, to indicate that statements that subquery the named window use named window data structures (unless the subquery statement specifies below DISBABLE hint and as listed below).

      By default and if this hint is not specified or subqueries specify a stream filter on a named window, subqueries use statement-local data structures representing named window contents (table, index). Such data structure is maintained by consuming the named window insert and remove stream.

    • DISABLE_WINDOW_SUBQUERY_INDEXSHARE

      public static final HintEnum DISABLE_WINDOW_SUBQUERY_INDEXSHARE
      If ENABLE_WINDOW_SUBQUERY_INDEXSHARE is not specified for a named window (the default) then this instruction is ignored.

      For use with statements that subquery a named window and that benefit from a statement-local data structure representing named window contents (table, index), maintained through consuming the named window insert and remove stream.

    • SET_NOINDEX

      public static final HintEnum SET_NOINDEX
      For use with subqueries and on-select, on-merge, on-update and on-delete to specify the query neither build an implicit index nor use an existing index, always performing a full table scan.

    • FORCE_NESTED_ITER

      public static final HintEnum FORCE_NESTED_ITER
      For use with join query plans to force a nested iteration plan.

    • PREFER_MERGE_JOIN

      public static final HintEnum PREFER_MERGE_JOIN
      For use with join query plans to indicate preferance of the merge-join query plan.

    • INDEX

      public static final HintEnum INDEX
      For use everywhere where indexes are used (subquery, joins, fire-and-forget, onl-select etc.), index hint.

    • EXCLUDE_PLAN

      public static final HintEnum EXCLUDE_PLAN
      For use where query planning applies.

    • DISABLE_UNIQUE_IMPLICIT_IDX

      public static final HintEnum DISABLE_UNIQUE_IMPLICIT_IDX
      For use everywhere where unique data window are used

    • MAX_FILTER_WIDTH

      public static final HintEnum MAX_FILTER_WIDTH
      For use when filter expression optimization may widen the filter expression.

    • FILTERINDEX

      public static final HintEnum FILTERINDEX
      For use when filter expression optimization may filter index composite lookupable expressions (typically LHS, i.e. left hand side). Such as "select * from MyEvent(a+b=0)" wherein "a+b" is a composite lookupable expression, i.e. provides lookup values for filter index lookup.

    • DISABLE_WHEREEXPR_MOVETO_FILTER

      public static final HintEnum DISABLE_WHEREEXPR_MOVETO_FILTER
      For use everywhere where unique data window are used

    • ENABLE_OUTPUTLIMIT_OPT

      public static final HintEnum ENABLE_OUTPUTLIMIT_OPT
      For use with output rate limiting.

    • DISABLE_OUTPUTLIMIT_OPT

      public static final HintEnum DISABLE_OUTPUTLIMIT_OPT
      For use with output rate limiting.

    • SILENT_DELETE

      public static final HintEnum SILENT_DELETE
      For use with named window to silent-delete.

  • Method Details

    • values

      public static HintEnum[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static HintEnum valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • getValue

      public String getValue()
      Returns the constant.
      Returns:
      constant

    • isAcceptsParameters

      public boolean isAcceptsParameters()
      True if the hint accepts params.
      Returns:
      indicator

    • isRequiresParameters

      public boolean isRequiresParameters()
      True if the hint requires params.
      Returns:
      indicator

    • getHint

      public Hint getHint(Annotation[] annotations)
      Check if the hint is present in the annotations provided.
      Parameters:
      annotations - the annotations to inspect
      Returns:
      indicator

    • validateGetListed

      public static Map<HintEnum,List<String>> validateGetListed(Annotation annotation) throws com.espertech.esper.common.internal.epl.annotation.AnnotationException
      Validate a hint annotation ensuring it contains only recognized hints.
      Parameters:
      annotation - to validate
      Returns:
      validated hint enums and their parameter list
      Throws:
      com.espertech.esper.common.internal.epl.annotation.AnnotationException - if an invalid text was found

    • getHintAssignedValue

      public String getHintAssignedValue(Hint annotation)
      Returns hint value.
      Parameters:
      annotation - to look for
      Returns:
      hint assigned first value provided

    • getHintAssignedValues

      public List<String> getHintAssignedValues(Annotation[] annotations)
      Returns all values assigned for a given hint, if any
      Parameters:
      annotations - to be interogated
      Returns:
      hint assigned values or null if none found

    • splitCommaUnlessInParen

      public static String[] splitCommaUnlessInParen(String line)
      Split a line of comma-separated values allowing parenthesis.
      Parameters:
      line - to split
      Returns:
      parameters