ai.grakn.graql.internal.pattern.property

Class HasResourceProperty

java.lang.Object

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

All Implemented Interfaces:

VarProperty, VarPropertyInternal

public abstract class HasResourceProperty
extends Object

Represents the has property on an Thing. This property can be queried, inserted or deleted. The property is defined as a Relationship between an Thing and a Attribute, where the Attribute is of a particular type. When matching, Schema.EdgeLabel.ROLE_PLAYER edges are used to speed up the traversal. The type of the Relationship does not matter. When inserting, an implicit Relationship is created between the instance and the Attribute, using type labels derived from the label of the AttributeType.

Author:

Felix Chapman

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
HasResourceProperty()

Method Summary

Modifier and Type	Method and Description
abstract VarPatternAdmin	attribute()
default void	buildString(StringBuilder builder)
void	checkValid(GraknTx graph, VarPatternAdmin var) Check if the given property can be used in a Match
PropertyExecutor	define(Var var)
boolean	equals(Object o)
String	getName()
String	getProperty()
java.util.stream.Stream<VarPatternAdmin>	getTypes()
int	hashCode()
java.util.stream.Stream<VarPatternAdmin>	implicitInnerVarPatterns()
java.util.stream.Stream<VarPatternAdmin>	innerVarPatterns()
PropertyExecutor	insert(Var var) Returns a PropertyExecutor that describes how to insert the given VarProperty into.
Atomic	mapToAtom(VarPatternAdmin var, Set<VarPatternAdmin> vars, ReasonerQuery parent)
Collection<EquivalentFragmentSet>	match(Var start) Return a collection of EquivalentFragmentSet to match the given property in the graph
static HasResourceProperty	of(Label attributeType, VarPatternAdmin attribute, VarPatternAdmin relationship)
abstract VarPatternAdmin	relationship()
String	toString()
abstract Label	type()
PropertyExecutor	undefine(Var var)

Methods inherited from class java.lang.Object

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

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

checkInsertable, checkValid, define, from, undefine, uniquelyIdentifiesConcept

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

graqlString, implicitInnerVarPatterns, isUnique

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

HasResourceProperty

public HasResourceProperty()

Method Detail

of

public static HasResourceProperty of(Label attributeType,
                                     VarPatternAdmin attribute,
                                     VarPatternAdmin relationship)

type

public abstract Label type()

attribute

public abstract VarPatternAdmin attribute()

relationship

public abstract VarPatternAdmin relationship()

getName

public String getName()

getProperty

public String getProperty()

match

public Collection<EquivalentFragmentSet> match(Var 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

innerVarPatterns

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

Specified by:

innerVarPatterns in interface VarProperty

Specified by:

innerVarPatterns in interface VarPropertyInternal

insert

public PropertyExecutor insert(Var var)
                        throws GraqlQueryException

Description copied from interface: VarPropertyInternal

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

Specified by:

insert in interface VarPropertyInternal

Throws:

GraqlQueryException - if this VarProperty cannot be inserted

getTypes

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

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(VarPatternAdmin var,
                        Set<VarPatternAdmin> vars,
                        ReasonerQuery parent)

Specified by:

mapToAtom in interface VarProperty

buildString

public void buildString(StringBuilder builder)

Specified by:

buildString in interface VarProperty

checkValid

public final void checkValid(GraknTx graph,
                             VarPatternAdmin var)
                      throws GraqlQueryException

Description copied from interface: VarPropertyInternal

Check if the given property can be used in a Match

Specified by:

checkValid in interface VarPropertyInternal

Throws:

GraqlQueryException

define

public PropertyExecutor define(Var var)
                        throws GraqlQueryException

Specified by:

define in interface VarPropertyInternal

Throws:

GraqlQueryException

undefine

public PropertyExecutor undefine(Var var)
                          throws GraqlQueryException

Specified by:

undefine in interface VarPropertyInternal

Throws:

GraqlQueryException

implicitInnerVarPatterns

public java.util.stream.Stream<VarPatternAdmin> implicitInnerVarPatterns()

Specified by:

implicitInnerVarPatterns in interface VarProperty

toString

public final String toString()

Overrides:

toString in class Object