com.orientechnologies.orient.core.sql.functions

Interface OSQLFunctionFiltered

All Superinterfaces:

OSQLFunction

All Known Implementing Classes:

OSQLFunctionIn, OSQLFunctionMoveFiltered, OSQLFunctionOut

public interface OSQLFunctionFiltered
extends OSQLFunction

Author:

Luigi Dell'Aquila

Method Summary

Modifier and Type	Method and Description
Object	execute(Object iThis, OIdentifiable iCurrentRecord, Object iCurrentResult, Object[] iParams, Iterable<OIdentifiable> iPossibleResults, OCommandContext iContext) Process a record.

Methods inherited from interface com.orientechnologies.orient.core.sql.functions.OSQLFunction

aggregateResults, config, execute, filterResult, getMaxParams, getMinParams, getName, getResult, getSyntax, mergeDistributedResult, setResult, shouldMergeDistributedResult

Method Detail

execute

Object execute(Object iThis,
               OIdentifiable iCurrentRecord,
               Object iCurrentResult,
               Object[] iParams,
               Iterable<OIdentifiable> iPossibleResults,
               OCommandContext iContext)

Process a record.

Parameters:

iThis -

iCurrentRecord - : current record

iCurrentResult - TODO

iParams - : function parameters, number is ensured to be within minParams and maxParams.

iPossibleResults - : a set of possible results (the function will return, as a result, only items contained in this collection)

iContext - : object calling this function

Returns:

function result, can be null. Special cases : can be null if function aggregate results, can be null if function filter results : this mean result is excluded