org.teiid.query.function
Class FunctionDescriptor

java.lang.Object
  org.teiid.query.function.FunctionDescriptor

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class FunctionDescriptor
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

The FunctionDescriptor describes a particular function instance enough that the function library can retrieve a function instance based on the descriptor.

See Also:

Serialized Form

Method Summary

java.lang.Object	clone()
boolean	equals(java.lang.Object obj)
int	getDeterministic()
java.lang.String	getName()
int	getPushdown()
java.lang.Class	getReturnType()
java.lang.Class[]	getTypes()
int	hashCode()
static java.lang.Object	importValue(java.lang.Object result, java.lang.Class<?> expectedType)
java.lang.Object	invokeFunction(java.lang.Object[] values) Invoke the function described in the function descriptor, using the values provided.
boolean	isNullDependent()
boolean	requiresContext()
java.lang.String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getName

public java.lang.String getName()

getPushdown

public int getPushdown()

getTypes

public java.lang.Class[] getTypes()

getReturnType

public java.lang.Class getReturnType()

requiresContext

public boolean requiresContext()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isNullDependent

public boolean isNullDependent()

getDeterministic

public int getDeterministic()

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

invokeFunction

public java.lang.Object invokeFunction(java.lang.Object[] values)
                                throws FunctionExecutionException

Invoke the function described in the function descriptor, using the values provided. Return the result of the function.

Parameters:

fd - Function descriptor describing the name and types of the arguments

values - Values that should match 1-to-1 with the types described in the function descriptor

Returns:

Result of invoking the function

Throws:

FunctionExecutionException

importValue

public static java.lang.Object importValue(java.lang.Object result,
                                           java.lang.Class<?> expectedType)
                                    throws java.lang.ArithmeticException,
                                           TransformationException

Throws:

java.lang.ArithmeticException

TransformationException