|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectrailo.runtime.component.MemberSupport
railo.runtime.type.UDFImpl
public class UDFImpl
defines a abstract class for a User defined Functions
Field Summary |
---|
Fields inherited from interface railo.runtime.type.UDF |
---|
RETURN_FORMAT_JSON, RETURN_FORMAT_PLAIN, RETURN_FORMAT_SERIALIZE, RETURN_FORMAT_WDDX |
Constructor Summary | |
---|---|
UDFImpl()
DO NOT USE THIS CONSTRUCTOR! this constructor is only for deserialize process |
|
UDFImpl(Page page,
FunctionArgument[] arguments,
int index,
String functionName,
short returnType,
String strReturnFormat,
boolean output,
boolean async,
String strAccess,
String displayName,
String description,
String hint,
Boolean secureJson,
Boolean verifyClient,
StructImpl meta)
Deprecated. use instead UDFImpl(UDFProperties properties) |
|
UDFImpl(Page page,
FunctionArgument[] arguments,
int index,
String functionName,
String strReturnType,
String strReturnFormat,
boolean output,
boolean async,
String strAccess,
String displayName,
String description,
String hint,
Boolean secureJson,
Boolean verifyClient,
StructImpl meta)
Deprecated. use instead UDFImpl(UDFProperties properties) |
|
UDFImpl(UDFProperties properties)
|
Method Summary | |
---|---|
static void |
argumentCollection(Struct values)
|
static void |
argumentCollection(Struct values,
FunctionArgument[] funcArgs)
|
Object |
call(PageContext pc,
Object[] args,
boolean doIncludePath)
call user defined Funcion with parameters as Object Array |
Object |
callWithNamedValues(PageContext pc,
Struct values,
boolean doIncludePath)
call user defined Funcion with a hashmap of named values |
Object |
clone()
|
UDF |
duplicate()
|
UDF |
duplicate(boolean deepCopy)
|
UDF |
duplicate(ComponentImpl c)
|
Object |
getDefaultValue(PageContext pc,
int index)
|
String |
getDescription()
|
String |
getDisplayName()
|
FunctionArgument[] |
getFunctionArguments()
return all function arguments of this UDF |
String |
getFunctionName()
|
String |
getHint()
|
Struct |
getMeta()
|
Struct |
getMetaData(PageContext pc)
|
boolean |
getOutput()
|
Component |
getOwnerComponent()
it is the component in whitch this udf is constructed, must not be the same as active udf |
Page |
getPage()
Deprecated. use instead getPageSource() |
PageSource |
getPageSource()
|
int |
getReturnFormat()
|
String |
getReturnFormatAsString()
|
int |
getReturnType()
|
String |
getReturnTypeAsString()
|
Boolean |
getSecureJson()
returns null when not defined |
Object |
getValue()
return the value itself |
Boolean |
getVerifyClient()
returns null when not defined |
Object |
implementation(PageContext pageContext)
abstract method for the function Body |
void |
readExternal(ObjectInput in)
|
void |
setOwnerComponent(ComponentImpl component)
|
long |
sizeOf()
return the size of the object |
DumpData |
toDumpData(PageContext pageContext,
int maxlevel,
DumpProperties dp)
method to print out information to a object as HTML |
static DumpData |
toDumpData(PageContext pageContext,
int maxlevel,
DumpProperties dp,
UDF udf)
|
static Collection.Key |
toKey(Object obj)
|
static String |
toReturnFormat(int returnFormat)
|
static String |
toReturnFormat(int returnFormat,
String defaultValue)
|
static int |
toReturnFormat(String returnFormat)
|
String |
toString()
|
void |
writeExternal(ObjectOutput out)
|
Methods inherited from class railo.runtime.component.MemberSupport |
---|
getAccess, setAccess, setAccess |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface railo.runtime.component.Member |
---|
getAccess |
Constructor Detail |
---|
public UDFImpl(Page page, FunctionArgument[] arguments, int index, String functionName, String strReturnType, String strReturnFormat, boolean output, boolean async, String strAccess, String displayName, String description, String hint, Boolean secureJson, Boolean verifyClient, StructImpl meta) throws ExpressionException
UDFImpl(UDFProperties properties)
page
- arguments
- index
- functionName
- strReturnType
- strReturnFormat
- output
- async
- strAccess
- displayName
- description
- hint
- secureJson
- verifyClient
- meta
-
ExpressionException
public UDFImpl(Page page, FunctionArgument[] arguments, int index, String functionName, short returnType, String strReturnFormat, boolean output, boolean async, String strAccess, String displayName, String description, String hint, Boolean secureJson, Boolean verifyClient, StructImpl meta) throws ExpressionException
UDFImpl(UDFProperties properties)
page
- arguments
- index
- functionName
- returnType
- strReturnFormat
- output
- async
- strAccess
- displayName
- description
- hint
- secureJson
- verifyClient
- meta
-
ExpressionException
public UDFImpl()
public UDFImpl(UDFProperties properties)
Method Detail |
---|
public long sizeOf()
Sizeable
sizeOf
in interface Sizeable
railo.runtime.engine.Sizeable#sizeOf()
public UDF duplicate(ComponentImpl c)
public UDF duplicate(boolean deepCopy)
duplicate
in interface Duplicable
public UDF duplicate()
duplicate
in interface UDF
public Object implementation(PageContext pageContext) throws Throwable
UDF
implementation
in interface UDF
Throwable
UDF.implementation(railo.runtime.PageContext)
public static void argumentCollection(Struct values)
public static void argumentCollection(Struct values, FunctionArgument[] funcArgs)
public static Collection.Key toKey(Object obj)
public Object callWithNamedValues(PageContext pc, Struct values, boolean doIncludePath) throws PageException
UDF
callWithNamedValues
in interface UDF
values
- named values
PageException
UDF.callWithNamedValues(railo.runtime.PageContext, railo.runtime.type.Struct, boolean)
public Object call(PageContext pc, Object[] args, boolean doIncludePath) throws PageException
UDF
call
in interface UDF
args
- parameters for the function
PageException
UDF.call(railo.runtime.PageContext, java.lang.Object[], boolean)
public DumpData toDumpData(PageContext pageContext, int maxlevel, DumpProperties dp)
Dumpable
toDumpData
in interface Dumpable
railo.runtime.dump.Dumpable#toDumpData(railo.runtime.PageContext, int)
public static DumpData toDumpData(PageContext pageContext, int maxlevel, DumpProperties dp, UDF udf)
public String getDisplayName()
getDisplayName
in interface UDF
UDF.getDisplayName()
public String getHint()
getHint
in interface UDF
UDF.getHint()
public Page getPage()
getPage
in interface UDF
UDF.getPage()
public PageSource getPageSource()
public Struct getMeta()
public Struct getMetaData(PageContext pc) throws PageException
getMetaData
in interface UDF
PageException
public Object getValue()
Member
getValue
in interface Member
public void setOwnerComponent(ComponentImpl component)
componentImpl
- the componentImpl to setinjected
- public Component getOwnerComponent()
UDF
getOwnerComponent
in interface UDF
// FUTURE deprecated
public String toString()
toString
in class Object
public Boolean getSecureJson()
UDF
getSecureJson
in interface UDF
UDF.getSecureJson()
public Boolean getVerifyClient()
UDF
getVerifyClient
in interface UDF
UDF.getVerifyClient()
public Object clone()
clone
in class Object
public FunctionArgument[] getFunctionArguments()
UDF
getFunctionArguments
in interface UDF
UDF.getFunctionArguments()
public Object getDefaultValue(PageContext pc, int index) throws PageException
getDefaultValue
in interface UDF
PageException
UDF.getDefaultValue(railo.runtime.PageContext, int)
public String getFunctionName()
getFunctionName
in interface UDF
UDF.getFunctionName()
public boolean getOutput()
getOutput
in interface UDF
UDF.getOutput()
public int getReturnType()
getReturnType
in interface UDF
UDF.getReturnType()
public String getReturnTypeAsString()
getReturnTypeAsString
in interface UDF
UDF.getReturnTypeAsString()
public String getDescription()
getDescription
in interface UDF
UDF.getDescription()
public int getReturnFormat()
getReturnFormat
in interface UDF
UDF.getReturnFormat()
public final String getReturnFormatAsString()
public static int toReturnFormat(String returnFormat) throws ExpressionException
ExpressionException
public static String toReturnFormat(int returnFormat) throws ExpressionException
ExpressionException
public static String toReturnFormat(int returnFormat, String defaultValue)
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
IOException
ClassNotFoundException
public void writeExternal(ObjectOutput out) throws IOException
writeExternal
in interface Externalizable
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |