ai.grakn.graql.internal.pattern.property

Class IdProperty

java.lang.Object

ai.grakn.graql.internal.pattern.property.IdProperty

All Implemented Interfaces:

UniqueVarProperty, VarProperty, VarPropertyInternal

public abstract class IdProperty
extends Object
implements UniqueVarProperty

Represents the id property on a Concept. This property can be queried. While this property cannot be inserted, if used in an insert query any existing concept with the given ID will be retrieved.

Author:

Felix Chapman

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
IdProperty()

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()
abstract ConceptId	id()
java.util.stream.Stream<VarPatternAdmin>	implicitInnerVarPatterns()
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 IdProperty	of(ConceptId id)
String	toString()
Collection<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

IdProperty

public IdProperty()

Method Detail

of

public static IdProperty of(ConceptId id)

id

public abstract ConceptId id()

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

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

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