ai.grakn.graql.internal.query.analytics

Class PathQueryImpl

java.lang.Object

ai.grakn.graql.internal.query.analytics.AbstractComputeQuery<Optional<List<Concept>>>

ai.grakn.graql.internal.query.analytics.PathQueryImpl

All Implemented Interfaces:

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

public class PathQueryImpl
extends AbstractComputeQuery<Optional<List<Concept>>>
implements PathQuery

Field Summary

Fields inherited from class ai.grakn.graql.internal.query.analytics.AbstractComputeQuery

connectedComponent, degree

Constructor Summary

Constructors

Constructor and Description
PathQueryImpl(Optional<GraknGraph> graph)

Method Summary

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

Methods inherited from class ai.grakn.graql.internal.query.analytics.AbstractComputeQuery

resultsString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.grakn.graql.Query

resultsString

Constructor Detail

PathQueryImpl

public PathQueryImpl(Optional<GraknGraph> graph)

Method Detail

execute

public Optional<List<Concept>> execute()

Description copied from interface: PathQuery

Execute the query.

Specified by:

execute in interface PathQuery

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

from

public PathQuery from(String sourceId)

Specified by:

from in interface PathQuery

Parameters:

sourceId - the id of the source instance

Returns:

a PathQuery with the source instance set

to

public PathQuery to(String destinationId)

Specified by:

to in interface PathQuery

Parameters:

destinationId - the id of the destination instance

Returns:

a PathQuery with the the destination instance set

isReadOnly

public boolean isReadOnly()

Description copied from interface: Query

Whether this query will modify the graph

Specified by:

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

in

public PathQuery in(String... subTypeNames)

Specified by:

in in interface PathQuery

Specified by:

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

Overrides:

in in class AbstractComputeQuery<Optional<List<Concept>>>

Parameters:

subTypeNames - an array of types to include in the subgraph

Returns:

a ComputeQuery with the subTypeNames set

in

public PathQuery in(Collection<String> subTypeNames)

Specified by:

in in interface PathQuery

Specified by:

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

Overrides:

in in class AbstractComputeQuery<Optional<List<Concept>>>

Parameters:

subTypeNames - a collection of types to include in the subgraph

Returns:

a ComputeQuery with the subTypeNames set

withGraph

public PathQuery withGraph(GraknGraph graph)

Specified by:

withGraph in interface PathQuery

Specified by:

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

Specified by:

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

Overrides:

withGraph in class AbstractComputeQuery<Optional<List<Concept>>>

Parameters:

graph - the graph to execute the compute query on

Returns:

a ComputeQuery with the graph set