OSQLFunctionMove (OrientDB 2.2.1-SNAPSHOT API)

java.lang.Object
- com.orientechnologies.orient.core.sql.functions.OSQLFunctionAbstract
- - com.orientechnologies.orient.core.sql.functions.OSQLFunctionConfigurableAbstract
  - - com.orientechnologies.orient.graph.sql.functions.OSQLFunctionMove

All Implemented Interfaces:

OSQLFunction

Direct Known Subclasses:

OSQLFunctionBoth, OSQLFunctionBothE, OSQLFunctionBothV, OSQLFunctionInE, OSQLFunctionInV, OSQLFunctionMoveFiltered, OSQLFunctionOutE, OSQLFunctionOutV
```
public abstract class OSQLFunctionMove
extends OSQLFunctionConfigurableAbstract
```
Hi-level function to move inside a graph. Return the incoming connections. If the current element is a vertex, then will be returned edges otherwise vertices.

Author:

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

Field Summary

Fields
Modifier and Type Field and Description

static 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

Fields
Modifier and Type	Field and Description
`static String`	`NAME`

Constructor Summary

Constructors
Constructor and Description

OSQLFunctionMove()

OSQLFunctionMove(String iName, int iMin, int iMax)

Constructors
Constructor and Description
`OSQLFunctionMove()`
`OSQLFunctionMove(String iName, int iMin, int iMax)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected Object`	`e2v(OrientBaseGraph graph, OIdentifiable iRecord, com.tinkerpop.blueprints.Direction iDirection, String[] iLabels)`
`Object`	`execute(Object iThis, OIdentifiable iCurrentRecord, Object iCurrentResult, Object[] iParameters, OCommandContext iContext)` Process a record.
`String`	`getSyntax()` Returns a convinient SQL String representation of the function.
`protected abstract Object`	`move(OrientBaseGraph graph, OIdentifiable iRecord, String[] iLabels)`
`protected Object`	`v2e(OrientBaseGraph graph, OIdentifiable iRecord, com.tinkerpop.blueprints.Direction iDirection, String[] iLabels)`
`protected Object`	`v2v(OrientBaseGraph graph, OIdentifiable iRecord, com.tinkerpop.blueprints.Direction iDirection, String[] iLabels)`

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, mergeDistributedResult, returnDistributedResult, setResult, shouldMergeDistributedResult

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

OSQLFunctionMove
```
public OSQLFunctionMove()
```

OSQLFunctionMove

public OSQLFunctionMove(String iName,
                        int iMin,
                        int iMax)

Method Detail

move

protected abstract Object move(OrientBaseGraph graph,
                               OIdentifiable iRecord,
                               String[] iLabels)

getSyntax
```
public String getSyntax()
```
Description copied from interface: OSQLFunction
Returns a convinient SQL String representation of the function.
Example :
```
  myFunction( param1, param2, [optionalParam3])
 
```
This text will be used in exception messages.
Returns:

String , never null.

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

v2v

protected Object v2v(OrientBaseGraph graph,
                     OIdentifiable iRecord,
                     com.tinkerpop.blueprints.Direction iDirection,
                     String[] iLabels)

v2e

protected Object v2e(OrientBaseGraph graph,
                     OIdentifiable iRecord,
                     com.tinkerpop.blueprints.Direction iDirection,
                     String[] iLabels)

e2v

protected Object e2v(OrientBaseGraph graph,
                     OIdentifiable iRecord,
                     com.tinkerpop.blueprints.Direction iDirection,
                     String[] iLabels)

Class OSQLFunctionMove

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

NAME

Constructor Detail

OSQLFunctionMove

OSQLFunctionMove

Method Detail

move

getSyntax

execute

v2v

v2e

e2v