ai.grakn.graql.internal.query

Class QueryBuilderImpl

java.lang.Object

ai.grakn.graql.internal.query.QueryBuilderImpl

All Implemented Interfaces:

QueryBuilder

public class QueryBuilderImpl
extends Object
implements QueryBuilder

A starting point for creating queries.

A QueryBuiler is constructed with a GraknGraph. All operations are performed using this graph. The user must explicitly commit or rollback changes after executing queries.

QueryBuilderImpl also provides static methods for creating Vars.

Constructor Summary

Constructors

Constructor and Description
QueryBuilderImpl()
QueryBuilderImpl(GraknGraph graph)

Method Summary

Modifier and Type	Method and Description
ComputeQueryBuilder	compute()
QueryBuilder	infer(boolean infer) Enable or disable inference
InsertQuery	insert(Collection<? extends Var> vars)
InsertQuery	insert(Var... vars)
MatchQuery	match(Collection<? extends Pattern> patterns)
MatchQuery	match(Pattern... patterns)
QueryBuilder	materialise(boolean materialise) Enable or disable materialisation
<T extends Query<?>> T	parse(String queryString)
Pattern	parsePattern(String patternString)
java.util.stream.Stream<Pattern>	parsePatterns(InputStream inputStream)
List<Pattern>	parsePatterns(String patternsString)
<T extends Query<?>> T	parseTemplate(String template, Map<String,Object> data)
void	registerAggregate(String name, java.util.function.Function<List<Object>,Aggregate> aggregateMethod)
void	registerMacro(Macro macro)

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryBuilderImpl

public QueryBuilderImpl()

QueryBuilderImpl

public QueryBuilderImpl(GraknGraph graph)

Method Detail

infer

public QueryBuilder infer(boolean infer)

Description copied from interface: QueryBuilder

Enable or disable inference

Specified by:

infer in interface QueryBuilder

materialise

public QueryBuilder materialise(boolean materialise)

Description copied from interface: QueryBuilder

Enable or disable materialisation

Specified by:

materialise in interface QueryBuilder

match

public MatchQuery match(Pattern... patterns)

Specified by:

match in interface QueryBuilder

Parameters:

patterns - an array of patterns to match in the graph

Returns:

a match query that will find matches of the given patterns

match

public MatchQuery match(Collection<? extends Pattern> patterns)

Specified by:

match in interface QueryBuilder

Parameters:

patterns - a collection of patterns to match in the graph

Returns:

a match query that will find matches of the given patterns

insert

public InsertQuery insert(Var... vars)

Specified by:

insert in interface QueryBuilder

Parameters:

vars - an array of variables to insert into the graph

Returns:

an insert query that will insert the given variables into the graph

insert

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

Specified by:

insert in interface QueryBuilder

Parameters:

vars - a collection of variables to insert into the graph

Returns:

an insert query that will insert the given variables into the graph

compute

public ComputeQueryBuilder compute()

Specified by:

compute in interface QueryBuilder

Returns:

a compute query builder for building analytics query

parsePatterns

public java.util.stream.Stream<Pattern> parsePatterns(InputStream inputStream)

Specified by:

parsePatterns in interface QueryBuilder

Parameters:

inputStream - a stream representing a list of patterns

Returns:

a stream of patterns

parsePatterns

public List<Pattern> parsePatterns(String patternsString)

Specified by:

parsePatterns in interface QueryBuilder

Parameters:

patternsString - a string representing a list of patterns

Returns:

a list of patterns

parsePattern

public Pattern parsePattern(String patternString)

Specified by:

parsePattern in interface QueryBuilder

Parameters:

patternString - a string representing a pattern

Returns:

a pattern

parse

public <T extends Query<?>> T parse(String queryString)

Specified by:

parse in interface QueryBuilder

Parameters:

queryString - a string representing a query

Returns:

a query, the type will depend on the type of query.

parseTemplate

public <T extends Query<?>> T parseTemplate(String template,
                                            Map<String,Object> data)

Specified by:

parseTemplate in interface QueryBuilder

Parameters:

template - a string representing a templated graql query

data - data to use in template

Returns:

a resolved graql query

registerAggregate

public void registerAggregate(String name,
                              java.util.function.Function<List<Object>,Aggregate> aggregateMethod)

Specified by:

registerAggregate in interface QueryBuilder

registerMacro

public void registerMacro(Macro macro)

Specified by:

registerMacro in interface QueryBuilder