Package com.arcadedb.query.sql.function.coll

Class SQLFunctionSet

java.lang.Object

com.arcadedb.query.sql.function.SQLFunctionAbstract

com.arcadedb.query.sql.function.SQLFunctionConfigurableAbstract

com.arcadedb.query.sql.function.coll.SQLFunctionMultiValueAbstract<Set<Object>>

com.arcadedb.query.sql.function.coll.SQLFunctionSet

All Implemented Interfaces:

SQLFunction

public class SQLFunctionSet
extends SQLFunctionMultiValueAbstract<Set<Object>>

This operator add an item in a set. The set doesn't accept duplicates, so adding multiple times the same value has no effect: the value is contained only once.

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

Method Summary

Modifier and Type	Method	Description
Object	execute(Object iThis, Identifiable iCurrentRecord, Object iCurrentResult, Object[] iParams, CommandContext iContext)	Process a record.
String	getSyntax()	Returns a convenient SQL String representation of the function.

Methods inherited from class com.arcadedb.query.sql.function.coll.SQLFunctionMultiValueAbstract

aggregateResults, getResult

Methods inherited from class com.arcadedb.query.sql.function.SQLFunctionConfigurableAbstract

config, toString

Methods inherited from class com.arcadedb.query.sql.function.SQLFunctionAbstract

getName

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

SQLFunctionSet

public SQLFunctionSet()

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 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: 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.