|
Oracle® OLAP Java API Reference 11g Release 2 (11.2) E10794-06 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.olapi.syntax.FunctionDescriptor
public final class FunctionDescriptor
An object that describes the structure of an Expression
function. A FunctionDescriptor
contains information about a function, such as the function name and the data type of the value returned by the function. The name is returned by the getFunctionName
method and the data type is returned by the getFunctionReturnType method
.
Most FunctionDescriptor
objects contain one or more FunctionDescriptorArguments
that represent the required or optional arguments that apply to the function. The arguments are returned by the getArguments
method.
A FunctionDescriptor
has a category, such as DATETIME
or NUMERIC
, and a function type, which is one of the fields of this class, such as OLAP_FUNCTION
. The class has methods that get the category and function type. It also has methods that indicate whether the function applies to an analytic workspace, and whether the function described is a pseudocolumn.
Oracle OLAP creates instances of this class when an application creates an Expression
or uses a method that returns an Expression
. An application can get the FunctionDescriptor
for TypedExpression
classes that have a getFunctionDescriptor
method, such as OLAPFunctionExpression
and RowFunctionExpression
.
Field Summary | |
---|---|
static int |
AGGREGATION_EXPRESSION_FUNCTION A constant that represents an aggregation function that is used by an AggregationFunctionExpression. |
static int |
AGGREGATION_FUNCTION A constant that represents an aggregation function, such as MAX or SUM , that is used by an AggregationCommand. |
static int |
ALLOCATION_FUNCTION A constant that represents an allocation function, such as MIN_ALLOC or FIRST_ALLOC . |
static int |
CONDITION_FUNCTION A constant that represents an condition function, such as HIER_HAS_CHILDREN or EQUALS_PATH . |
static int |
FORECAST_FUNCTION A constant that represents an forecasting function, such as FORECAST or FORECAST_SEASONAL . |
static int |
OLAP_FUNCTION A constant that represents an OLAP function, such as HIER_PARENT or SHARE . |
static int |
OLAP_HIER_FUNCTION A constant that represents an hierarchical OLAP function, such as LAG or RANK . |
static int |
PSEUDO_COLUMN_FUNCTION A constant that represents a pseudocolumn function, such as SYSDATE or USER . |
static int |
QUERY_FUNCTION A constant that represents an query function, such as HIER_ANCESTORS or HIER_SIBLINGS . |
static int |
ROW_FUNCTION A constant that represents a row function, such as ABS or LENGTH . |
Method Summary | |
---|---|
FunctionDescriptorArgument[] |
getArguments() Gets the function descriptor arguments that are associated with this FunctionDescriptor . |
java.lang.String |
getCategory() Gets the name of the category of the function that is associated with this FunctionDescriptor . |
java.lang.String |
getFunctionName() Gets the name of the function that is associated with this FunctionDescriptor . |
DataType |
getFunctionReturnType() Gets the data type of the value returned by the function. |
int |
getFunctionType() Gets the type of the function, which is one of the constants of this class, such as FunctionDescriptor.ROW_FUNCTION . |
boolean |
isAWFunction() Indicates whether the function applies to an analytic workspace deployment. |
boolean |
isPseudoColumn() Indicates whether this FunctionDescriptor is associated with a pseudocolumn function. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int PSEUDO_COLUMN_FUNCTION
SYSDATE
or USER
.
public static final int ROW_FUNCTION
ABS
or LENGTH
.
public static final int OLAP_FUNCTION
HIER_PARENT
or SHARE
.
public static final int OLAP_HIER_FUNCTION
LAG
or RANK
.
public static final int AGGREGATION_FUNCTION
MAX
or SUM
, that is used by an AggregationCommand.
public static final int ALLOCATION_FUNCTION
MIN_ALLOC
or FIRST_ALLOC
.
public static final int FORECAST_FUNCTION
FORECAST
or FORECAST_SEASONAL
.
public static final int CONDITION_FUNCTION
HIER_HAS_CHILDREN
or EQUALS_PATH
.
public static final int QUERY_FUNCTION
HIER_ANCESTORS
or HIER_SIBLINGS
.
public static final int AGGREGATION_EXPRESSION_FUNCTION
Method Detail |
---|
public final java.lang.String getFunctionName()
FunctionDescriptor
.String
that contains the name of the function associated with this FunctionDescriptor
.public final java.lang.String getCategory()
FunctionDescriptor
. Examples of catgory names are HIERARCHICAL
, NUMERIC
, and CHARACTER
.String
that contains the name of the category of the function associated with this FunctionDescriptor
.public final boolean isAWFunction()
boolean
that is true
if the function applies to an analytic workspace or false
if it does not.public final FunctionDescriptorArgument[] getArguments()
FunctionDescriptor
.FunctionDescriptorArgument
objects associated with this FunctionDescriptor
.public final DataType getFunctionReturnType()
null
if the function does not return a typed value or if the return type varies depending on the arguments. For example, for the HIER_HAS_CHILDREN
function, which is a condition function, this method returns null
.DataType
that represents the data type of the value returned by the function.public int getFunctionType()
FunctionDescriptor.ROW_FUNCTION
.public boolean isPseudoColumn()
FunctionDescriptor
is associated with a pseudocolumn function.boolean
that is true
if this FunctionDescriptor
is associated with a pseudocolumn function or false
if it is not.
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |