com.endeca.portal.lql

Enum LQLBuilder.Function

java.lang.Object

java.lang.Enum<LQLBuilder.Function>

com.endeca.portal.lql.LQLBuilder.Function

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<LQLBuilder.Function>

Enclosing class:

LQLBuilder

public static enum LQLBuilder.Function
extends java.lang.Enum<LQLBuilder.Function>

Enum detailing functions usable in the LQL FunctionCallExpression. This is not an exhaustive list of possible functions and should be added to when other functions are needed or discovered.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARB
AVG
CARDINALITY
COALESCE
CONCAT
CORRELATION
COUNT
COUNTDISTINCT
COUNTDISTINCTMEMBERS
EXTRACT
FLOOR
GROUPING
HAS_REFINEMENTS
INTERSECTION
IS_MEMBER_OF
LATITUDE
LOG
LONGITUDE
MAX
MEDIAN
MIN
PERCENTILE
RECORD_IN_FAST_SAMPLE
SET
SET_INTERSECTIONS
SET_UNIONS
STDDEV
SUBSET
SUBSTR
SUM
TO_BOOLEAN
TO_DATETIME
TO_DOUBLE
TO_DURATION
TO_GEOCODE
TO_INTEGER
TO_STRING
TO_TIME
TRUNC
UNION
VARIANCE

Method Summary

Methods

Modifier and Type	Method and Description
static LQLBuilder.Function	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static LQLBuilder.Function[]	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

ARB

public static final LQLBuilder.Function ARB

SET

public static final LQLBuilder.Function SET

AVG

public static final LQLBuilder.Function AVG

COUNTDISTINCT

public static final LQLBuilder.Function COUNTDISTINCT

FLOOR

public static final LQLBuilder.Function FLOOR

MAX

public static final LQLBuilder.Function MAX

MEDIAN

public static final LQLBuilder.Function MEDIAN

MIN

public static final LQLBuilder.Function MIN

STDDEV

public static final LQLBuilder.Function STDDEV

SUM

public static final LQLBuilder.Function SUM

VARIANCE

public static final LQLBuilder.Function VARIANCE

COUNT

public static final LQLBuilder.Function COUNT

TO_BOOLEAN

public static final LQLBuilder.Function TO_BOOLEAN

TO_DATETIME

public static final LQLBuilder.Function TO_DATETIME

TO_DOUBLE

public static final LQLBuilder.Function TO_DOUBLE

TO_DURATION

public static final LQLBuilder.Function TO_DURATION

TO_GEOCODE

public static final LQLBuilder.Function TO_GEOCODE

LATITUDE

public static final LQLBuilder.Function LATITUDE

LONGITUDE

public static final LQLBuilder.Function LONGITUDE

TO_INTEGER

public static final LQLBuilder.Function TO_INTEGER

TO_TIME

public static final LQLBuilder.Function TO_TIME

TO_STRING

public static final LQLBuilder.Function TO_STRING

GROUPING

public static final LQLBuilder.Function GROUPING

EXTRACT

public static final LQLBuilder.Function EXTRACT

CONCAT

public static final LQLBuilder.Function CONCAT

SET_UNIONS

public static final LQLBuilder.Function SET_UNIONS

SET_INTERSECTIONS

public static final LQLBuilder.Function SET_INTERSECTIONS

CARDINALITY

public static final LQLBuilder.Function CARDINALITY

COALESCE

public static final LQLBuilder.Function COALESCE

TRUNC

public static final LQLBuilder.Function TRUNC

PERCENTILE

public static final LQLBuilder.Function PERCENTILE

SUBSTR

public static final LQLBuilder.Function SUBSTR

IS_MEMBER_OF

public static final LQLBuilder.Function IS_MEMBER_OF

INTERSECTION

public static final LQLBuilder.Function INTERSECTION

UNION

public static final LQLBuilder.Function UNION

HAS_REFINEMENTS

public static final LQLBuilder.Function HAS_REFINEMENTS

LOG

public static final LQLBuilder.Function LOG

SUBSET

public static final LQLBuilder.Function SUBSET

CORRELATION

public static final LQLBuilder.Function CORRELATION

RECORD_IN_FAST_SAMPLE

public static final LQLBuilder.Function RECORD_IN_FAST_SAMPLE

COUNTDISTINCTMEMBERS

public static final LQLBuilder.Function COUNTDISTINCTMEMBERS

Method Detail

values

public static LQLBuilder.Function[] 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 (LQLBuilder.Function c : LQLBuilder.Function.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LQLBuilder.Function 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