| Package | Description |
|---|---|
| ai.grakn.exception |
Grakn exception definitions.
|
| ai.grakn.graql |
A collection of interfaces and factories for executing Graql queries.
|
| ai.grakn.graql.admin |
A collection of interfaces offering more behaviour on Graql objects.
|
| ai.grakn.graql.internal.gremlin.fragment | |
| ai.grakn.graql.internal.gremlin.sets | |
| ai.grakn.graql.internal.pattern | |
| ai.grakn.graql.internal.pattern.property | |
| ai.grakn.graql.internal.query | |
| ai.grakn.graql.internal.query.aggregate | |
| ai.grakn.graql.internal.query.match | |
| ai.grakn.graql.internal.reasoner | |
| ai.grakn.graql.internal.reasoner.atom | |
| ai.grakn.graql.internal.reasoner.atom.binary | |
| ai.grakn.graql.internal.reasoner.atom.binary.type | |
| ai.grakn.graql.internal.reasoner.atom.predicate | |
| ai.grakn.graql.internal.reasoner.atom.property | |
| ai.grakn.graql.internal.reasoner.cache | |
| ai.grakn.graql.internal.reasoner.query | |
| ai.grakn.graql.internal.reasoner.utils | |
| ai.grakn.graql.internal.template | |
| ai.grakn.matcher |
| Modifier and Type | Method and Description |
|---|---|
static GraqlQueryException |
GraqlQueryException.varNotInQuery(Var var) |
| Modifier and Type | Method and Description |
|---|---|
Var |
Var.asUserDefined()
Transform the variable into a user-defined one, retaining the generated name.
|
Var |
Var.map(java.util.function.Function<String,String> mapper)
Rename a variable (does not modify the original
Var) |
static Var |
Graql.var() |
static Var |
Graql.var(String name) |
| Modifier and Type | Method and Description |
|---|---|
MatchQuery |
MatchQuery.orderBy(Var varName)
Order the results by degree in ascending order
|
MatchQuery |
MatchQuery.orderBy(Var varName,
Order order)
Order the results by degree
|
| Modifier and Type | Method and Description |
|---|---|
MatchQuery |
MatchQuery.select(Set<Var> names) |
| Modifier and Type | Method and Description |
|---|---|
Var |
VarPatternAdmin.getVarName() |
Var |
Atomic.getVarName() |
| Modifier and Type | Method and Description |
|---|---|
Set<Var> |
PatternAdmin.commonVarNames()
Get all common, user-defined variable names in the pattern.
|
Set<Map.Entry<Var,Concept>> |
Answer.entrySet() |
Collection<Var> |
Unifier.get(Var key) |
Set<Var> |
MatchQueryAdmin.getSelectedNames() |
Set<Var> |
ReasonerQuery.getVarNames() |
Set<Var> |
Atomic.getVarNames() |
Map<Var,OntologyConcept> |
ReasonerQuery.getVarOntologyConceptMap() |
Set<Var> |
Unifier.keySet() |
Set<Var> |
Answer.keySet() |
Map<Var,Collection<Var>> |
Unifier.map() |
Map<Var,Collection<Var>> |
Unifier.map() |
Map<Var,Concept> |
Answer.map() |
Collection<Map.Entry<Var,Var>> |
Unifier.mappings() |
Collection<Map.Entry<Var,Var>> |
Unifier.mappings() |
Collection<Var> |
Unifier.values() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
Unifier.addMapping(Var key,
Var value)
add a new mapping
|
boolean |
Unifier.containsKey(Var key) |
boolean |
Answer.containsKey(Var var) |
boolean |
Unifier.containsValue(Var value) |
default boolean |
Atomic.containsVar(Var name) |
Collection<Var> |
Unifier.get(Var key) |
Concept |
Answer.get(Var var) |
Concept |
Answer.put(Var var,
Concept con) |
Concept |
Answer.remove(Var var) |
VarPatternAdmin |
VarPatternAdmin.setVarName(Var name) |
| Modifier and Type | Method and Description |
|---|---|
Answer |
Answer.filterVars(Set<Var> vars) |
void |
Answer.forEach(java.util.function.BiConsumer<? super Var,? super Concept> consumer) |
void |
Answer.putAll(Map<Var,Concept> m2) |
| Modifier and Type | Method and Description |
|---|---|
Var |
Fragment.getStart() |
| Modifier and Type | Method and Description |
|---|---|
Set<Var> |
Fragment.getDependencies() |
Optional<Var> |
Fragment.getEnd() |
Set<Var> |
Fragment.getVariableNames()
Get all variable names in the fragment - the start and end (if present)
|
| Modifier and Type | Method and Description |
|---|---|
static Fragment |
Fragments.dataType(Var start,
ResourceType.DataType dataType) |
static Fragment |
Fragments.id(Var start,
ConceptId id) |
static Fragment |
Fragments.inHasScope(Var start,
Var end) |
static Fragment |
Fragments.inIsa(Var start,
Var end) |
static Fragment |
Fragments.inPlays(Var start,
Var end,
boolean required) |
static ai.grakn.graql.internal.gremlin.fragment.InRelatesFragment |
Fragments.inRelates(Var start,
Var end) |
static Fragment |
Fragments.inShortcut(Var rolePlayer,
Var edge,
Var relation,
Optional<Var> role,
Optional<Set<Label>> roleLabels,
Optional<Set<Label>> relationTypeLabels) |
static Fragment |
Fragments.inSub(Var start,
Var end) |
static Fragment |
Fragments.isAbstract(Var start) |
static Fragment |
Fragments.label(Var start,
Label label) |
static Fragment |
Fragments.neq(Var start,
Var other) |
static Fragment |
Fragments.notInternal(Var start) |
static Fragment |
Fragments.outHasScope(Var start,
Var end) |
static Fragment |
Fragments.outIsa(Var start,
Var end) |
static Fragment |
Fragments.outPlays(Var start,
Var end,
boolean required) |
static Fragment |
Fragments.outRelates(Var start,
Var end) |
static Fragment |
Fragments.outShortcut(Var relation,
Var edge,
Var rolePlayer,
Optional<Var> role,
Optional<Set<Label>> roleLabels,
Optional<Set<Label>> relationTypeLabels) |
static Fragment |
Fragments.outSub(Var start,
Var end) |
static Fragment |
Fragments.regex(Var start,
String regex) |
static Fragment |
Fragments.resourceIndex(Var start,
Label label,
Object resourceValue)
A
Fragment that uses an index stored on each resource. |
static Fragment |
Fragments.value(Var start,
ValuePredicateAdmin predicate) |
| Modifier and Type | Method and Description |
|---|---|
static Fragment |
Fragments.inShortcut(Var rolePlayer,
Var edge,
Var relation,
Optional<Var> role,
Optional<Set<Label>> roleLabels,
Optional<Set<Label>> relationTypeLabels) |
static Fragment |
Fragments.outShortcut(Var relation,
Var edge,
Var rolePlayer,
Optional<Var> role,
Optional<Set<Label>> roleLabels,
Optional<Set<Label>> relationTypeLabels) |
| Modifier and Type | Method and Description |
|---|---|
static EquivalentFragmentSet |
EquivalentFragmentSets.dataType(Var resourceType,
ResourceType.DataType<?> dataType)
An
EquivalentFragmentSet that indicates a variable representing a resource type with a data-type. |
static EquivalentFragmentSet |
EquivalentFragmentSets.hasScope(Var relation,
Var scope)
An
EquivalentFragmentSet that indicates a variable is a relation with a scope. |
static EquivalentFragmentSet |
EquivalentFragmentSets.id(Var start,
ConceptId id)
An
EquivalentFragmentSet that indicates a variable representing a concept with a particular ID. |
static EquivalentFragmentSet |
EquivalentFragmentSets.isa(Var instance,
Var type)
An
EquivalentFragmentSet that indicates a variable is an instance of a type. |
static EquivalentFragmentSet |
EquivalentFragmentSets.isAbstract(Var start)
An
EquivalentFragmentSet that indicates a variable represents an abstract type. |
static EquivalentFragmentSet |
EquivalentFragmentSets.label(Var type,
Label label)
An
EquivalentFragmentSet that indicates a variable representing a type with a particular label. |
static EquivalentFragmentSet |
EquivalentFragmentSets.neq(Var varA,
Var varB)
An
EquivalentFragmentSet that indicates a variable is not equal to another variable. |
static EquivalentFragmentSet |
EquivalentFragmentSets.notInternalFragmentSet(Var start)
An
EquivalentFragmentSet that indicates a variable is not a casting or a shard. |
static EquivalentFragmentSet |
EquivalentFragmentSets.plays(Var type,
Var roleType,
boolean required)
An
EquivalentFragmentSet that indicates a variable is a type whose instances play a role. |
static EquivalentFragmentSet |
EquivalentFragmentSets.regex(Var resourceType,
String regex)
An
EquivalentFragmentSet that indicates a resource type whose instances must conform to a given regex. |
static EquivalentFragmentSet |
EquivalentFragmentSets.relates(Var relationType,
Var roleType)
An
EquivalentFragmentSet that indicates a variable is a relation type which involves a role. |
static EquivalentFragmentSet |
EquivalentFragmentSets.shortcut(Var relation,
Var edge,
Var rolePlayer,
Optional<Var> roleType)
An
EquivalentFragmentSet that indicates a shortcut edge between two role-players. |
static EquivalentFragmentSet |
EquivalentFragmentSets.sub(Var subType,
Var superType)
An
EquivalentFragmentSet that indicates a variable is a sub-type of another variable. |
static EquivalentFragmentSet |
EquivalentFragmentSets.value(Var resource,
ValuePredicateAdmin predicate)
An
EquivalentFragmentSet that indicates a variable represents a resource with value matching a predicate. |
| Modifier and Type | Method and Description |
|---|---|
static EquivalentFragmentSet |
EquivalentFragmentSets.shortcut(Var relation,
Var edge,
Var rolePlayer,
Optional<Var> roleType)
An
EquivalentFragmentSet that indicates a shortcut edge between two role-players. |
| Modifier and Type | Method and Description |
|---|---|
abstract Var |
AbstractVarPattern.getVarName() |
static Var |
Patterns.var() |
static Var |
Patterns.var(String value) |
| Modifier and Type | Method and Description |
|---|---|
Set<Var> |
AbstractVarPattern.commonVarNames() |
| Modifier and Type | Method and Description |
|---|---|
VarPatternAdmin |
AbstractVarPattern.setVarName(Var name) |
| Modifier and Type | Method and Description |
|---|---|
Set<Map.Entry<Var,Concept>> |
QueryAnswer.entrySet() |
Set<Var> |
QueryAnswer.keySet() |
Map<Var,Concept> |
QueryAnswer.map() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
QueryAnswer.containsKey(Var var) |
Concept |
QueryAnswer.get(Var var) |
Concept |
QueryAnswer.put(Var var,
Concept con) |
Concept |
QueryAnswer.remove(Var var) |
| Modifier and Type | Method and Description |
|---|---|
Answer |
QueryAnswer.filterVars(Set<Var> vars) |
void |
QueryAnswer.forEach(java.util.function.BiConsumer<? super Var,? super Concept> consumer) |
void |
QueryAnswer.putAll(Map<Var,Concept> m2) |
| Constructor and Description |
|---|
QueryAnswer(Map<Var,Concept> m) |
| Modifier and Type | Method and Description |
|---|---|
static Aggregate<Answer,Map<Concept,List<Answer>>> |
Aggregates.group(Var varName)
Aggregate that groups results of a match query by variable name
|
static <T> Aggregate<Answer,Map<Concept,T>> |
Aggregates.group(Var varName,
Aggregate<? super Answer,T> innerAggregate)
Aggregate that groups results of a match query by variable name, applying an aggregate to each group.
|
static <T extends Comparable<T>> |
Aggregates.max(Var varName)
Aggregate that finds maximum of a match query.
|
static Aggregate<Answer,Optional<Double>> |
Aggregates.mean(Var varName)
Aggregate that finds mean of a match query.
|
static Aggregate<Answer,Optional<Number>> |
Aggregates.median(Var varName)
Aggregate that finds median of a match query.
|
static <T extends Comparable<T>> |
Aggregates.min(Var varName)
Aggregate that finds minimum of a match query.
|
static Aggregate<Answer,Optional<Double>> |
Aggregates.std(Var varName)
Aggregate that finds the unbiased sample standard deviation of a match query
|
static Aggregate<Answer,Number> |
Aggregates.sum(Var varName)
Aggregate that sums results of a match query.
|
| Modifier and Type | Method and Description |
|---|---|
Var |
MatchOrder.getVar() |
| Modifier and Type | Method and Description |
|---|---|
Set<Var> |
MatchQueryBase.getSelectedNames() |
| Modifier and Type | Method and Description |
|---|---|
Collection<Var> |
UnifierImpl.get(Var key) |
Set<Var> |
UnifierImpl.keySet() |
Map<Var,Collection<Var>> |
UnifierImpl.map() |
Map<Var,Collection<Var>> |
UnifierImpl.map() |
Collection<Map.Entry<Var,Var>> |
UnifierImpl.mappings() |
Collection<Map.Entry<Var,Var>> |
UnifierImpl.mappings() |
Collection<Var> |
UnifierImpl.values() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
UnifierImpl.addMapping(Var key,
Var value) |
boolean |
UnifierImpl.containsKey(Var key) |
boolean |
UnifierImpl.containsValue(Var value) |
Collection<Var> |
UnifierImpl.get(Var key) |
| Constructor and Description |
|---|
UnifierImpl(Map<Var,Var> map) |
UnifierImpl(Map<Var,Var> map) |
| Modifier and Type | Method and Description |
|---|---|
abstract Var |
Atom.getPredicateVariable() |
Var |
AtomicBase.getVarName() |
| Modifier and Type | Method and Description |
|---|---|
Set<Var> |
AtomicBase.getVarNames() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
AtomicBase.containsVar(Var name) |
| Modifier and Type | Method and Description |
|---|---|
int |
Atom.computePriority(Set<Var> subbedVars)
compute resolution priority based on provided substitution variables
|
| Modifier and Type | Method and Description |
|---|---|
Var |
Binary.getPredicateVariable() |
| Modifier and Type | Method and Description |
|---|---|
Set<Var> |
RelationAtom.getRolePlayers() |
com.google.common.collect.Multimap<Role,Var> |
RelationAtom.getRoleVarMap() |
Set<Var> |
RelationAtom.getVarNames() |
Set<Var> |
Binary.getVarNames() |
| Modifier and Type | Method and Description |
|---|---|
int |
TypeAtom.computePriority(Set<Var> subbedVars) |
int |
ResourceAtom.computePriority(Set<Var> subbedVars) |
int |
RelationAtom.computePriority(Set<Var> subbedVars) |
| Constructor and Description |
|---|
RelationAtom(VarPatternAdmin pattern,
Var predicateVar,
IdPredicate predicate,
ReasonerQuery par) |
ResourceAtom(VarPatternAdmin pattern,
Var predicateVar,
IdPredicate idPred,
Set<ValuePredicate> ps,
ReasonerQuery par) |
TypeAtom(VarPatternAdmin pattern,
Var predicateVar,
IdPredicate p,
ReasonerQuery par) |
| Constructor and Description |
|---|
HasAtom(VarPatternAdmin pattern,
Var predicateVar,
IdPredicate p,
ReasonerQuery par) |
IsaAtom(VarPatternAdmin pattern,
Var predicateVar,
IdPredicate p,
ReasonerQuery par) |
PlaysAtom(VarPatternAdmin pattern,
Var predicateVar,
IdPredicate p,
ReasonerQuery par) |
RelatesAtom(VarPatternAdmin pattern,
Var predicateVar,
IdPredicate p,
ReasonerQuery par) |
ScopeAtom(VarPatternAdmin pattern,
Var predicateVar,
IdPredicate p,
ReasonerQuery par) |
SubAtom(VarPatternAdmin pattern,
Var predicateVar,
IdPredicate p,
ReasonerQuery par) |
| Modifier and Type | Method and Description |
|---|---|
protected Var |
NeqPredicate.extractPredicate(VarPatternAdmin pattern) |
| Modifier and Type | Method and Description |
|---|---|
Set<Var> |
ValuePredicate.getVarNames() |
Set<Var> |
NeqPredicate.getVarNames() |
| Modifier and Type | Method and Description |
|---|---|
static VarPatternAdmin |
ValuePredicate.createValueVar(Var name,
ValuePredicateAdmin pred) |
| Constructor and Description |
|---|
IdPredicate(Var varName,
Concept con,
ReasonerQuery par) |
IdPredicate(Var varName,
IdProperty prop,
ReasonerQuery par) |
IdPredicate(Var varName,
LabelProperty prop,
ReasonerQuery par) |
NeqPredicate(Var varName,
NeqProperty prop,
ReasonerQuery parent) |
ValuePredicate(Var varName,
ValuePredicateAdmin pred,
ReasonerQuery par) |
| Constructor and Description |
|---|
DataTypeAtom(Var varName,
DataTypeProperty prop,
ReasonerQuery parent) |
IsAbstractAtom(Var varName,
ReasonerQuery parent) |
RegexAtom(Var varName,
RegexProperty prop,
ReasonerQuery parent) |
| Modifier and Type | Method and Description |
|---|---|
Map<javafx.util.Pair<Var,Concept>,Set<Answer>> |
Cache.getInverseAnswerMap(Q query)
returns an inverse answer map with all query variables
|
Map<javafx.util.Pair<Var,Concept>,Set<Answer>> |
Cache.getInverseAnswerMap(Q query,
Set<Var> vars)
return an inverse answer map which is more suitable for operations involving concept comparison (joins, filtering, etc.)
NB: consumes the underlying stream for the specified query
|
| Modifier and Type | Method and Description |
|---|---|
Map<javafx.util.Pair<Var,Concept>,Set<Answer>> |
Cache.getInverseAnswerMap(Q query,
Set<Var> vars)
return an inverse answer map which is more suitable for operations involving concept comparison (joins, filtering, etc.)
NB: consumes the underlying stream for the specified query
|
| Modifier and Type | Method and Description |
|---|---|
Set<Var> |
ReasonerQueryImpl.getVarNames() |
Map<Var,OntologyConcept> |
ReasonerQueryImpl.getVarOntologyConceptMap() |
| Modifier and Type | Method and Description |
|---|---|
IdPredicate |
ReasonerQueryImpl.getIdPredicate(Var var) |
| Modifier and Type | Method and Description |
|---|---|
QueryAnswers |
QueryAnswers.filterVars(Set<Var> vars)
filter answers by constraining the variable set to the provided one
|
static java.util.stream.Stream<Answer> |
QueryAnswerStream.join(java.util.stream.Stream<Answer> stream,
java.util.stream.Stream<Answer> stream2,
com.google.common.collect.ImmutableSet<Var> joinVars)
lazy stream join with quasi- sideways information propagation
|
| Modifier and Type | Method and Description |
|---|---|
static IdPredicate |
ReasonerUtils.getIdPredicate(Var typeVariable,
VarPatternAdmin typeVar,
Set<VarPatternAdmin> vars,
ReasonerQuery parent)
looks for an appropriate var property with a specified name among the vars and maps it to an IdPredicate,
covers both the cases when variable is and isn't user defined
|
static IdPredicate |
ReasonerUtils.getUserDefinedIdPredicate(Var typeVariable,
Set<VarPatternAdmin> vars,
ReasonerQuery parent)
looks for an appropriate var property with a specified name among the vars and maps it to an IdPredicate,
covers the case when specified variable name is user defined
|
static Set<ValuePredicate> |
ReasonerUtils.getValuePredicates(Var valueVariable,
VarPatternAdmin valueVar,
Set<VarPatternAdmin> vars,
ReasonerQuery parent)
looks for appropriate var properties with a specified name among the vars and maps them to ValuePredicates,
covers both the case when variable is and isn't user defined
|
| Modifier and Type | Method and Description |
|---|---|
static void |
ReasonerUtils.computeRoleCombinations(Set<Var> vars,
Set<Role> roles,
Map<Var,VarPattern> roleMap,
Set<Map<Var,VarPattern>> roleMaps)
compute all rolePlayer-roleType combinations complementing provided roleMap
|
static void |
ReasonerUtils.computeRoleCombinations(Set<Var> vars,
Set<Role> roles,
Map<Var,VarPattern> roleMap,
Set<Map<Var,VarPattern>> roleMaps)
compute all rolePlayer-roleType combinations complementing provided roleMap
|
static void |
ReasonerUtils.computeRoleCombinations(Set<Var> vars,
Set<Role> roles,
Map<Var,VarPattern> roleMap,
Set<Map<Var,VarPattern>> roleMaps)
compute all rolePlayer-roleType combinations complementing provided roleMap
|
static Set<Unifier> |
ReasonerUtils.getUnifiersFromPermutations(List<Var> originalVars,
List<List<Var>> permutations)
get unifiers by comparing permutations with original variables
|
static Set<Unifier> |
ReasonerUtils.getUnifiersFromPermutations(List<Var> originalVars,
List<List<Var>> permutations)
get unifiers by comparing permutations with original variables
|
| Modifier and Type | Method and Description |
|---|---|
Var |
TemplateVisitor.visitVarResolved(ai.grakn.graql.internal.antlr.GraqlTemplateParser.VarResolvedContext ctx) |
| Modifier and Type | Method and Description |
|---|---|
static org.hamcrest.Matcher<MatchQuery> |
GraknMatchers.results(org.hamcrest.Matcher<? extends Iterable<? extends Map<? extends Var,? extends MatchableConcept>>> matcher)
Create a matcher to test against the results of a Graql query.
|
Copyright © 2017 Grakn Labs Ltd. All rights reserved.