ai.grakn.graql.internal.query.match

Interface MatchQueryInternal

All Superinterfaces:

Iterable<Map<String,Concept>>, MatchQuery, MatchQueryAdmin, Query<List<Map<String,Concept>>>, Streamable<Map<String,Concept>>

All Known Implementing Classes:

AtomicMatchQuery, AtomicQuery, MatchQueryBase, Query, ReasonerMatchQuery

public interface MatchQueryInternal
extends MatchQueryAdmin

Method Summary

Modifier and Type	Method and Description
default <S> AggregateQuery<S>	aggregate(Aggregate<? super Map<String,Concept>,S> aggregate) Aggregate results of a query.
default AskQuery	ask()
static String	colorKeyword(String keyword)
static String	colorType(String type)
default DeleteQuery	delete(Collection<? extends Var> deleters)
default DeleteQuery	delete(String... names)
default MatchQuery	distinct() remove any duplicate results from the query
default java.util.stream.Stream<Concept>	get(String name)
default InsertQuery	insert(Collection<? extends Var> vars)
default boolean	isReadOnly() Whether this query will modify the graph
default MatchQuery	limit(long limit)
default MatchQuery	offset(long offset)
default MatchQuery	orderBy(String varName, Order order) Order the results by degree
default java.util.stream.Stream<String>	resultsString(Printer printer) Execute the query and return a human-readable stream of results
default MatchQuery	select(Set<String> names)
default java.util.stream.Stream<Map<String,Concept>>	stream()
java.util.stream.Stream<Map<String,Concept>>	stream(Optional<GraknGraph> graph) Execute the query using the given graph.
default MatchQuery	withGraph(GraknGraph graph)

Methods inherited from interface ai.grakn.graql.admin.MatchQueryAdmin

admin, getGraph, getPattern, getSelectedNames, getTypes, getTypes

Methods inherited from interface ai.grakn.graql.MatchQuery

delete, execute, insert, orderBy, select

Methods inherited from interface ai.grakn.graql.Streamable

iterator, parallelStream

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

colorKeyword

static String colorKeyword(String keyword)

Parameters:

keyword - a keyword to color-code using ANSI colors

Returns:

the keyword, color-coded

colorType

static String colorType(String type)

Parameters:

type - a type to color-code using ANSI colors

Returns:

the type, color-coded

resultsString

default java.util.stream.Stream<String> resultsString(Printer printer)

Description copied from interface: Query

Execute the query and return a human-readable stream of results

Specified by:

resultsString in interface Query<List<Map<String,Concept>>>

isReadOnly

default boolean isReadOnly()

Description copied from interface: Query

Whether this query will modify the graph

Specified by:

isReadOnly in interface Query<List<Map<String,Concept>>>

stream

java.util.stream.Stream<Map<String,Concept>> stream(Optional<GraknGraph> graph)

Execute the query using the given graph.

Parameters:

graph - the graph to use to execute the query

Returns:

a stream of results

stream

default java.util.stream.Stream<Map<String,Concept>> stream()

Specified by:

stream in interface Streamable<Map<String,Concept>>

Returns:

a stream of elements

withGraph

default MatchQuery withGraph(GraknGraph graph)

Specified by:

withGraph in interface MatchQuery

Specified by:

withGraph in interface Query<List<Map<String,Concept>>>

Parameters:

graph - the graph to execute the query on

Returns:

a new MatchQuery with the graph set

limit

default MatchQuery limit(long limit)

Specified by:

limit in interface MatchQuery

Parameters:

limit - the maximum number of results the query should return

Returns:

a new MatchQuery with the limit set

offset

default MatchQuery offset(long offset)

Specified by:

offset in interface MatchQuery

Parameters:

offset - the number of results to skip

Returns:

a new MatchQuery with the offset set

distinct

default MatchQuery distinct()

Description copied from interface: MatchQuery

remove any duplicate results from the query

Specified by:

distinct in interface MatchQuery

Returns:

a new MatchQuery without duplicate results

aggregate

default <S> AggregateQuery<S> aggregate(Aggregate<? super Map<String,Concept>,S> aggregate)

Description copied from interface: MatchQuery

Aggregate results of a query.

Specified by:

aggregate in interface MatchQuery

Type Parameters:

S - the type of the aggregate result

Parameters:

aggregate - the aggregate operation to apply

Returns:

a query that will yield the aggregate result

select

default MatchQuery select(Set<String> names)

Specified by:

select in interface MatchQuery

Parameters:

names - a set of variable names to select

Returns:

a new MatchQuery that selects the given variables

get

default java.util.stream.Stream<Concept> get(String name)

Specified by:

get in interface MatchQuery

Parameters:

name - a variable name to get

Returns:

a stream of concepts

ask

default AskQuery ask()

Specified by:

ask in interface MatchQuery

Returns:

an ask query that will return true if any matches are found

insert

default InsertQuery insert(Collection<? extends Var> vars)

Specified by:

insert in interface MatchQuery

Parameters:

vars - a collection of variables to insert for each result of this match query

Returns:

an insert query that will insert the given variables for each result of this match query

delete

default DeleteQuery delete(String... names)

Specified by:

delete in interface MatchQuery

Parameters:

names - an array of variable names to delete for each result of this match query

Returns:

a delete query that will delete the given variable names for each result of this match query

delete

default DeleteQuery delete(Collection<? extends Var> deleters)

Specified by:

delete in interface MatchQuery

Parameters:

deleters - a collection of variables stating what properties to delete for each result of this match query

Returns:

a delete query that will delete the given properties for each result of this match query

orderBy

default MatchQuery orderBy(String varName,
                           Order order)

Description copied from interface: MatchQuery

Order the results by degree

Specified by:

orderBy in interface MatchQuery

Parameters:

varName - the variable name to order the results by

order - the ordering to use

Returns:

a new MatchQuery with the given ordering