OSQLFunctionShortestPath (OrientDB 2.2.1-SNAPSHOT API)

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- com.orientechnologies.orient.core.sql.functions.OSQLFunctionAbstract
- - com.orientechnologies.orient.core.sql.functions.OSQLFunctionConfigurableAbstract
  - - com.orientechnologies.orient.core.sql.functions.math.OSQLFunctionMathAbstract
    - - com.orientechnologies.orient.graph.sql.functions.OSQLFunctionShortestPath

All Implemented Interfaces:

OSQLFunction
```
public class OSQLFunctionShortestPath
extends OSQLFunctionMathAbstract
```
Shortest path algorithm to find the shortest path from one node to another node in a directed graph.

Author:

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

Field Summary

Fields
Modifier and Type Field and Description

protected static float DISTANCE

static String NAME

static String PARAM_MAX_DEPTH
- 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 and Description

OSQLFunctionShortestPath()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<ORID>`	`execute(Object iThis, OIdentifiable iCurrentRecord, Object iCurrentResult, Object[] iParams, OCommandContext iContext)` Process a record.
`String`	`getSyntax()` Returns a convinient SQL String representation of the function.
`protected List<ORID>`	`walkLeft(com.orientechnologies.orient.graph.sql.functions.OSQLFunctionShortestPath.OShortestPathContext ctx)`
`protected List<ORID>`	`walkRight(com.orientechnologies.orient.graph.sql.functions.OSQLFunctionShortestPath.OShortestPathContext ctx)`

Methods inherited from class com.orientechnologies.orient.core.sql.functions.math.OSQLFunctionMathAbstract
aggregateResults, getClassWithMorePrecision, getContextValue, shouldMergeDistributedResult

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

Methods inherited from class com.orientechnologies.orient.core.sql.functions.OSQLFunctionAbstract
filterResult, getDistributedStorageId, getMaxParams, getMinParams, getName, getResult, mergeDistributedResult, returnDistributedResult, setResult

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
- PARAM_MAX_DEPTH
```
public static final String PARAM_MAX_DEPTH
```
  See Also:
  
  Constant Field Values
- DISTANCE
```
protected static final float DISTANCE
```
  See Also:
  
  Constant Field Values

Constructor Detail
- OSQLFunctionShortestPath
```
public OSQLFunctionShortestPath()
```

Method Detail

execute
```
public List<ORID> execute(Object iThis,
                          OIdentifiable iCurrentRecord,
                          Object iCurrentResult,
                          Object[] iParams,
                          OCommandContext iContext)
```
Description copied from interface: OSQLFunction

Process a record.

iCurrentRecord - : current record

iCurrentResult - TODO

iParams - : 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 convinient SQL String representation of the function.
Example :
```
  myFunction( param1, param2, [optionalParam3])
 
```
This text will be used in exception messages.
Returns:

String , never null.

walkLeft

protected List<ORID> walkLeft(com.orientechnologies.orient.graph.sql.functions.OSQLFunctionShortestPath.OShortestPathContext ctx)

walkRight

protected List<ORID> walkRight(com.orientechnologies.orient.graph.sql.functions.OSQLFunctionShortestPath.OShortestPathContext ctx)

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2009–2016 Orient Technologies. All rights reserved.