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

Class OSQLMethodExclude

java.lang.Object

com.orientechnologies.orient.core.sql.method.misc.OAbstractSQLMethod

com.orientechnologies.orient.core.sql.functions.misc.OSQLMethodExclude

All Implemented Interfaces:

OSQLMethod, Comparable<OSQLMethod>

public class OSQLMethodExclude
extends OAbstractSQLMethod

Filter the content by excluding only some fields. If the content is a document, then creates a copy without the excluded fields. If it's a collection of documents it acts against on each single entry.

Syntax:

 exclude(<field|value|expression> [,<field-name>]* )
 

Examples:

 SELECT exclude(roles, 'permissions') FROM OUser
 

Author:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
OSQLMethodExclude()

Method Summary

Modifier and Type	Method	Description
Object	execute(Object iThis, OIdentifiable iCurrentRecord, OCommandContext iContext, Object ioResult, Object[] iParams)	Process a record.
String	getSyntax()	Returns a convinient SQL String representation of the method.

Methods inherited from class com.orientechnologies.orient.core.sql.method.misc.OAbstractSQLMethod

compareTo, getMaxParams, getMinParams, getName, getParameterValue, toString

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

OSQLMethodExclude

public OSQLMethodExclude()

Method Details

getSyntax

public String getSyntax()

Description copied from interface: OSQLMethod

Returns a convinient 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 OSQLMethod

Overrides:

getSyntax in class OAbstractSQLMethod

Returns:

String , never null.

execute

public Object execute(Object iThis,
 OIdentifiable iCurrentRecord,
 OCommandContext iContext,
 Object ioResult,
 Object[] iParams)

Description copied from interface: OSQLMethod

Process a record.

iCurrentRecord - : current record

iContext - execution context

ioResult - : field value

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

Returns:

evaluation result