ai.grakn.graql.internal.pattern.property

Interface VarPropertyInternal

All Superinterfaces:

VarProperty

All Known Implementing Classes:

DataTypeProperty, HasResourceProperty, HasResourceTypeProperty, IdProperty, IsAbstractProperty, IsaProperty, LabelProperty, NeqProperty, PlaysProperty, RegexProperty, RelatesProperty, RelationshipProperty, RuleProperty, SubProperty, ThenProperty, ValueProperty, WhenProperty

public interface VarPropertyInternal
extends VarProperty

Internal interface for VarProperty, providing additional methods to match, insert or define the property.

Author:

Felix Chapman

Method Summary

Modifier and Type	Method and Description
default void	checkInsertable(VarPatternAdmin var) Check if the given property can be inserted
void	checkValid(GraknTx graph, VarPatternAdmin var) Check if the given property can be used in a Match
PropertyExecutor	define(Var var)
static VarPropertyInternal	from(VarProperty varProperty) Helper method to perform the safe cast into this internal type
default java.util.stream.Stream<VarPatternAdmin>	innerVarPatterns()
PropertyExecutor	insert(Var var) Returns a PropertyExecutor that describes how to insert the given VarProperty into.
Collection<EquivalentFragmentSet>	match(Var start) Return a collection of EquivalentFragmentSet to match the given property in the graph
PropertyExecutor	undefine(Var var)
default boolean	uniquelyIdentifiesConcept() Whether this property will uniquely identify a concept in the graph, if one exists.

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

buildString, getTypes, graqlString, implicitInnerVarPatterns, isUnique, mapToAtom

Method Detail

checkValid

void checkValid(GraknTx graph,
                VarPatternAdmin var)
         throws GraqlQueryException

Check if the given property can be used in a Match

Throws:

GraqlQueryException

checkInsertable

default void checkInsertable(VarPatternAdmin var)
                      throws GraqlQueryException

Check if the given property can be inserted

Throws:

GraqlQueryException

match

Collection<EquivalentFragmentSet> match(Var start)

Return a collection of EquivalentFragmentSet to match the given property in the graph

insert

PropertyExecutor insert(Var var)
                 throws GraqlQueryException

Returns a PropertyExecutor that describes how to insert the given VarProperty into.

Throws:

GraqlQueryException - if this VarProperty cannot be inserted

define

PropertyExecutor define(Var var)
                 throws GraqlQueryException

Throws:

GraqlQueryException

undefine

PropertyExecutor undefine(Var var)
                   throws GraqlQueryException

Throws:

GraqlQueryException

uniquelyIdentifiesConcept

default boolean uniquelyIdentifiesConcept()

Whether this property will uniquely identify a concept in the graph, if one exists. This is used for recognising equivalent variables in insert queries.

innerVarPatterns

default java.util.stream.Stream<VarPatternAdmin> innerVarPatterns()

Specified by:

innerVarPatterns in interface VarProperty

from

static VarPropertyInternal from(VarProperty varProperty)

Helper method to perform the safe cast into this internal type