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

Class OSQLFunctionList

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<List<Object>>

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

All Implemented Interfaces:

OSQLFunction

public class OSQLFunctionList
extends OSQLFunctionMultiValueAbstract<List<Object>>

This operator add an item in a list. The list accepts duplicates.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static 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 and Description
OSQLFunctionList()

Method Summary

Modifier and Type	Method and Description
boolean	aggregateResults(Object[] configuredParameters)
Object	execute(Object iThis, OIdentifiable iCurrentRecord, Object iCurrentResult, Object[] iParams, OCommandContext iContext) Process a record.
List<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
protected List<Object>	prepareResult(List<Object> res)

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

aggregateResults, 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, getDistributedStorageId, getMaxParams, getMinParams, getName, returnDistributedResult, setResult

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

OSQLFunctionList

public OSQLFunctionList()

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

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

getResult

public List<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 OSQLFunctionMultiValueAbstract<List<Object>>

Returns:

Aggregation result

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

prepareResult

protected List<Object> prepareResult(List<Object> res)