com.orientechnologies.orient.core.sql.functions.stat

Class OSQLFunctionMode

java.lang.Object

com.orientechnologies.orient.core.sql.functions.OSQLFunctionAbstract

com.orientechnologies.orient.core.sql.functions.stat.OSQLFunctionMode

All Implemented Interfaces:

OSQLFunction

public class OSQLFunctionMode
extends OSQLFunctionAbstract

Compute the mode (or multimodal) value for a field. The scores in the field's distribution that occurs more frequently. Nulls are ignored in the calculation.

Author:

Fabrizio Fortino

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Fields inherited from class com.orientechnologies.orient.core.sql.functions.OSQLFunctionAbstract

maxParams, minParams, name

Constructor Summary

Constructors

Constructor and Description
OSQLFunctionMode()

Method Summary

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 convinient SQL String representation of the function.
Object	mergeDistributedResult(List<Object> resultsToMerge) This method correspond to distributed query execution

Methods inherited from class com.orientechnologies.orient.core.sql.functions.OSQLFunctionAbstract

config, filterResult, getDistributedStorageId, getMaxParams, getMinParams, getName, returnDistributedResult, setResult, shouldMergeDistributedResult, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

OSQLFunctionMode

public OSQLFunctionMode()

Method Detail

execute

public Object execute(Object iThis,
                      OIdentifiable iCurrentRecord,
                      Object iCurrentResult,
                      Object[] iParams,
                      OCommandContext iContext)

Description copied from interface: OSQLFunction

Process a record.

iCurrentRecord - : current record

iCurrentResult - TODO

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

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

getResult

public Object getResult()

Description copied from interface: OSQLFunction

Only called when function aggregates results after all records have been passed to the function.

Specified by:

getResult in interface OSQLFunction

Overrides:

getResult in class OSQLFunctionAbstract

Returns:

Aggregation result

getSyntax

public String getSyntax()

Description copied from interface: OSQLFunction

Returns a convinient SQL String representation of the function.

Example :

  myFunction( param1, param2, [optionalParam3])
 

This text will be used in exception messages.

Returns:

String , never null.

aggregateResults

public boolean aggregateResults()

Description copied from interface: OSQLFunction

A function can make calculation on several records before returning a result.

Example of such function : sum, count, max, min ...

The final result of the aggregation is obtain by calling OSQLFunction.getResult()

Specified by:

aggregateResults in interface OSQLFunction

Overrides:

aggregateResults in class OSQLFunctionAbstract

Returns:

true if function aggregate results

mergeDistributedResult

public Object mergeDistributedResult(List<Object> resultsToMerge)

Description copied from interface: OSQLFunction

This method correspond to distributed query execution

Specified by:

mergeDistributedResult in interface OSQLFunction

Overrides:

mergeDistributedResult in class OSQLFunctionAbstract

Parameters:

resultsToMerge - is the results that comes from different nodes

Returns:

is the valid merged result