com.orientechnologies.orient.core.sql.functions.graph

Class OSQLFunctionDijkstra

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.core.sql.functions.graph.OSQLFunctionPathFinder

com.orientechnologies.orient.core.sql.functions.graph.OSQLFunctionDijkstra

All Implemented Interfaces:

OSQLFunction

public class OSQLFunctionDijkstra
extends OSQLFunctionPathFinder

Dijkstra's algorithm describes how to find the cheapest path from one node to another node in a directed weighted graph.

The first parameter is source record. The second parameter is destination record. The third parameter is a name of property that represents 'weight'.

If property is not defined in edge or is null, distance between vertexes are 0.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Fields inherited from class com.orientechnologies.orient.core.sql.functions.graph.OSQLFunctionPathFinder

context, distance, MIN, paramDestinationVertex, paramDirection, paramSourceVertex, predecessors, unSettledNodes

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
OSQLFunctionDijkstra()

Method Summary

Modifier and Type	Method and Description
LinkedList<OVertex>	execute(Object iThis, OIdentifiable iCurrentRecord, Object iCurrentResult, Object[] iParams, OCommandContext iContext) Process a record.
protected float	getDistance(OVertex node, OVertex target)
String	getSyntax() Returns a convenient SQL String representation of the function.
protected boolean	isVariableEdgeWeight()

Methods inherited from class com.orientechnologies.orient.core.sql.functions.graph.OSQLFunctionPathFinder

aggregateResults, continueTraversing, execute, findMinimalDistances, getMinimum, getNeighbors, getPath, getResult, getShortestDistance, isNotSettled, sumDistances

Methods inherited from class com.orientechnologies.orient.core.sql.functions.math.OSQLFunctionMathAbstract

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, getSingleItem, getSingleProperty, 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

Constructor Detail

OSQLFunctionDijkstra

public OSQLFunctionDijkstra()

Method Detail

execute

public LinkedList<OVertex> 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 convenient SQL String representation of the function.

Example :

  myFunction( param1, param2, [optionalParam3])
 

This text will be used in exception messages.

Returns:

String , never null.

getDistance

protected float getDistance(OVertex node,
                            OVertex target)

Specified by:

getDistance in class OSQLFunctionPathFinder

isVariableEdgeWeight

protected boolean isVariableEdgeWeight()

Overrides:

isVariableEdgeWeight in class OSQLFunctionPathFinder