Package com.orientechnologies.orient.graph.sql.functions

Class OSQLFunctionLabel

java.lang.Object

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

com.orientechnologies.orient.core.sql.functions.OSQLFunctionConfigurableAbstract

com.orientechnologies.orient.graph.sql.functions.OSQLFunctionLabel

All Implemented Interfaces:

OSQLFunction

public class OSQLFunctionLabel
extends OSQLFunctionConfigurableAbstract

Hi-level function that return the label for both edges and vertices. The label could be bound to the class name.

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.OSQLFunctionConfigurableAbstract

configuredParameters

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

maxParams, minParams, name

Constructor Summary

Constructors

Constructor	Description
OSQLFunctionLabel()

Method Summary

Modifier and Type	Method	Description
Object	execute(Object iThis, OIdentifiable iCurrentRecord, Object iCurrentResult, Object[] iParameters, 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.OSQLFunctionConfigurableAbstract

config, toString

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

aggregateResults, filterResult, getDistributedStorageId, getMaxParams, getMinParams, getName, getResult, getSingleItem, getSingleProperty, mergeDistributedResult, returnDistributedResult, setResult, shouldMergeDistributedResult

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

OSQLFunctionLabel

public OSQLFunctionLabel()

Method Details

execute

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

Description copied from interface: OSQLFunction

Process a record.

iCurrentRecord - : current record

iCurrentResult - TODO

iParameters - : 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.