Package com.orientechnologies.orient.core.sql.functions.coll

Class OSQLFunctionMap

java.lang.Object

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

com.orientechnologies.orient.core.sql.functions.OSQLFunctionConfigurableAbstract

com.orientechnologies.orient.core.sql.functions.coll.OSQLFunctionMultiValueAbstract<Map<Object,Object>>

com.orientechnologies.orient.core.sql.functions.coll.OSQLFunctionMap

All Implemented Interfaces:

OSQLFunction

public class OSQLFunctionMap
extends OSQLFunctionMultiValueAbstract<Map<Object,Object>>

This operator add an entry in a map. The entry is composed by a key and a value.

Author:

Luca Garulli (l.garulli--(at)--orientdb.com)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from class com.orientechnologies.orient.core.sql.functions.coll.OSQLFunctionMultiValueAbstract

context

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

configuredParameters

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

maxParams, minParams, name

Constructor Summary

Constructors

Constructor	Description
OSQLFunctionMap()

Method Summary

Modifier and Type	Method	Description
boolean	aggregateResults()	A function can make calculation on several records before returning a result.
boolean	aggregateResults(Object[] configuredParameters)
Object	execute(Object iThis, OIdentifiable iCurrentRecord, Object iCurrentResult, Object[] iParams, OCommandContext iContext)	Process a record.
Map<Object,Object>	getResult(OCommandContext ctx)	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.
Object	mergeDistributedResult(List<Object> resultsToMerge)	This method correspond to distributed query execution
protected Map<Object,Object>	prepareResult(Map<Object,Object> res, OCommandContext ctx)

Methods inherited from class com.orientechnologies.orient.core.sql.functions.coll.OSQLFunctionMultiValueAbstract

shouldMergeDistributedResult

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

config, toString

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

filterResult, getDatabase, getDistributedStorageId, getMaxParams, getMinParams, getName, getSingleItem, getSingleProperty, returnDistributedResult, setResult

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

OSQLFunctionMap

public OSQLFunctionMap()

Method Details

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

getSyntax

public String getSyntax()

Description copied from interface: OSQLFunction

Returns a convenient 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(Object[] configuredParameters)

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(OCommandContext)

Specified by:

aggregateResults in interface OSQLFunction

Overrides:

aggregateResults in class OSQLFunctionMultiValueAbstract<Map<Object,Object>>

Returns:

true if function aggregate results

getResult

public Map<Object,Object> getResult(OCommandContext ctx)

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 OSQLFunctionMultiValueAbstract<Map<Object,Object>>

Parameters:

ctx - TODO

Returns:

Aggregation result

prepareResult

protected Map<Object,Object> prepareResult(Map<Object,Object> res,
 OCommandContext ctx)

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