com.orientechnologies.orient.core.metadata.function

Class OFunction

java.lang.Object

com.orientechnologies.orient.core.type.ODocumentWrapper

com.orientechnologies.orient.core.metadata.function.OFunction

All Implemented Interfaces:

Serializable

public class OFunction
extends ODocumentWrapper

Stored function. It contains language and code to execute as a function. The execute() takes parameters. The function is state-less, so can be used by different threads.

Author:

Luca Garulli

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASS_NAME

Fields inherited from class com.orientechnologies.orient.core.type.ODocumentWrapper

document

Constructor Summary

Constructors

Constructor and Description
OFunction() Creates a new function.
OFunction(ODocument iDocument) Creates a new function wrapping the saved document.
OFunction(ORecordId iRid) Loads a function.

Method Summary

Modifier and Type	Method and Description
Object	execute(Map<Object,Object> iArgs)
Object	execute(Object... iArgs)
Object	executeInContext(OCommandContext iContext, Map<String,Object> iArgs)
Object	executeInContext(OCommandContext iContext, Object... iArgs)
OCallable<Object,Map<Object,Object>>	getCallback()
String	getCode()
ORID	getId()
String	getLanguage()
String	getName()
List<String>	getParameters()
boolean	isIdempotent()
OFunction	setCallback(OCallable<Object,Map<Object,Object>> callback)
OFunction	setCode(String iCode)
OFunction	setIdempotent(boolean iIdempotent)
OFunction	setLanguage(String iLanguage)
OFunction	setName(String iName)
OFunction	setParameters(List<String> iParameters)
String	toString()

Methods inherited from class com.orientechnologies.orient.core.type.ODocumentWrapper

equals, fromStream, getDocument, hashCode, load, load, load, load, reload, reload, reload, save, save, toStream

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_NAME

public static final String CLASS_NAME

See Also:

Constant Field Values

Constructor Detail

OFunction

public OFunction()

Creates a new function.

OFunction

public OFunction(ODocument iDocument)

Creates a new function wrapping the saved document.

Parameters:

iDocument - Document to assign

OFunction

public OFunction(ORecordId iRid)

Loads a function.

Parameters:

iRid - RID of the function to load

Method Detail

getName

public String getName()

setName

public OFunction setName(String iName)

getCode

public String getCode()

setCode

public OFunction setCode(String iCode)

getLanguage

public String getLanguage()

setLanguage

public OFunction setLanguage(String iLanguage)

getParameters

public List<String> getParameters()

setParameters

public OFunction setParameters(List<String> iParameters)

isIdempotent

public boolean isIdempotent()

setIdempotent

public OFunction setIdempotent(boolean iIdempotent)

getCallback

public OCallable<Object,Map<Object,Object>> getCallback()

setCallback

public OFunction setCallback(OCallable<Object,Map<Object,Object>> callback)

execute

public Object execute(Object... iArgs)

executeInContext

public Object executeInContext(OCommandContext iContext,
                               Object... iArgs)

executeInContext

public Object executeInContext(OCommandContext iContext,
                               Map<String,Object> iArgs)

execute

public Object execute(Map<Object,Object> iArgs)

getId

public ORID getId()

toString

public String toString()

Overrides:

toString in class ODocumentWrapper