SQLMethod (arcadedb-engine 22.1.2 API)

All Superinterfaces:

Comparable<SQLMethod>

All Known Implementing Classes:

AbstractSQLMethod, SQLMethodAppend, SQLMethodAsBoolean, SQLMethodAsDate, SQLMethodAsDateTime, SQLMethodAsDecimal, SQLMethodAsFloat, SQLMethodAsInteger, SQLMethodAsList, SQLMethodAsLong, SQLMethodAsMap, SQLMethodAsSet, SQLMethodAsString, SQLMethodCharAt, SQLMethodConvert, SQLMethodField, SQLMethodFormat, SQLMethodHash, SQLMethodIndexOf, SQLMethodJavaType, SQLMethodKeys, SQLMethodLastIndexOf, SQLMethodLeft, SQLMethodLength, SQLMethodNormalize, SQLMethodPrefix, SQLMethodRemove, SQLMethodRemoveAll, SQLMethodReplace, SQLMethodRight, SQLMethodSize, SQLMethodSplit, SQLMethodSubString, SQLMethodToJSON, SQLMethodToLowerCase, SQLMethodToUpperCase, SQLMethodTrim, SQLMethodType
```
public interface SQLMethod
extends Comparable<SQLMethod>
```
Methods can be used on various objects with different number of arguments. SQL syntax: <object_name>.<method_name>([parameters])

Author:

Johann Sorel (Geomatys)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`evaluateParameters()`
`Object`	`execute(Object iThis, Identifiable iCurrentRecord, CommandContext iContext, Object ioResult, Object[] iParams)`	Process a record.
`int`	`getMaxParams()`
`int`	`getMinParams()`
`String`	`getName()`
`String`	`getSyntax()`	Returns a convenient SQL String representation of the method.

Methods inherited from interface java.lang.Comparable
compareTo

- Method Detail
  - getName
```
String getName()
```
    Returns:
    
    method name
  - getSyntax
```
String getSyntax()
```
    Returns a convenient 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,
               Identifiable iCurrentRecord,
               CommandContext iContext,
               Object ioResult,
               Object[] iParams)
```
    Process a record.
    
    Parameters:
    
    iThis - current object
    
    iCurrentRecord - : current record
    
    iContext - execution context
    
    ioResult - : field value
    
    iParams - : function parameters, number is ensured to be within minParams and maxParams.
    
    Returns:
    
    evaluation result
  - evaluateParameters
```
boolean evaluateParameters()
```