MatchQueryBase (Grakn 0.11.0 API)

java.lang.Object
- ai.grakn.graql.internal.query.match.MatchQueryBase

All Implemented Interfaces:

MatchQueryAdmin, MatchQuery, Query<List<Map<String,Concept>>>, Streamable<Map<String,Concept>>, Iterable<Map<String,Concept>>
```
public class MatchQueryBase
extends Object
```
Base MatchQuery implementation that executes the gremlin traversal

Author:

Felix Chapman

Field Summary

Fields
Modifier and Type Field and Description

protected org.slf4j.Logger LOG

Fields
Modifier and Type	Field and Description
`protected org.slf4j.Logger`	`LOG`

Constructor Summary

Constructors
Constructor and Description

MatchQueryBase(Conjunction<PatternAdmin> pattern)

Constructors
Constructor and Description
`MatchQueryBase(Conjunction<PatternAdmin> pattern)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MatchQueryAdmin`	`admin()`
`<S> AggregateQuery<S>`	`aggregate(Aggregate<? super Map<VarName,Concept>,S> aggregate)` Aggregate results of a query.
`AskQuery`	`ask()`
`DeleteQuery`	`delete(Collection<? extends Var> deleters)`
`DeleteQuery`	`delete(String... names)`
`DeleteQuery`	`delete(Var... deleters)`
`MatchQuery`	`distinct()` remove any duplicate results from the query
`boolean`	`equals(Object o)`
`List<Map<String,Concept>>`	`execute()` Execute the query against the graph (potentially writing to the graph) and return a result
`java.util.stream.Stream<Concept>`	`get(String name)`
`Optional<GraknGraph>`	`getGraph()`
`Conjunction<PatternAdmin>`	`getPattern()`
`com.google.common.collect.ImmutableSet<VarName>`	`getSelectedNames()`
`Set<Type>`	`getTypes()`
`Set<Type>`	`getTypes(GraknGraph graph)`
`int`	`hashCode()`
`MatchQuery`	`infer(boolean materialise)`
`InsertQuery`	`insert(Collection<? extends Var> vars)`
`InsertQuery`	`insert(Var... vars)`
`boolean`	`isReadOnly()` Whether this query will modify the graph
`MatchQuery`	`limit(long limit)`
`MatchQuery`	`offset(long offset)`
`MatchQuery`	`orderBy(String varName)` Order the results by degree in ascending order
`MatchQuery`	`orderBy(String varName, Order order)` Order the results by degree
`MatchQuery`	`orderBy(VarName varName)` Order the results by degree in ascending order
`MatchQuery`	`orderBy(VarName varName, Order order)` Order the results by degree
`List<Map<VarName,Concept>>`	`results()` Get a list of results.
`java.util.stream.Stream<String>`	`resultsString(Printer printer)` Execute the query and return a human-readable stream of results
`MatchQuery`	`select(Set<VarName> names)`
`MatchQuery`	`select(String... names)`
`java.util.stream.Stream<Map<String,Concept>>`	`stream()`
`java.util.stream.Stream<Map<VarName,Concept>>`	`stream(Optional<GraknGraph> optionalGraph)` Execute the query using the given graph.
`java.util.stream.Stream<Map<VarName,Concept>>`	`streamWithVarNames()` Get a stream of results.
`String`	`toString()`
`MatchQuery`	`withGraph(GraknGraph graph)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ai.grakn.graql.Streamable
iterator, parallelStream

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - LOG
```
protected final org.slf4j.Logger LOG
```
- Constructor Detail
  - MatchQueryBase
```
public MatchQueryBase(Conjunction<PatternAdmin> pattern)
```
    Parameters:
    
    pattern - a pattern to match in the graph
- Method Detail
  - stream
```
public java.util.stream.Stream<Map<VarName,Concept>> stream(Optional<GraknGraph> optionalGraph)
```
    Execute the query using the given graph.
    
    Parameters:
    
    optionalGraph - the graph to use to execute the query
    
    Returns:
    
    a stream of results
  - getTypes
```
public Set<Type> getTypes(GraknGraph graph)
```
    Parameters:
    
    graph - the graph to use to get types from
    
    Returns:
    
    all concept types referred to explicitly in the query
  - getTypes
```
public Set<Type> getTypes()
```
    Returns:
    
    all concept types referred to explicitly in the query
  - getSelectedNames
```
public com.google.common.collect.ImmutableSet<VarName> getSelectedNames()
```
    Returns:
    
    all selected variable names in the query
  - getPattern
```
public Conjunction<PatternAdmin> getPattern()
```
    Returns:
    
    the pattern to match in the graph
  - getGraph
```
public Optional<GraknGraph> getGraph()
```
    Returns:
    
    the graph the query operates on, if one was provided
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - infer
```
public final MatchQuery infer(boolean materialise)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - resultsString
```
public final 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
```
public final boolean isReadOnly()
```
    Description copied from interface: Query
    
    Whether this query will modify the graph
    
    Specified by:
    
    isReadOnly in interface Query<List<Map<String,Concept>>>
  - admin
```
public final MatchQueryAdmin admin()
```
    Specified by:
    
    admin in interface MatchQuery
    
    Returns:
    
    admin instance for inspecting and manipulating this query
  - execute
```
public final List<Map<String,Concept>> execute()
```
    Description copied from interface: Query
    
    Execute the query against the graph (potentially writing to the graph) and return a result
    
    Specified by:
    
    execute in interface Query<List<Map<String,Concept>>>
    
    Returns:
    
    the result of the query
  - results
```
public final List<Map<VarName,Concept>> results()
```
    Description copied from interface: MatchQueryAdmin
    
    Get a list of results. This differs from MatchQuery#execute because the keys are instances of VarName.
    
    Specified by:
    
    results in interface MatchQueryAdmin
    
    Returns:
    
    a list of results
  - streamWithVarNames
```
public final java.util.stream.Stream<Map<VarName,Concept>> streamWithVarNames()
```
    Description copied from interface: MatchQueryAdmin
    
    Get a stream of results. This differs from MatchQuery#execute because the keys are instances of VarName.
    
    Specified by:
    
    streamWithVarNames in interface MatchQueryAdmin
    
    Returns:
    
    a stream of results
  - stream
```
public final java.util.stream.Stream<Map<String,Concept>> stream()
```
    Specified by:
    
    stream in interface Streamable<Map<String,Concept>>
    
    Returns:
    
    a stream of elements
  - withGraph
```
public final 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
```
public final 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
```
public final 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
```
public final 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
```
public final <S> AggregateQuery<S> aggregate(Aggregate<? super Map<VarName,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
```
public final MatchQuery select(String... names)
```
    Specified by:
    
    select in interface MatchQuery
    
    Parameters:
    
    names - an array of variable names to select
    
    Returns:
    
    a new MatchQuery that selects the given variables
  - select
```
public final MatchQuery select(Set<VarName> 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
```
public final 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
```
public final AskQuery ask()
```
    Specified by:
    
    ask in interface MatchQuery
    
    Returns:
    
    an ask query that will return true if any matches are found
  - insert
```
public final InsertQuery insert(Var... vars)
```
    Specified by:
    
    insert in interface MatchQuery
    
    Parameters:
    
    vars - an array 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
  - insert
```
public final 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
```
public final DeleteQuery delete(Var... deleters)
```
    Specified by:
    
    delete in interface MatchQuery
    
    Parameters:
    
    deleters - an array 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
  - delete
```
public final 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
```
public final 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
```
public final MatchQuery orderBy(String varName)
```
    Description copied from interface: MatchQuery
    
    Order the results by degree in ascending order
    
    Specified by:
    
    orderBy in interface MatchQuery
    
    Parameters:
    
    varName - the variable name to order the results by
    
    Returns:
    
    a new MatchQuery with the given ordering
  - orderBy
```
public final MatchQuery orderBy(VarName varName)
```
    Description copied from interface: MatchQuery
    
    Order the results by degree in ascending order
    
    Specified by:
    
    orderBy in interface MatchQuery
    
    Parameters:
    
    varName - the variable name to order the results by
    
    Returns:
    
    a new MatchQuery with the given ordering
  - orderBy
```
public final 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
  - orderBy
```
public final MatchQuery orderBy(VarName 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

Class MatchQueryBase

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface ai.grakn.graql.Streamable

Methods inherited from interface java.lang.Iterable

Field Detail

LOG

Constructor Detail

MatchQueryBase

Method Detail

stream

getTypes

getTypes

getSelectedNames

getPattern

getGraph

toString

infer

equals

hashCode

resultsString

isReadOnly

admin

execute

results

streamWithVarNames

stream

withGraph

limit

offset

distinct

aggregate

select

select

get

ask

insert

insert

delete

delete

delete

orderBy

orderBy

orderBy

orderBy