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

Class SQLMethodLeft

java.lang.Object

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

com.arcadedb.query.sql.method.misc.SQLMethodLeft

All Implemented Interfaces:

SQLMethod, Comparable<SQLMethod>

public class SQLMethodLeft
extends AbstractSQLMethod

Returns the first characters from the beginning of the string.

Author:

Johann Sorel (Geomatys), Luca Garulli (l.garulli--(at)--gmail.com)

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME

Constructor Summary

Constructors

Constructor	Description
SQLMethodLeft()

Method Summary

Modifier and Type	Method	Description
Object	execute(Object iThis, Identifiable iCurrentRecord, CommandContext iContext, Object ioResult, Object[] iParams)	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

SQLMethodLeft

public SQLMethodLeft()

Method Detail

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.

execute

public Object execute(Object iThis,
                      Identifiable iCurrentRecord,
                      CommandContext iContext,
                      Object ioResult,
                      Object[] iParams)

Description copied from interface: SQLMethod

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