Package com.orientechnologies.orient.core.sql.method

Interface OSQLMethod

All Superinterfaces:

Comparable<OSQLMethod>

All Known Implementing Classes:

OAbstractSQLMethod, OSQLMethodAppend, OSQLMethodAsBoolean, OSQLMethodAsDate, OSQLMethodAsDateTime, OSQLMethodAsDecimal, OSQLMethodAsFloat, OSQLMethodAsInteger, OSQLMethodAsList, OSQLMethodAsLong, OSQLMethodAsMap, OSQLMethodAsSet, OSQLMethodAsString, OSQLMethodBeforeUpdate, OSQLMethodCharAt, OSQLMethodConvert, OSQLMethodCurrent, OSQLMethodExclude, OSQLMethodField, OSQLMethodFormat, OSQLMethodFromJSON, OSQLMethodHash, OSQLMethodInclude, OSQLMethodIndexOf, OSQLMethodJavaType, OSQLMethodKeys, OSQLMethodLastIndexOf, OSQLMethodLeft, OSQLMethodLength, OSQLMethodMultiValue, OSQLMethodNext, OSQLMethodNormalize, OSQLMethodPrefix, OSQLMethodRemove, OSQLMethodRemoveAll, OSQLMethodReplace, OSQLMethodReset, OSQLMethodRight, OSQLMethodSize, OSQLMethodSplit, OSQLMethodSubString, OSQLMethodToJSON, OSQLMethodToLowerCase, OSQLMethodToUpperCase, OSQLMethodTrim, OSQLMethodType, OSQLMethodValues

public interface OSQLMethod
extends Comparable<OSQLMethod>

Methods can be used on various objects with different number of arguments. SQL syntax : .([parameters])

Author:

Johann Sorel (Geomatys)

Method Summary

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

Methods inherited from interface java.lang.Comparable

compareTo

Method Details

getName

String getName()

Returns:

method name

getSyntax

String getSyntax()

Returns a convinient SQL String representation of the method.

Example :

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

This text will be used in exception messages.

Returns:

String , never null.

getMinParams

int getMinParams()

Returns:

minimum number of arguments requiered by this method

getMaxParams

int getMaxParams()

Returns:

maximum number of arguments requiered by this method

execute

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

Process a record.

Parameters:

iThis -

iCurrentRecord - : current record

iContext - execution context

ioResult - : field value

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

Returns:

evaluation result