Package com.arcadedb.query.sql.method.misc

Class SQLMethodRemove

java.lang.Object

com.arcadedb.query.sql.method.misc.AbstractSQLMethod

com.arcadedb.query.sql.method.misc.SQLMethodRemove

All Implemented Interfaces:

SQLMethod, Comparable<SQLMethod>

public class SQLMethodRemove
extends AbstractSQLMethod

Remove the first occurrence of elements from a collection.

Author:

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

See Also:

SQLMethodRemoveAll

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME

Constructor Summary

Constructors

Constructor	Description
SQLMethodRemove()

Method Summary

Modifier and Type	Method	Description
Object	execute(Object self, Identifiable currentRecord, CommandContext context, Object result, Object[] params)	Process a record.
String	getSyntax()	Returns a convenient SQL String representation of the method.

Methods inherited from class com.arcadedb.query.sql.method.misc.AbstractSQLMethod

compareTo, evaluateParameters, getMaxParams, getMinParams, getName, getParameterValue, 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

SQLMethodRemove

public SQLMethodRemove()

Method Detail

execute

public Object execute(Object self,
                      Identifiable currentRecord,
                      CommandContext context,
                      Object result,
                      Object[] params)

Description copied from interface: SQLMethod

Process a record.

Parameters:

self - current object

currentRecord - : current record

context - execution context

result - : field value

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

Returns:

evaluation result

getSyntax

public String getSyntax()

Description copied from interface: SQLMethod

Returns a convenient SQL String representation of the method.

Example :

  field.myMethod( param1, param2, [optionalParam3])
 

This text will be used in exception messages.

Specified by:

getSyntax in interface SQLMethod

Overrides:

getSyntax in class AbstractSQLMethod

Returns:

String , never null.