FunctionName (Plasma Core 2.1.5 API)

java.lang.Object
- java.lang.Enum<FunctionName>
- - org.plasma.query.model.FunctionName

All Implemented Interfaces:: Serializable, Comparable<FunctionName>

public enum FunctionName
extends Enum<FunctionName>

Java class for FunctionName.

The following schema fragment specifies the expected content contained within this class.

 <simpleType name="FunctionName">
   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
     <enumeration value="avg"/>
     <enumeration value="count"/>
     <enumeration value="max"/>
     <enumeration value="min"/>
     <enumeration value="sdtdev"/>
     <enumeration value="sum"/>
     <enumeration value="var"/>
     <enumeration value="cast"/>
     <enumeration value="convert"/>
     <enumeration value="abs"/>
     <enumeration value="acos"/>
     <enumeration value="asin"/>
     <enumeration value="atan"/>
     <enumeration value="ceiling"/>
     <enumeration value="cos"/>
     <enumeration value="cot"/>
     <enumeration value="exp"/>
     <enumeration value="floor"/>
     <enumeration value="log"/>
     <enumeration value="log10"/>
     <enumeration value="pi"/>
     <enumeration value="pow"/>
     <enumeration value="round"/>
     <enumeration value="sin"/>
     <enumeration value="sqrt"/>
     <enumeration value="square"/>
     <enumeration value="tan"/>
     <enumeration value="meta_col_precision"/>
     <enumeration value="meta_col_scale"/>
     <enumeration value="meta_name"/>
     <enumeration value="meta_physical_name"/>
     <enumeration value="meta_business_name"/>
     <enumeration value="meta_local_name"/>
     <enumeration value="rank"/>
     <enumeration value="row_number"/>
     <enumeration value="user"/>
     <enumeration value="substringBefore"/>
     <enumeration value="substringAfter"/>
     <enumeration value="normalizeSpace"/>
     <enumeration value="upperCase"/>
     <enumeration value="lowerCase"/>
     <enumeration value="yearFromDate"/>
     <enumeration value="monthFromDate"/>
     <enumeration value="dayFromDate"/>
     <enumeration value="timezoneFromDate"/>
     <enumeration value="offsets"/>
     <enumeration value="relevance"/>
     <enumeration value="score"/>
     <enumeration value="terms"/>
     <enumeration value="ngrams"/>
     <enumeration value="app_function"/>
   </restriction>
 </simpleType>

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ABS` returns mathematical function that returns the absolute (positive) value of the specified numeric expression
`ACOS` returns mathematical function that returns the angle, in radians, whose cosine is the specified float expression
`APP_FUNCTION`
`ASIN` returns the angle, in radians, whose sine is the specified float expression.
`ATAN` returns the angle in radians whose tangent is a specified float expression.
`AVG` returns the average of the values in a group.
`CAST` returns an expression of one data type to another
`CEILING` returns the smallest integer greater than, or equal to, the specified numeric expression
`CONVERT` returns an expression of one data type to another
`COS` returns a mathematical function that returns the trigonometric cosine of the specified angle, in radians, in the specified expression
`COT` returns mathematical function that returns the trigonometric cotangent of the specified angle, in radians, in the specified float expression
`COUNT` returns the number of items in a group
`DAY`
`DAY_FROM_DATE`
`DAYOFMONTH`
`DAYOFWEEK`
`DAYOFYEAR`
`EXP` returns the exponential value of the specified float expression
`FLOOR` returns the largest integer less than or equal to the specified numeric expression
`LOG` returns the natural logarithm of the specified float expression
`LOG_10` returns the base-10 logarithm of the specified float expression
`LOWER_CASE`
`MAX` returns the maximum value in the expression
`META_BUSINESS_NAME` returns the column, table, schema or database business name alias
`META_COL_PRECISION` returns the column precision
`META_COL_SCALE` returns the column scale
`META_LOCAL_NAME` returns the column, table, schema or database business name alias
`META_NAME` returns the column, table, schema or database name
`META_PHYSICAL_NAME` returns the column, table, schema or database physical name alias
`MICROSECOND`
`MIN` returns the minimum value in the expression
`MINUTE`
`MONTH`
`MONTH_FROM_DATE`
`MONTHNAME`
`NGRAMS` returns the current ngrams for a given search
`NORMALIZE_SPACE`
`OFFSETS` returns search term word or character offsets into the given body of text or document
`PI` returns the constant value of PI
`POW` returns the value of the specified expression to the specified power
`PROXIMITY` returns the current query term proximity weight for a given search
`RANK` returns the rank of each row within the partition of a result set
`RELEVANCE` returns the search relevance value for a given document
`ROUND` returns a numeric value, rounded to the specified length or precision
`ROW_NUMBER` numbers the output of a result set.
`SCORE` returns the final composite score for a given document or body of text
`SDTDEV` returns the statistical standard deviation of all values in the specified expression
`SIN` returns the trigonometric sine of the specified angle, in radians, and in an approximate numeric, float, expression
`SQRT` returns the square root of the specified float value
`SQUARE` returns the square of the specified float value
`SUBSTRING_AFTER`
`SUBSTRING_BEFORE`
`SUM` returns the sum of all the values
`TAN` returns the tangent of the input expression
`TERMS` returns the current search terms for a given search
`TIMEZONE_FROM_DATE`
`UPPER_CASE`
`USER` returns the system-supplied value for the database user name of the current user
`VAR` returns the statistical variance of all values in the specified expression
`WEEK`
`WEEKDAY`
`WEEKOFYEAR`
`WEIGHT` returns the vector space weight for a given search
`YEAR`
`YEAR_FROM_DATE`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static FunctionName`	`fromValue(String v)`
`org.plasma.sdo.DataType`	`getScalarDatatype(org.plasma.sdo.DataType sourceDataType)`
`static boolean`	`hasName(String name)`
`boolean`	`isAggreate()`
`boolean`	`isFullText()`
`String`	`value()`
`static FunctionName`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static FunctionName[]`	`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
  - AVG
```
public static final FunctionName AVG
```
    returns the average of the values in a group. Null values are ignored
  - COUNT
```
public static final FunctionName COUNT
```
    returns the number of items in a group
  - MAX
```
public static final FunctionName MAX
```
    returns the maximum value in the expression
  - MIN
```
public static final FunctionName MIN
```
    returns the minimum value in the expression
  - SDTDEV
```
public static final FunctionName SDTDEV
```
    returns the statistical standard deviation of all values in the specified expression
  - SUM
```
public static final FunctionName SUM
```
    returns the sum of all the values
  - VAR
```
public static final FunctionName VAR
```
    returns the statistical variance of all values in the specified expression
  - CAST
```
public static final FunctionName CAST
```
    returns an expression of one data type to another
  - CONVERT
```
public static final FunctionName CONVERT
```
    returns an expression of one data type to another
  - ABS
```
public static final FunctionName ABS
```
    returns mathematical function that returns the absolute (positive) value of the specified numeric expression
  - ACOS
```
public static final FunctionName ACOS
```
    returns mathematical function that returns the angle, in radians, whose cosine is the specified float expression
  - ASIN
```
public static final FunctionName ASIN
```
    returns the angle, in radians, whose sine is the specified float expression. This is also called arcsine
  - ATAN
```
public static final FunctionName ATAN
```
    returns the angle in radians whose tangent is a specified float expression. This is also called arctangent
  - CEILING
```
public static final FunctionName CEILING
```
    returns the smallest integer greater than, or equal to, the specified numeric expression
  - COS
```
public static final FunctionName COS
```
    returns a mathematical function that returns the trigonometric cosine of the specified angle, in radians, in the specified expression
  - COT
```
public static final FunctionName COT
```
    returns mathematical function that returns the trigonometric cotangent of the specified angle, in radians, in the specified float expression
  - EXP
```
public static final FunctionName EXP
```
    returns the exponential value of the specified float expression
  - FLOOR
```
public static final FunctionName FLOOR
```
    returns the largest integer less than or equal to the specified numeric expression
  - LOG
```
public static final FunctionName LOG
```
    returns the natural logarithm of the specified float expression
  - LOG_10
```
public static final FunctionName LOG_10
```
    returns the base-10 logarithm of the specified float expression
  - PI
```
public static final FunctionName PI
```
    returns the constant value of PI
  - POW
```
public static final FunctionName POW
```
    returns the value of the specified expression to the specified power
  - ROUND
```
public static final FunctionName ROUND
```
    returns a numeric value, rounded to the specified length or precision
  - SIN
```
public static final FunctionName SIN
```
    returns the trigonometric sine of the specified angle, in radians, and in an approximate numeric, float, expression
  - SQRT
```
public static final FunctionName SQRT
```
    returns the square root of the specified float value
  - SQUARE
```
public static final FunctionName SQUARE
```
    returns the square of the specified float value
  - TAN
```
public static final FunctionName TAN
```
    returns the tangent of the input expression
  - META_COL_PRECISION
```
public static final FunctionName META_COL_PRECISION
```
    returns the column precision
  - META_COL_SCALE
```
public static final FunctionName META_COL_SCALE
```
    returns the column scale
  - META_NAME
```
public static final FunctionName META_NAME
```
    returns the column, table, schema or database name
  - META_PHYSICAL_NAME
```
public static final FunctionName META_PHYSICAL_NAME
```
    returns the column, table, schema or database physical name alias
  - META_BUSINESS_NAME
```
public static final FunctionName META_BUSINESS_NAME
```
    returns the column, table, schema or database business name alias
  - META_LOCAL_NAME
```
public static final FunctionName META_LOCAL_NAME
```
    returns the column, table, schema or database business name alias
  - RANK
```
public static final FunctionName RANK
```
    returns the rank of each row within the partition of a result set
  - ROW_NUMBER
```
public static final FunctionName ROW_NUMBER
```
    numbers the output of a result set. More specifically, returns the sequential number of a row within a partition of a result set, starting at 1 for the first row in each partition
  - USER
```
public static final FunctionName USER
```
    returns the system-supplied value for the database user name of the current user
  - SUBSTRING_BEFORE
```
public static final FunctionName SUBSTRING_BEFORE
```
  - SUBSTRING_AFTER
```
public static final FunctionName SUBSTRING_AFTER
```
  - NORMALIZE_SPACE
```
public static final FunctionName NORMALIZE_SPACE
```
  - UPPER_CASE
```
public static final FunctionName UPPER_CASE
```
  - LOWER_CASE
```
public static final FunctionName LOWER_CASE
```
  - YEAR_FROM_DATE
```
public static final FunctionName YEAR_FROM_DATE
```
  - MONTH_FROM_DATE
```
public static final FunctionName MONTH_FROM_DATE
```
  - DAY_FROM_DATE
```
public static final FunctionName DAY_FROM_DATE
```
  - TIMEZONE_FROM_DATE
```
public static final FunctionName TIMEZONE_FROM_DATE
```
  - OFFSETS
```
public static final FunctionName OFFSETS
```
    returns search term word or character offsets into the given body of text or document
  - RELEVANCE
```
public static final FunctionName RELEVANCE
```
    returns the search relevance value for a given document
  - SCORE
```
public static final FunctionName SCORE
```
    returns the final composite score for a given document or body of text
  - TERMS
```
public static final FunctionName TERMS
```
    returns the current search terms for a given search
  - NGRAMS
```
public static final FunctionName NGRAMS
```
    returns the current ngrams for a given search
  - PROXIMITY
```
public static final FunctionName PROXIMITY
```
    returns the current query term proximity weight for a given search
  - WEIGHT
```
public static final FunctionName WEIGHT
```
    returns the vector space weight for a given search
  - DAYOFMONTH
```
public static final FunctionName DAYOFMONTH
```
  - DAYOFWEEK
```
public static final FunctionName DAYOFWEEK
```
  - DAYOFYEAR
```
public static final FunctionName DAYOFYEAR
```
  - DAY
```
public static final FunctionName DAY
```
  - MICROSECOND
```
public static final FunctionName MICROSECOND
```
  - MINUTE
```
public static final FunctionName MINUTE
```
  - MONTH
```
public static final FunctionName MONTH
```
  - MONTHNAME
```
public static final FunctionName MONTHNAME
```
  - WEEK
```
public static final FunctionName WEEK
```
  - WEEKDAY
```
public static final FunctionName WEEKDAY
```
  - WEEKOFYEAR
```
public static final FunctionName WEEKOFYEAR
```
  - YEAR
```
public static final FunctionName YEAR
```
  - APP_FUNCTION
```
public static final FunctionName APP_FUNCTION
```
- Method Detail
  - values
```
public static FunctionName[] 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 (FunctionName c : FunctionName.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static FunctionName 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
    
    NullPointerException - if the argument is null
  - value
```
public String value()
```
  - fromValue
```
public static FunctionName fromValue(String v)
```
  - isAggreate
```
public boolean isAggreate()
```
  - isFullText
```
public boolean isFullText()
```
  - getScalarDatatype
```
public org.plasma.sdo.DataType getScalarDatatype(org.plasma.sdo.DataType sourceDataType)
```
  - hasName
```
public static boolean hasName(String name)
```

Enum FunctionName

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

AVG

COUNT

MAX

MIN

SDTDEV

SUM

VAR

CAST

CONVERT

ABS

ACOS

ASIN

ATAN

CEILING

COS

COT

EXP

FLOOR

LOG

LOG_10

PI

POW

ROUND

SIN

SQRT

SQUARE

TAN

META_COL_PRECISION

META_COL_SCALE

META_NAME

META_PHYSICAL_NAME

META_BUSINESS_NAME

META_LOCAL_NAME

RANK

ROW_NUMBER

USER

SUBSTRING_BEFORE

SUBSTRING_AFTER

NORMALIZE_SPACE

UPPER_CASE

LOWER_CASE

YEAR_FROM_DATE

MONTH_FROM_DATE

DAY_FROM_DATE

TIMEZONE_FROM_DATE

OFFSETS

RELEVANCE

SCORE

TERMS

NGRAMS

PROXIMITY

WEIGHT

DAYOFMONTH

DAYOFWEEK

DAYOFYEAR

DAY

MICROSECOND

MINUTE

MONTH

MONTHNAME

WEEK

WEEKDAY

WEEKOFYEAR

YEAR

APP_FUNCTION

Method Detail

values

valueOf

value

fromValue

isAggreate

isFullText

getScalarDatatype

hasName