ai.grakn.graql.internal.pattern.property

Class LabelProperty

java.lang.Object

ai.grakn.graql.internal.pattern.property.LabelProperty

All Implemented Interfaces:

UniqueVarProperty, VarProperty, VarPropertyInternal

public abstract class LabelProperty
extends Object
implements UniqueVarProperty

Represents the label property on a Type. This property can be queried and inserted. If used in an insert query and there is an existing type with the give label, then that type will be retrieved.

Author:

Felix Chapman

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
LabelProperty()

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
PropertyExecutor	define(Var var)
String	getName()
String	getProperty()
java.util.stream.Stream<VarPatternAdmin>	getTypes()
java.util.stream.Stream<VarPatternAdmin>	implicitInnerVarPatterns()
PropertyExecutor	insert(Var var) Returns a PropertyExecutor that describes how to insert the given VarProperty into.
abstract Label	label()
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 LabelProperty	of(Label label)
String	toString()
PropertyExecutor	undefine(Var var)
boolean	uniquelyIdentifiesConcept() Whether this property will uniquely identify a concept in the graph, if one exists.

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, innerVarPatterns

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

getTypes, graqlString, implicitInnerVarPatterns, isUnique

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

isUnique

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

LabelProperty

public LabelProperty()

Method Detail

of

public static LabelProperty of(Label label)

label

public abstract Label label()

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

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

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

uniquelyIdentifiesConcept

public boolean uniquelyIdentifiesConcept()

Description copied from interface: VarPropertyInternal

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

Specified by:

uniquelyIdentifiesConcept in interface VarPropertyInternal

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

getTypes

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

Specified by:

getTypes in interface VarProperty

implicitInnerVarPatterns

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

Specified by:

implicitInnerVarPatterns in interface VarProperty

toString

public final String toString()

Overrides:

toString in class Object