ai.grakn.graql.internal.pattern.property

Class IsaProperty

java.lang.Object

ai.grakn.graql.internal.pattern.property.IsaProperty

All Implemented Interfaces:

UniqueVarProperty, VarProperty, VarPropertyInternal

public abstract class IsaProperty
extends Object
implements UniqueVarProperty

Represents the isa property on a Thing. This property can be queried and inserted. THe property is defined as a relationship between an Thing and a Type. When matching, any subtyping is respected. For example, if we have $bob isa man, man sub person, person sub entity then it follows that $bob isa person and bob isa entity.

Author:

Felix Chapman

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
IsaProperty()

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
void	checkValidProperty(GraknTx graph, VarPatternAdmin var)
Collection<PropertyExecutor>	define(Var var)
abstract Var	directType()
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()
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 IsaProperty	of(VarPatternAdmin type)
String	toString()
abstract VarPatternAdmin	type()
Collection<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.admin.UniqueVarProperty

isUnique

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

IsaProperty

public IsaProperty()

Method Detail

of

public static IsaProperty of(VarPatternAdmin type)

directType

public abstract Var directType()

type

public abstract VarPatternAdmin type()

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

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

checkValidProperty

public void checkValidProperty(GraknTx graph,
                               VarPatternAdmin var)
                        throws GraqlQueryException

Throws:

GraqlQueryException

mapToAtom

@Nullable
public Atomic mapToAtom(VarPatternAdmin var,
                                  Set<VarPatternAdmin> vars,
                                  ReasonerQuery parent)

Specified by:

mapToAtom in interface VarProperty

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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

implicitInnerVarPatterns

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

Specified by:

implicitInnerVarPatterns in interface VarProperty

toString

public final String toString()

Overrides:

toString in class Object