public class OSQLFunctionSequence extends OSQLFunctionConfigurableAbstract
Modifier and Type | Field and Description |
---|---|
static String |
NAME |
configuredParameters
maxParams, minParams, name
Constructor and Description |
---|
OSQLFunctionSequence() |
Modifier and Type | Method and Description |
---|---|
boolean |
aggregateResults()
A function can make calculation on several records before returning a result.
|
Object |
execute(Object iThis,
OIdentifiable iCurrentRecord,
Object iCurrentResult,
Object[] iParams,
OCommandContext iContext)
Process a record.
|
Object |
getResult()
Only called when function aggregates results after all records have been passed to the
function.
|
String |
getSyntax()
Returns a convenient SQL String representation of the function.
|
config, toString
filterResult, getDistributedStorageId, getMaxParams, getMinParams, getName, getSingleItem, getSingleProperty, mergeDistributedResult, returnDistributedResult, setResult, shouldMergeDistributedResult
public static final String NAME
public Object execute(Object iThis, OIdentifiable iCurrentRecord, Object iCurrentResult, Object[] iParams, OCommandContext iContext)
OSQLFunction
iCurrentRecord
- : current recordiCurrentResult
- TODOiParams
- : function parameters, number is ensured to be within minParams and maxParams.iContext
- : object calling this functionpublic Object getResult()
OSQLFunction
getResult
in interface OSQLFunction
getResult
in class OSQLFunctionAbstract
public String getSyntax()
OSQLFunction
Example :
myFunction( param1, param2, [optionalParam3])
This text will be used in exception messages.
public boolean aggregateResults()
OSQLFunction
Example of such function : sum, count, max, min ...
The final result of the aggregation is obtain by calling OSQLFunction.getResult()
aggregateResults
in interface OSQLFunction
aggregateResults
in class OSQLFunctionAbstract
Copyright © 2009–2020 OrientDB. All rights reserved.