Class SQLFunctionShortestPath
- java.lang.Object
-
- com.arcadedb.query.sql.function.SQLFunctionAbstract
-
- com.arcadedb.query.sql.function.SQLFunctionConfigurableAbstract
-
- com.arcadedb.query.sql.function.math.SQLFunctionMathAbstract
-
- com.arcadedb.query.sql.function.graph.SQLFunctionShortestPath
-
- All Implemented Interfaces:
SQLFunction
public class SQLFunctionShortestPath extends SQLFunctionMathAbstract
Shortest path algorithm to find the shortest path from one node to another node in a directed graph.- Author:
- Luca Garulli (l.garulli--(at)--gmail.com)
-
-
Field Summary
Fields Modifier and Type Field Description static String
NAME
static String
PARAM_MAX_DEPTH
-
Fields inherited from class com.arcadedb.query.sql.function.SQLFunctionConfigurableAbstract
configuredParameters
-
Fields inherited from class com.arcadedb.query.sql.function.SQLFunctionAbstract
name
-
-
Constructor Summary
Constructors Constructor Description SQLFunctionShortestPath()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description List<RID>
execute(Object iThis, Identifiable iCurrentRecord, Object iCurrentResult, Object[] iParams, CommandContext iContext)
Process a record.String
getSyntax()
Returns a convenient SQL String representation of the function.protected List<RID>
walkLeft(com.arcadedb.query.sql.function.graph.SQLFunctionShortestPath.OShortestPathContext context)
protected List<RID>
walkRight(com.arcadedb.query.sql.function.graph.SQLFunctionShortestPath.OShortestPathContext context)
-
Methods inherited from class com.arcadedb.query.sql.function.math.SQLFunctionMathAbstract
aggregateResults, getClassWithMorePrecision, getContextValue
-
Methods inherited from class com.arcadedb.query.sql.function.SQLFunctionConfigurableAbstract
config, toString
-
Methods inherited from class com.arcadedb.query.sql.function.SQLFunctionAbstract
getName, getResult
-
-
-
-
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
-
-
Method Detail
-
execute
public List<RID> execute(Object iThis, Identifiable iCurrentRecord, Object iCurrentResult, Object[] iParams, CommandContext iContext)
Description copied from interface:SQLFunction
Process a record.iCurrentRecord
- : current recordiCurrentResult
- TODOiParams
- : 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:SQLFunction
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.
-
walkLeft
protected List<RID> walkLeft(com.arcadedb.query.sql.function.graph.SQLFunctionShortestPath.OShortestPathContext context)
-
-