ai.grakn.graql.internal.pattern.property

Class HasResourceProperty

java.lang.Object

ai.grakn.graql.internal.pattern.property.HasResourceProperty

All Implemented Interfaces:

VarProperty, VarPropertyInternal

public class HasResourceProperty
extends Object

Represents the has property on an Instance. This property can be queried, inserted or deleted. The property is defined as a relationship between an Instance and a Resource, where the Resource is of a particular type. When matching, shortcut edges are used to speed up the traversal. The type of the relationship does not matter. When inserting, an implicit relation is created between the instance and the resource, using type labels derived from the label of the resource type.

Author:

Felix Chapman

Method Summary

Modifier and Type	Method and Description
default void	buildString(StringBuilder builder) Build a Graql string representation of this property
void	checkValid(GraknGraph graph, VarAdmin var) Check if the given property can be used in a match query
void	delete(GraknGraph graph, Concept concept) Delete the given property from the graph, if possible.
boolean	equals(Object o)
java.util.stream.Stream<VarAdmin>	getImplicitInnerVars() Get a stream of any inner VarAdmin within this `VarProperty`, including any that may have been implicitly created (such as with "has").
java.util.stream.Stream<VarAdmin>	getInnerVars() Get a stream of any inner VarAdmin within this `VarProperty`.
String	getName()
String	getProperty()
VarAdmin	getResource()
TypeLabel	getType()
java.util.stream.Stream<VarAdmin>	getTypes() Get a stream of VarAdmin that must be types.
int	hashCode()
void	insert(InsertQueryExecutor insertQueryExecutor, Concept concept) Insert the given property into the graph, if possible.
Atomic	mapToAtom(VarAdmin var, Set<VarAdmin> vars, ReasonerQuery parent) maps this var property to a reasoner atom
Collection<EquivalentFragmentSet>	match(VarName start) Return a collection of EquivalentFragmentSet to match the given property in the graph
static HasResourceProperty	of(TypeLabel resourceType, VarAdmin resource)
HasResourceProperty	setResource(VarAdmin resource)

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.grakn.graql.internal.pattern.property.VarPropertyInternal

checkInsertable, checkValid, modifyShortcutTraversal

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

getImplicitInnerVars, graqlString, isUnique

Method Detail

of

public static HasResourceProperty of(TypeLabel resourceType,
                                     VarAdmin resource)

getType

public TypeLabel getType()

getResource

public VarAdmin getResource()

setResource

@CheckReturnValue
public HasResourceProperty setResource(VarAdmin resource)

getName

public String getName()

getProperty

public String getProperty()

match

public Collection<EquivalentFragmentSet> match(VarName start)

Description copied from interface: VarPropertyInternal

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

Specified by:

match in interface VarPropertyInternal

getInnerVars

public java.util.stream.Stream<VarAdmin> getInnerVars()

Description copied from interface: VarProperty

Get a stream of any inner VarAdmin within this `VarProperty`.

Specified by:

getInnerVars in interface VarProperty

Specified by:

getInnerVars in interface VarPropertyInternal

insert

public void insert(InsertQueryExecutor insertQueryExecutor,
                   Concept concept)
            throws IllegalStateException

Description copied from interface: VarPropertyInternal

Insert the given property into the graph, if possible.

Specified by:

insert in interface VarPropertyInternal

Parameters:

insertQueryExecutor - the instance handling the insert query

concept - the concept to insert a property on

Throws:

IllegalStateException

delete

public void delete(GraknGraph graph,
                   Concept concept)

Description copied from interface: VarPropertyInternal

Delete the given property from the graph, if possible.

Specified by:

delete in interface VarPropertyInternal

Parameters:

graph - the graph to operate on

concept - the concept to delete properties of

getTypes

public java.util.stream.Stream<VarAdmin> getTypes()

Description copied from interface: VarProperty

Get a stream of VarAdmin that must be types.

Specified by:

getTypes in interface VarProperty

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

mapToAtom

public Atomic mapToAtom(VarAdmin var,
                        Set<VarAdmin> vars,
                        ReasonerQuery parent)

Description copied from interface: VarProperty

maps this var property to a reasoner atom

Specified by:

mapToAtom in interface VarProperty

Parameters:

var - VarAdmin this property belongs to

vars - VarAdmins constituting the pattern this property belongs to

parent - reasoner query this atom should belong to

Returns:

created atom

buildString

public void buildString(StringBuilder builder)

Description copied from interface: VarProperty

Build a Graql string representation of this property

Specified by:

buildString in interface VarProperty

Parameters:

builder - a string builder to append to

checkValid

public final void checkValid(GraknGraph graph,
                             VarAdmin var)
                      throws IllegalStateException

Description copied from interface: VarPropertyInternal

Check if the given property can be used in a match query

Specified by:

checkValid in interface VarPropertyInternal

Throws:

IllegalStateException

getImplicitInnerVars

public java.util.stream.Stream<VarAdmin> getImplicitInnerVars()

Description copied from interface: VarProperty

Get a stream of any inner VarAdmin within this `VarProperty`, including any that may have been implicitly created (such as with "has").

Specified by:

getImplicitInnerVars in interface VarProperty