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

Class OSQLFunctionPathFinder

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

All Implemented Interfaces:

OSQLFunction

Direct Known Subclasses:

OSQLFunctionDijkstra

public abstract class OSQLFunctionPathFinder
extends OSQLFunctionMathAbstract

Abstract class to find paths between nodes.

Author:

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

Field Summary

Fields

Modifier and Type	Field	Description
protected OCommandContext	context
protected OrientBaseGraph	db
protected Map<ORID,Float>	distance
protected static final float	MIN
protected OrientVertex	paramDestinationVertex
protected com.tinkerpop.blueprints.Direction	paramDirection
protected OrientVertex	paramSourceVertex
protected Map<ORID,OrientVertex>	predecessors
protected Set<OrientVertex>	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	Description
OSQLFunctionPathFinder(String iName, int iMinParams, int iMaxParams)

Method Summary

Modifier and Type	Method	Description
boolean	aggregateResults()	A function can make calculation on several records before returning a result.
protected boolean	continueTraversing()
protected LinkedList<OrientVertex>	execute(OCommandContext iContext)
protected void	findMinimalDistances(OrientVertex node)
protected abstract float	getDistance(OrientVertex node, OrientVertex target)
protected OrientVertex	getMinimum(Set<OrientVertex> vertexes)
protected Set<OrientVertex>	getNeighbors(com.tinkerpop.blueprints.Vertex node)
LinkedList<OrientVertex>	getPath()
Object	getResult()	Only called when function aggregates results after all records have been passed to the function.
protected float	getShortestDistance(OrientVertex destination)
protected boolean	isNotSettled(OrientVertex vertex)
protected boolean	isVariableEdgeWeight()
protected float	sumDistances(float iDistance1, float iDistance2)

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

Methods inherited from interface com.orientechnologies.orient.core.sql.functions.OSQLFunction

execute, getSyntax

Field Details

db

protected OrientBaseGraph db

unSettledNodes

protected Set<OrientVertex> unSettledNodes

predecessors

protected Map<ORID,OrientVertex> predecessors

distance

protected Map<ORID,Float> distance

paramSourceVertex

protected OrientVertex paramSourceVertex

paramDestinationVertex

protected OrientVertex paramDestinationVertex

paramDirection

protected com.tinkerpop.blueprints.Direction paramDirection

context

protected OCommandContext context

MIN

protected static final float MIN

See Also:

• Constant Field Values

Constructor Details

OSQLFunctionPathFinder

public OSQLFunctionPathFinder(String iName,
 int iMinParams,
 int iMaxParams)

Method Details

execute

protected LinkedList<OrientVertex> execute(OCommandContext iContext)

isVariableEdgeWeight

protected boolean isVariableEdgeWeight()

getPath

public LinkedList<OrientVertex> getPath()

aggregateResults

public boolean aggregateResults()

Description copied from interface: OSQLFunction

A function can make calculation on several records before returning a result.

Example of such function : sum, count, max, min ...

The final result of the aggregation is obtain by calling OSQLFunction.getResult()

Specified by:

aggregateResults in interface OSQLFunction

Overrides:

aggregateResults in class OSQLFunctionMathAbstract

Returns:

true if function aggregate results

getResult

public Object getResult()

Description copied from interface: OSQLFunction

Only called when function aggregates results after all records have been passed to the function.

Specified by:

getResult in interface OSQLFunction

Overrides:

getResult in class OSQLFunctionAbstract

Returns:

Aggregation result

findMinimalDistances

protected void findMinimalDistances(OrientVertex node)

getNeighbors

protected Set<OrientVertex> getNeighbors(com.tinkerpop.blueprints.Vertex node)

getMinimum

protected OrientVertex getMinimum(Set<OrientVertex> vertexes)

isNotSettled

protected boolean isNotSettled(OrientVertex vertex)

continueTraversing

protected boolean continueTraversing()

getShortestDistance

protected float getShortestDistance(OrientVertex destination)

sumDistances

protected float sumDistances(float iDistance1,
 float iDistance2)

getDistance

protected abstract float getDistance(OrientVertex node,
 OrientVertex target)