com.mware.ge

Class FindPathOptions

java.lang.Object

com.mware.ge.FindPathOptions

public class FindPathOptions
extends Object

Constructor Summary

Constructors

Constructor and Description
FindPathOptions(String sourceVertexId, String destVertexId, int maxHops)
FindPathOptions(String sourceVertexId, String destVertexId, int maxHops, boolean getAnyPath)

Method Summary

Modifier and Type	Method and Description
String	getDestVertexId()
String[]	getExcludedLabels()
String[]	getLabels()
int	getMaxHops()
ProgressCallback	getProgressCallback()
String	getSourceVertexId()
boolean	isGetAnyPath()
FindPathOptions	setExcludedLabels(String... excludedLabels) Edge labels to be excluded from traversal
FindPathOptions	setLabels(String... labels) Edge labels to include, if null any label will be traversed
FindPathOptions	setProgressCallback(ProgressCallback progressCallback)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FindPathOptions

public FindPathOptions(String sourceVertexId,
                       String destVertexId,
                       int maxHops)

Parameters:

sourceVertexId - The source vertex id to start the search from.

destVertexId - The destination vertex id to get to.

maxHops - The maximum number of hops to make before giving up.

FindPathOptions

public FindPathOptions(String sourceVertexId,
                       String destVertexId,
                       int maxHops,
                       boolean getAnyPath)

Parameters:

sourceVertexId - The source vertex id to start the search from.

destVertexId - The destination vertex id to get to.

maxHops - The maximum number of hops to make before giving up.

getAnyPath - Return as soon as the first path is found

Method Detail

getSourceVertexId

public String getSourceVertexId()

getDestVertexId

public String getDestVertexId()

getMaxHops

public int getMaxHops()

getLabels

public String[] getLabels()

isGetAnyPath

public boolean isGetAnyPath()

setLabels

public FindPathOptions setLabels(String... labels)

Edge labels to include, if null any label will be traversed

getExcludedLabels

public String[] getExcludedLabels()

setExcludedLabels

public FindPathOptions setExcludedLabels(String... excludedLabels)

Edge labels to be excluded from traversal

getProgressCallback

public ProgressCallback getProgressCallback()

setProgressCallback

public FindPathOptions setProgressCallback(ProgressCallback progressCallback)

toString

public String toString()

Overrides:

toString in class Object