Class SQLFunctionMap
- java.lang.Object
-
- com.arcadedb.query.sql.function.SQLFunctionAbstract
-
- com.arcadedb.query.sql.function.SQLFunctionConfigurableAbstract
-
- com.arcadedb.query.sql.function.coll.SQLFunctionMultiValueAbstract<Map<String,Object>>
-
- com.arcadedb.query.sql.function.coll.SQLFunctionMap
-
- All Implemented Interfaces:
SQLFunction
public class SQLFunctionMap extends SQLFunctionMultiValueAbstract<Map<String,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)--gmail.com)
-
-
Field Summary
Fields Modifier and Type Field Description static String
NAME
-
Fields inherited from class com.arcadedb.query.sql.function.coll.SQLFunctionMultiValueAbstract
context
-
Fields inherited from class com.arcadedb.query.sql.function.SQLFunctionConfigurableAbstract
configuredParameters
-
Fields inherited from class com.arcadedb.query.sql.function.SQLFunctionAbstract
name
-
-
Constructor Summary
Constructors Constructor Description SQLFunctionMap()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
aggregateResults(Object[] configuredParameters)
Object
execute(Object iThis, Identifiable iCurrentRecord, Object iCurrentResult, Object[] iParams, CommandContext iContext)
Process a record.Map<String,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.protected Map<String,Object>
prepareResult(Map<String,Object> res)
-
Methods inherited from class com.arcadedb.query.sql.function.coll.SQLFunctionMultiValueAbstract
aggregateResults
-
Methods inherited from class com.arcadedb.query.sql.function.SQLFunctionConfigurableAbstract
config, toString
-
Methods inherited from class com.arcadedb.query.sql.function.SQLFunctionAbstract
getName
-
-
-
-
Field Detail
-
NAME
public static final String NAME
- See Also:
- Constant Field Values
-
-
Method Detail
-
execute
public Object execute(Object iThis, Identifiable iCurrentRecord, Object iCurrentResult, Object[] iParams, CommandContext iContext)
Description copied from interface:SQLFunction
Process a record.iCurrentRecord
- : current recordiCurrentResult
- TODOiParams
- : 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:SQLFunction
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)
-
getResult
public Map<String,Object> getResult()
Description copied from interface:SQLFunction
Only called when function aggregates results after all records have been passed to the function.- Specified by:
getResult
in interfaceSQLFunction
- Overrides:
getResult
in classSQLFunctionMultiValueAbstract<Map<String,Object>>
- Returns:
- Aggregation result
-
-