ai.grakn.graql.internal.pattern.property

Class HasAttributeTypeProperty

java.lang.Object

ai.grakn.graql.internal.pattern.property.HasAttributeTypeProperty

All Implemented Interfaces:

VarProperty, VarPropertyInternal

public abstract class HasAttributeTypeProperty
extends Object

Represents the has and key properties on a Type. This property can be queried or inserted. Whether this is a key is indicated by the required() field. This property is defined as an implicit ontological structure between a Type and a AttributeType, including one implicit RelationshipType and two implicit Roles. The labels of these types are derived from the label of the AttributeType. Like HasAttributeProperty, if this is not a key and is used in a Match it will not use the implicit structure - instead, it will match if there is any kind of relation type connecting the two types.

Author:

Felix Chapman

Constructor Summary

Constructors

Constructor and Description
HasAttributeTypeProperty()

Method Summary

Modifier and Type	Method and Description
default void	buildString(StringBuilder builder)
void	checkValid(GraknTx graph, VarPatternAdmin var) Check if the given property can be used in a Match
Collection<PropertyExecutor>	define(Var var)
String	getName()
String	getProperty()
java.util.stream.Stream<VarPatternAdmin>	getTypes()
java.util.stream.Stream<VarPatternAdmin>	implicitInnerVarPatterns()
java.util.stream.Stream<VarPatternAdmin>	innerVarPatterns()
Collection<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 HasAttributeTypeProperty	of(VarPatternAdmin resourceType, boolean required)
String	toString()
Collection<PropertyExecutor>	undefine(Var var)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

checkInsertable, checkValid, from, insert, uniquelyIdentifiesConcept

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

graqlString, isUnique

Constructor Detail

HasAttributeTypeProperty

public HasAttributeTypeProperty()

Method Detail

of

public static HasAttributeTypeProperty of(VarPatternAdmin resourceType,
                                          boolean required)

Throws:

GraqlQueryException - if no label is specified on resourceType

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

getTypes

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

Specified by:

getTypes in interface VarProperty

innerVarPatterns

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

Specified by:

innerVarPatterns in interface VarProperty

Specified by:

innerVarPatterns in interface VarPropertyInternal

implicitInnerVarPatterns

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

Specified by:

implicitInnerVarPatterns in interface VarProperty

define

public Collection<PropertyExecutor> define(Var var)
                                    throws GraqlQueryException

Specified by:

define in interface VarPropertyInternal

Throws:

GraqlQueryException

undefine

public Collection<PropertyExecutor> undefine(Var var)
                                      throws GraqlQueryException

Specified by:

undefine in interface VarPropertyInternal

Throws:

GraqlQueryException

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

insert

public Collection<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

toString

public final String toString()

Overrides:

toString in class Object