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

Class OSQLFunctionFormat

java.lang.Object

com.orientechnologies.orient.core.sql.functions.OSQLFunctionAbstract

com.orientechnologies.orient.core.sql.functions.text.OSQLFunctionFormat

All Implemented Interfaces:

OSQLFunction

public class OSQLFunctionFormat
extends OSQLFunctionAbstract

Formats content.

Author:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from class com.orientechnologies.orient.core.sql.functions.OSQLFunctionAbstract

maxParams, minParams, name

Constructor Summary

Constructors

Constructor	Description
OSQLFunctionFormat()

Method Summary

Modifier and Type	Method	Description
Object	execute(Object iThis, OIdentifiable iCurrentRecord, Object iCurrentResult, Object[] params, OCommandContext iContext)	Process a record.
String	getSyntax()	Returns a convenient SQL String representation of the function.

Methods inherited from class com.orientechnologies.orient.core.sql.functions.OSQLFunctionAbstract

aggregateResults, config, filterResult, getDatabase, getDistributedStorageId, getMaxParams, getMinParams, getName, getResult, getSingleItem, getSingleProperty, mergeDistributedResult, returnDistributedResult, setResult, shouldMergeDistributedResult, 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

OSQLFunctionFormat

public OSQLFunctionFormat()

Method Details

execute

public Object execute(Object iThis,
 OIdentifiable iCurrentRecord,
 Object iCurrentResult,
 Object[] params,
 OCommandContext iContext)

Description copied from interface: OSQLFunction

Process a record.

iCurrentRecord - : current record

iCurrentResult - TODO

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

iContext - : object calling this function

Returns:

function result, can be null. Special cases : can be null if function aggregate results, can be null if function filter results : this mean result is excluded

getSyntax

public String getSyntax()

Description copied from interface: OSQLFunction

Returns a convenient SQL String representation of the function.

Example :

  myFunction( param1, param2, [optionalParam3])
 

This text will be used in exception messages.

Returns:

String , never null.