Package org.apache.calcite.sql

Enum SqlFunctionCategory

java.lang.Object

java.lang.Enum<SqlFunctionCategory>

org.apache.calcite.sql.SqlFunctionCategory

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SqlFunctionCategory>

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

Enumeration of the categories of SQL-invoked routines.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	SqlFunctionCategory.Property	Property of a SqlFunctionCategory.

Enum Constant Summary

Enum Constants

Enum Constant	Description
MATCH_RECOGNIZE
NUMERIC
STRING
SYSTEM
TIMEDATE
USER_DEFINED_CONSTRUCTOR
USER_DEFINED_FUNCTION
USER_DEFINED_PROCEDURE
USER_DEFINED_SPECIFIC_FUNCTION
USER_DEFINED_TABLE_FUNCTION
USER_DEFINED_TABLE_SPECIFIC_FUNCTION

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.EnumSet<SqlFunctionCategory.Property>	properties

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SqlFunctionCategory(java.lang.String abbrev, java.lang.String description, SqlFunctionCategory.Property... properties)

Method Summary

Modifier and Type	Method	Description
boolean	isFunction()
boolean	isSpecific()
boolean	isTableFunction()
boolean	isUserDefined()
boolean	isUserDefinedNotSpecificFunction()
static SqlFunctionCategory	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static SqlFunctionCategory[]	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

STRING

public static final SqlFunctionCategory STRING

NUMERIC

public static final SqlFunctionCategory NUMERIC

TIMEDATE

public static final SqlFunctionCategory TIMEDATE

SYSTEM

public static final SqlFunctionCategory SYSTEM

USER_DEFINED_FUNCTION

public static final SqlFunctionCategory USER_DEFINED_FUNCTION

USER_DEFINED_PROCEDURE

public static final SqlFunctionCategory USER_DEFINED_PROCEDURE

USER_DEFINED_CONSTRUCTOR

public static final SqlFunctionCategory USER_DEFINED_CONSTRUCTOR

USER_DEFINED_SPECIFIC_FUNCTION

public static final SqlFunctionCategory USER_DEFINED_SPECIFIC_FUNCTION

USER_DEFINED_TABLE_FUNCTION

public static final SqlFunctionCategory USER_DEFINED_TABLE_FUNCTION

USER_DEFINED_TABLE_SPECIFIC_FUNCTION

public static final SqlFunctionCategory USER_DEFINED_TABLE_SPECIFIC_FUNCTION

MATCH_RECOGNIZE

public static final SqlFunctionCategory MATCH_RECOGNIZE

Field Detail

properties

private final java.util.EnumSet<SqlFunctionCategory.Property> properties

Constructor Detail

SqlFunctionCategory

private SqlFunctionCategory(java.lang.String abbrev,
                            java.lang.String description,
                            SqlFunctionCategory.Property... properties)

Method Detail

values

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

Returns:

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

valueOf

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

isUserDefined

public boolean isUserDefined()

isTableFunction

public boolean isTableFunction()

isFunction

public boolean isFunction()

isSpecific

public boolean isSpecific()

isUserDefinedNotSpecificFunction

public boolean isUserDefinedNotSpecificFunction()