com.simba.dsi.ext.aetree
Class AEScalarFn

java.lang.Object
  extended by com.simba.dsi.CppClassWrapper
      extended by com.simba.dsi.ext.aetree.AENode
          extended by com.simba.dsi.ext.aetree.AEExpr
              extended by com.simba.dsi.ext.aetree.AEValueExpr
                  extended by com.simba.dsi.ext.aetree.AEScalarFn
All Implemented Interfaces:
IColumn

public final class AEScalarFn
extends AEValueExpr

This class represents a scalar function.


Constructor Summary
AEScalarFn(long objRef, ScalarFunctionID scalarFnID)
          Constructor.
 
Method Summary
 AEValueList getArguments()
          Retrieves the arguments for the scalar function.
 ScalarFunctionID getScalarFnID()
          Returns the unique identifier for the scalar function.
 java.lang.String getScalarFnName()
          Retrieves the name of the scalar function.
 boolean hasArguments()
          Tells whether there are arguments for the scalar function.
 
Methods inherited from class com.simba.dsi.ext.aetree.AEValueExpr
getCatalogName, getColumnLength, getDisplaySize, getLabel, getName, getNullable, getSchemaName, getSearchable, getTableName, getTypeMetadata, getUpdatable, isAutoUnique, isCaseSensitive, isDefinitelyWritable, isUnnamed
 
Methods inherited from class com.simba.dsi.ext.aetree.AENode
getChild, getChildCount, getNodeType
 
Methods inherited from class com.simba.dsi.CppClassWrapper
getObjRef
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AEScalarFn

public AEScalarFn(long objRef,
                  ScalarFunctionID scalarFnID)
Constructor.

Parameters:
objRef - The corresponding C++ object reference.
scalarFnID - The scalar function ID that uniquely identified the scalar function.
Method Detail

hasArguments

public boolean hasArguments()
Tells whether there are arguments for the scalar function.

Returns:
true if the scalar function has arguments passed in, false otherwise.

getArguments

public AEValueList getArguments()
Retrieves the arguments for the scalar function.

Returns:
The arguments for the scalar function.

getScalarFnID

public ScalarFunctionID getScalarFnID()
Returns the unique identifier for the scalar function.

All built-in functions are uniquely identified by this ID. All customer functions bear the same ID, they should be distinguished by their names.

Returns:
The unique identifier for the scalar function.

getScalarFnName

public java.lang.String getScalarFnName()
Retrieves the name of the scalar function. Since no polymorphism is supported, the name of the scalar function should uniquely identify the scalar function.

Returns:
The name of the scalar function.


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