ai.grakn.graql.analytics

Interface ClusterQuery<T>

All Superinterfaces:

ComputeQuery<T>, Query<T>

public interface ClusterQuery<T>
extends ComputeQuery<T>

Compute the connected components in the subgraph.

Method Summary

Modifier and Type	Method and Description
ClusterQuery<T>	clusterSize(long clusterSize)
ClusterQuery<T>	in(Collection<String> subTypeNames)
ClusterQuery<T>	in(String... subTypeNames)
ClusterQuery<Map<String,Set<String>>>	members() Return the instances in each cluster after executing the query.
ClusterQuery<T>	persist() Persist the result in the graph after executing the query.
ClusterQuery<T>	persist(String resourceTypeName) Persist the result in the graph after executing the query.
ClusterQuery<T>	withGraph(GraknGraph graph)

Methods inherited from interface ai.grakn.graql.Query

execute, isReadOnly, resultsString

Method Detail

members

ClusterQuery<Map<String,Set<String>>> members()

Return the instances in each cluster after executing the query. By default, the size of each cluster is returned after executing the query.

Returns:

a ClusterQuery with members flag set

persist

ClusterQuery<T> persist()

Persist the result in the graph after executing the query. Be default, the cluster label is saved as a resource of the vertex, with resource type name "cluster".

Returns:

a ClusterQuery with persist flag set

persist

ClusterQuery<T> persist(String resourceTypeName)

Persist the result in the graph after executing the query. The cluster label is saved as a resource of the vertex.

Parameters:

resourceTypeName - the name of the resource type to save the cluster label

Returns:

a ClusterQuery with persist flag and customised resource type name set

clusterSize

ClusterQuery<T> clusterSize(long clusterSize)

Parameters:

clusterSize - the size of the clusters returned and/or persisted

Returns:

a ClusterQuery with cluster set

in

ClusterQuery<T> in(String... subTypeNames)

Specified by:

in in interface ComputeQuery<T>

Parameters:

subTypeNames - an array of types to include in the subgraph

Returns:

a ClusterQuery with the subTypeNames set

in

ClusterQuery<T> in(Collection<String> subTypeNames)

Specified by:

in in interface ComputeQuery<T>

Parameters:

subTypeNames - a collection of types to include in the subgraph

Returns:

a ClusterQuery with the subTypeNames set

withGraph

ClusterQuery<T> withGraph(GraknGraph graph)

Specified by:

withGraph in interface ComputeQuery<T>

Specified by:

withGraph in interface Query<T>

Parameters:

graph - the graph to execute the query on

Returns:

a ClusterQuery with the graph set