com.simba.dsi.ext.aetree
Enum ScalarFunctionID

java.lang.Object
  extended by java.lang.Enum<ScalarFunctionID>
      extended by com.simba.dsi.ext.aetree.ScalarFunctionID
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ScalarFunctionID>

public enum ScalarFunctionID
extends java.lang.Enum<ScalarFunctionID>

An enumeration class that defines all supported scalar functions by SimbaEngine.

See Appendix E: Scalar Functions of ODBC Reference for more details.


Enum Constant Summary
ABS
          ABS(numeric_exp)
ACOS
          ACOS(float_exp)
ASCII
           
ASIN
          ASIN(float_exp)
ATAN
          ATAN(float_exp)
ATAN2
          ATAN2(float_exp1, float_exp2)
CAST
           
CEILING
          CEILING(numeric_exp)
CHAR
           
CONCAT
          CONCAT(string_exp1, string_exp2)
CONVERT
          Explicit Data Type Conversion Function.
COS
          COS(float_exp)
COT
          COT(float_exp)
CURDATE
          CURDATE() (ODBC 1.0)
CURRENT_DATE
          CURRENT_DATE() (ODBC 3.0)
CURRENT_TIME
          CURRENT_TIME() (ODBC 3.0)
CURRENT_TIME1
          CURRENT_TIME() (ODBC 3.0)
CURRENT_TIMESTAMP
          CURRENT_TIMESTAMP() (ODBC 3.0)
CURRENT_TIMESTAMP1
          CURRENT_TIMESTAMP1() (ODBC 3.0)
CURTIME
          CURTIME() (ODBC 1.0)
CUSTOM
          Custom Scalar Function.
DATABASE
          DATEBASE()
DAYNAME
          DAYNAME(date_exp)
DAYOFMONTH
          DAYOFMONTH(date_exp)
DAYOFWEEK
          DAYOFWEEK(date_exp)
DAYOFYEAR
          DAYOFYEAR(date_exp)
DEGREES
          DEGREES(numeric_exp)
EXP
          EXP(float_exp)
EXTRACT
          EXTRACT(date_exp) or EXTRACT(interval) or EXTRACT(timestamp) or EXTRACT(time_exp)
FLOOR
          FLOOR(numeric_exp)
HOUR
          HOUR(time_exp)
IFNULL
          IFNULL(exp, value)
INSERT
          INSERT
INVALID
          Invalid scalar function ID.
LCASE
          LCASE(string_exp)
LEFT
          LEFT(string_exp, count)
LENGTH
          LENGTH(string_exp)
LOCATE2
          LOCATE(string_exp1, string_exp2)
LOCATE3
          LOCATE(string_exp1, string_exp2, start)
LOG
          LOG(float_exp)
LOG10
          LOG10(float_exp)
LOWER
          LOWER(string_exp)
LTRIM
          LTRIM(string_exp)
MINUTE
          MINUTE(time_exp)
MOD
          MOD(integer_exp1, integer_exp2)
MONTH
          MONTH(date_exp)
MONTHNAME
          MONTHNAME(date_exp)
NOW
          NOW()
NULL
          NULL().
PI
          PI()
POWER
          POWER(numeric_exp, integer_exp)
QUARTER
          QUARTER(date_exp)
RADIANS
          RADIANS(numeric_exp)
RAND0
          RAND()
RAND1
          RAND(integer_exp)
REPEAT
           
REPLACE
          REPLACE(string_exp, string_exp, string_exp)
RIGHT
          RIGHT(string_exp, count)
ROUND
          ROUND(numeric_exp, integer_exp)
RTRIM
          RTRIM(string_exp)
SECOND
          SECOND(time_exp)
SIGN
          SIGN(numeric_exp)
SIN
          SIN(float_exp)
SOUNDEX
           
SPACE
          SPACE(count)
SQRT
          SQRT(float_exp)
SUBSTRING2
          SUBSTRING(string_exp, start).
SUBSTRING3
          SUBSTRING(string_exp, start, length)
TAN
          TAN(float_exp)
TIMESTAMPADD
          TIMESTAMPADD(interval, count, timestamp)
TIMESTAMPDIFF
          TIMESTAMPDIFF(interval, timestamp1, timestamp2)
TRUNCATE
          TRUNCATE(numeric_exp, integer_exp)
UCASE
          UCASE(string_exp)
UPPER
          UPPER(string_exp)
USER
          USER()
WEEK
          WEEK(date_exp)
WEEK_ISO
          ISO WEEK(date_exp)
YEAR
          YEAR(date_exp)
 
Method Summary
static ScalarFunctionID getID(int identifier)
          It maps a native aggregate function ID (defined in C++) to an object of this class.
static ScalarFunctionID valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ScalarFunctionID[] 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

ASCII

public static final ScalarFunctionID ASCII

CHAR

public static final ScalarFunctionID CHAR

CONCAT

public static final ScalarFunctionID CONCAT
CONCAT(string_exp1, string_exp2)


INSERT

public static final ScalarFunctionID INSERT
INSERT


LCASE

public static final ScalarFunctionID LCASE
LCASE(string_exp)


LEFT

public static final ScalarFunctionID LEFT
LEFT(string_exp, count)


LENGTH

public static final ScalarFunctionID LENGTH
LENGTH(string_exp)


LOCATE2

public static final ScalarFunctionID LOCATE2
LOCATE(string_exp1, string_exp2)


LOCATE3

public static final ScalarFunctionID LOCATE3
LOCATE(string_exp1, string_exp2, start)


LTRIM

public static final ScalarFunctionID LTRIM
LTRIM(string_exp)


REPEAT

public static final ScalarFunctionID REPEAT

REPLACE

public static final ScalarFunctionID REPLACE
REPLACE(string_exp, string_exp, string_exp)


RIGHT

public static final ScalarFunctionID RIGHT
RIGHT(string_exp, count)


RTRIM

public static final ScalarFunctionID RTRIM
RTRIM(string_exp)


SOUNDEX

public static final ScalarFunctionID SOUNDEX

SPACE

public static final ScalarFunctionID SPACE
SPACE(count)


SUBSTRING3

public static final ScalarFunctionID SUBSTRING3
SUBSTRING(string_exp, start, length)


SUBSTRING2

public static final ScalarFunctionID SUBSTRING2
SUBSTRING(string_exp, start). Sub-string from "start" to the end of the string.


UCASE

public static final ScalarFunctionID UCASE
UCASE(string_exp)


CURDATE

public static final ScalarFunctionID CURDATE
CURDATE() (ODBC 1.0)


CURTIME

public static final ScalarFunctionID CURTIME
CURTIME() (ODBC 1.0)


CURRENT_DATE

public static final ScalarFunctionID CURRENT_DATE
CURRENT_DATE() (ODBC 3.0)


CURRENT_TIME

public static final ScalarFunctionID CURRENT_TIME
CURRENT_TIME() (ODBC 3.0)


CURRENT_TIME1

public static final ScalarFunctionID CURRENT_TIME1
CURRENT_TIME() (ODBC 3.0)


CURRENT_TIMESTAMP

public static final ScalarFunctionID CURRENT_TIMESTAMP
CURRENT_TIMESTAMP() (ODBC 3.0)


CURRENT_TIMESTAMP1

public static final ScalarFunctionID CURRENT_TIMESTAMP1
CURRENT_TIMESTAMP1() (ODBC 3.0)


DAYNAME

public static final ScalarFunctionID DAYNAME
DAYNAME(date_exp)


DAYOFMONTH

public static final ScalarFunctionID DAYOFMONTH
DAYOFMONTH(date_exp)


DAYOFWEEK

public static final ScalarFunctionID DAYOFWEEK
DAYOFWEEK(date_exp)


DAYOFYEAR

public static final ScalarFunctionID DAYOFYEAR
DAYOFYEAR(date_exp)


EXTRACT

public static final ScalarFunctionID EXTRACT
EXTRACT(date_exp) or EXTRACT(interval) or EXTRACT(timestamp) or EXTRACT(time_exp)


HOUR

public static final ScalarFunctionID HOUR
HOUR(time_exp)


MINUTE

public static final ScalarFunctionID MINUTE
MINUTE(time_exp)


MONTH

public static final ScalarFunctionID MONTH
MONTH(date_exp)


MONTHNAME

public static final ScalarFunctionID MONTHNAME
MONTHNAME(date_exp)


NOW

public static final ScalarFunctionID NOW
NOW()


QUARTER

public static final ScalarFunctionID QUARTER
QUARTER(date_exp)


SECOND

public static final ScalarFunctionID SECOND
SECOND(time_exp)


TIMESTAMPADD

public static final ScalarFunctionID TIMESTAMPADD
TIMESTAMPADD(interval, count, timestamp)


TIMESTAMPDIFF

public static final ScalarFunctionID TIMESTAMPDIFF
TIMESTAMPDIFF(interval, timestamp1, timestamp2)


WEEK

public static final ScalarFunctionID WEEK
WEEK(date_exp)


WEEK_ISO

public static final ScalarFunctionID WEEK_ISO
ISO WEEK(date_exp)


YEAR

public static final ScalarFunctionID YEAR
YEAR(date_exp)


ABS

public static final ScalarFunctionID ABS
ABS(numeric_exp)


ACOS

public static final ScalarFunctionID ACOS
ACOS(float_exp)


ASIN

public static final ScalarFunctionID ASIN
ASIN(float_exp)


ATAN

public static final ScalarFunctionID ATAN
ATAN(float_exp)


ATAN2

public static final ScalarFunctionID ATAN2
ATAN2(float_exp1, float_exp2)


CEILING

public static final ScalarFunctionID CEILING
CEILING(numeric_exp)


COS

public static final ScalarFunctionID COS
COS(float_exp)


COT

public static final ScalarFunctionID COT
COT(float_exp)


DEGREES

public static final ScalarFunctionID DEGREES
DEGREES(numeric_exp)


EXP

public static final ScalarFunctionID EXP
EXP(float_exp)


FLOOR

public static final ScalarFunctionID FLOOR
FLOOR(numeric_exp)


LOG

public static final ScalarFunctionID LOG
LOG(float_exp)


LOG10

public static final ScalarFunctionID LOG10
LOG10(float_exp)


MOD

public static final ScalarFunctionID MOD
MOD(integer_exp1, integer_exp2)


PI

public static final ScalarFunctionID PI
PI()


POWER

public static final ScalarFunctionID POWER
POWER(numeric_exp, integer_exp)


RADIANS

public static final ScalarFunctionID RADIANS
RADIANS(numeric_exp)


RAND0

public static final ScalarFunctionID RAND0
RAND()


RAND1

public static final ScalarFunctionID RAND1
RAND(integer_exp)


ROUND

public static final ScalarFunctionID ROUND
ROUND(numeric_exp, integer_exp)


SIGN

public static final ScalarFunctionID SIGN
SIGN(numeric_exp)


SIN

public static final ScalarFunctionID SIN
SIN(float_exp)


SQRT

public static final ScalarFunctionID SQRT
SQRT(float_exp)


TAN

public static final ScalarFunctionID TAN
TAN(float_exp)


TRUNCATE

public static final ScalarFunctionID TRUNCATE
TRUNCATE(numeric_exp, integer_exp)


DATABASE

public static final ScalarFunctionID DATABASE
DATEBASE()


IFNULL

public static final ScalarFunctionID IFNULL
IFNULL(exp, value)


NULL

public static final ScalarFunctionID NULL
NULL(). Not an ODBC defined scalar function. It simply returns "null". For backward compatibility.


USER

public static final ScalarFunctionID USER
USER()


CONVERT

public static final ScalarFunctionID CONVERT
Explicit Data Type Conversion Function.


CAST

public static final ScalarFunctionID CAST

LOWER

public static final ScalarFunctionID LOWER
LOWER(string_exp)


UPPER

public static final ScalarFunctionID UPPER
UPPER(string_exp)


CUSTOM

public static final ScalarFunctionID CUSTOM
Custom Scalar Function. All customer functions bear this ID. Different customer functions are distinguished by their names.


INVALID

public static final ScalarFunctionID INVALID
Invalid scalar function ID. Mainly for initialization purpose.

Method Detail

values

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

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

valueOf

public static ScalarFunctionID 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

getID

public static final ScalarFunctionID getID(int identifier)
It maps a native aggregate function ID (defined in C++) to an object of this class.

Parameters:
identifier - The native scalar function ID defined in the C++ SEScalarFnID enum. The ordinals of the ScalarFunctionID enum in Java are all equal to those in C++.
Returns:
A corresponding object of this class.


Copyright © 2006-2014 Simba Technologies Incorporated. All Rights Reserved.