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 GraknTx. All operations are performed using this transaction. The user must explicitly commit or rollback changes after executing queries.

QueryBuilderImpl also provides static methods for creating Vars.

Author:

Felix Chapman

Constructor Summary

Constructors

Constructor and Description
QueryBuilderImpl()
QueryBuilderImpl(GraknTx tx)

Method Summary

Modifier and Type	Method and Description
ComputeQueryBuilder	compute()
DefineQuery	define(Collection<? extends VarPattern> varPatterns)
DefineQuery	define(VarPattern... varPatterns)
QueryBuilder	infer(boolean infer)
InsertQuery	insert(Collection<? extends VarPattern> vars)
InsertQuery	insert(VarPattern... vars)
Match	match(Collection<? extends Pattern> patterns)
Match	match(Pattern... patterns)
QueryBuilder	materialise(boolean materialise)
<T extends Query<?>> T	parse(String queryString)
<T extends Query<?>> java.util.stream.Stream<T>	parseList(String queryString)
Pattern	parsePattern(String patternString)
List<Pattern>	parsePatterns(String patternsString)
<T extends Query<?>> java.util.stream.Stream<T>	parseTemplate(String template, Map<String,Object> data)
void	registerAggregate(String name, java.util.function.Function<List<Object>,Aggregate> aggregateMethod)
void	registerMacro(Macro macro)
UndefineQuery	undefine(Collection<? extends VarPattern> varPatterns)
UndefineQuery	undefine(VarPattern... varPatterns)

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(GraknTx tx)

Method Detail

infer

public QueryBuilder infer(boolean infer)

Specified by:

infer in interface QueryBuilder

materialise

public QueryBuilder materialise(boolean materialise)

Specified by:

materialise in interface QueryBuilder

match

public Match match(Pattern... patterns)

Specified by:

match in interface QueryBuilder

Parameters:

patterns - an array of patterns to match in the knowledge base

Returns:

a Match that will find matches of the given patterns

match

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

Specified by:

match in interface QueryBuilder

Parameters:

patterns - a collection of patterns to match in the knowledge base

Returns:

a Match that will find matches of the given patterns

insert

public InsertQuery insert(VarPattern... vars)

Specified by:

insert in interface QueryBuilder

Parameters:

vars - an array of variables to insert into the knowledge base

Returns:

an insert query that will insert the given variables into the knowledge base

insert

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

Specified by:

insert in interface QueryBuilder

Parameters:

vars - a collection of variables to insert into the knowledge base

Returns:

an insert query that will insert the given variables into the knowledge base

define

public DefineQuery define(VarPattern... varPatterns)

Specified by:

define in interface QueryBuilder

define

public DefineQuery define(Collection<? extends VarPattern> varPatterns)

Specified by:

define in interface QueryBuilder

undefine

public UndefineQuery undefine(VarPattern... varPatterns)

Specified by:

undefine in interface QueryBuilder

undefine

public UndefineQuery undefine(Collection<? extends VarPattern> varPatterns)

Specified by:

undefine in interface QueryBuilder

compute

public ComputeQueryBuilder compute()

Specified by:

compute in interface QueryBuilder

Returns:

a compute query builder for building analytics query

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.

parseList

public <T extends Query<?>> java.util.stream.Stream<T> parseList(String queryString)

Specified by:

parseList in interface QueryBuilder

parseTemplate

public <T extends Query<?>> java.util.stream.Stream<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