ai.grakn.graql.analytics

Interface PathQuery

All Superinterfaces:

ComputeQuery<Optional<List<Concept>>>, Query<Optional<List<Concept>>>

public interface PathQuery
extends ComputeQuery<Optional<List<Concept>>>

Compute the shortest path between two instances.

Method Summary

Modifier and Type	Method and Description
Optional<List<Concept>>	execute() Execute the query.
PathQuery	from(ConceptId sourceId)
PathQuery	in(Collection<String> subTypeNames)
PathQuery	in(String... subTypeNames)
PathQuery	to(ConceptId destinationId)
PathQuery	withGraph(GraknGraph graph)

Methods inherited from interface ai.grakn.graql.Query

isReadOnly, resultsString

Method Detail

from

PathQuery from(ConceptId sourceId)

Parameters:

sourceId - the id of the source instance

Returns:

a PathQuery with the source instance set

to

PathQuery to(ConceptId destinationId)

Parameters:

destinationId - the id of the destination instance

Returns:

a PathQuery with the the destination instance set

in

PathQuery in(String... subTypeNames)

Specified by:

in in interface ComputeQuery<Optional<List<Concept>>>

Parameters:

subTypeNames - an array of types to include in the subgraph

Returns:

a PathQuery with the subTypeNames set

in

PathQuery in(Collection<String> subTypeNames)

Specified by:

in in interface ComputeQuery<Optional<List<Concept>>>

Parameters:

subTypeNames - a collection of types to include in the subgraph

Returns:

a PathQuery with the subTypeNames set

execute

Optional<List<Concept>> execute()

Execute the query.

Specified by:

execute in interface Query<Optional<List<Concept>>>

Returns:

the list of instances along the path if a path exists, otherwise an empty Optional instance

withGraph

PathQuery withGraph(GraknGraph graph)

Specified by:

withGraph in interface ComputeQuery<Optional<List<Concept>>>

Specified by:

withGraph in interface Query<Optional<List<Concept>>>

Parameters:

graph - the graph to execute the query on

Returns:

a PathQuery with the graph set