ai.grakn.graql.internal.reasoner.atom

Class Atom

java.lang.Object

ai.grakn.graql.internal.reasoner.atom.AtomicBase

ai.grakn.graql.internal.reasoner.atom.Atom

All Implemented Interfaces:

Atomic

Direct Known Subclasses:

BinaryBase

public abstract class Atom
extends AtomicBase

AtomicBase extension defining specialised functionalities.

Author:

Kasper Piskorski

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<InferenceRule>	applicableRules
protected ConceptId	typeId

Fields inherited from class ai.grakn.graql.internal.reasoner.atom.AtomicBase

atomPattern

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Atom(Atom a)
protected	Atom(VarPatternAdmin pattern, ReasonerQuery par)

Method Summary

Modifier and Type	Method and Description
int	baseResolutionPriority()
int	computePriority() compute base resolution priority of this atom
int	computePriority(Set<Var> subbedVars) compute resolution priority based on provided substitution variables
Set<InferenceRule>	getApplicableRules()
Set<IdPredicate>	getIdPredicates()
Set<TypeAtom>	getMappedTypeConstraints()
java.util.stream.Stream<Atom>	getNeighbours()
Set<Atomic>	getNonSelectableConstraints()
Set<IdPredicate>	getPartialSubstitutions()
Set<Unifier>	getPermutationUnifiers(Atom headAtom)
Set<Predicate>	getPredicates()
Type	getType()
Set<TypeAtom>	getTypeConstraints()
ConceptId	getTypeId()
abstract Unifier	getUnifier(Atom parentAtom) find unifier with parent atom
Set<IdPredicate>	getUnmappedIdPredicates()
Set<TypeAtom>	getUnmappedTypeConstraints()
Set<ValuePredicate>	getValuePredicates()
Var	getValueVariable()
void	inferTypes() infers types (type, role types) fo the atom if applicable/possible
boolean	isAllowedToFormRuleHead()
boolean	isAtom()
boolean	isRecursive()
boolean	isRelation()
boolean	isResource()
abstract boolean	isRuleApplicable(InferenceRule child)
boolean	isRuleResolvable()
boolean	isType()
boolean	requiresMaterialisation()
Atom	rewriteToUserDefined() rewrites the atom to one with user defined name

Methods inherited from class ai.grakn.graql.internal.reasoner.atom.AtomicBase

containsVar, copy, getCombinedPattern, getParentQuery, getPattern, getVarName, getVarNames, graph, isUserDefinedName, setParentQuery, toString

Methods inherited from class java.lang.Object

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

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

equivalenceHashCode, isEquivalent, isPredicate, isSelectable

Field Detail

typeId

protected ConceptId typeId

applicableRules

protected Set<InferenceRule> applicableRules

Constructor Detail

Atom

protected Atom(VarPatternAdmin pattern,
               ReasonerQuery par)

Atom

protected Atom(Atom a)

Method Detail

isAtom

public boolean isAtom()

isType

public boolean isType()

Returns:

true if the atom corresponds to a atom

isRelation

public boolean isRelation()

Returns:

true if the atom corresponds to a non-unary atom

isResource

public boolean isResource()

Returns:

true if the atom corresponds to a resource atom

getPartialSubstitutions

public Set<IdPredicate> getPartialSubstitutions()

Returns:

partial substitutions for this atom (NB: instances)

computePriority

public int computePriority()

compute base resolution priority of this atom

Returns:

priority value

computePriority

public int computePriority(Set<Var> subbedVars)

compute resolution priority based on provided substitution variables

Parameters:

subbedVars - variables having a substitution

Returns:

resolution priority value

baseResolutionPriority

public int baseResolutionPriority()

Returns:

measure of priority with which this atom should be resolved

isRuleApplicable

public abstract boolean isRuleApplicable(InferenceRule child)

getApplicableRules

public Set<InferenceRule> getApplicableRules()

Returns:

set of applicable rules - does detailed (slow) check for applicability

isRuleResolvable

public boolean isRuleResolvable()

isRecursive

public boolean isRecursive()

isAllowedToFormRuleHead

public boolean isAllowedToFormRuleHead()

Returns:

true if the atom can constitute a head of a rule

requiresMaterialisation

public boolean requiresMaterialisation()

Returns:

true if the atom requires materialisation in order to be referenced

getType

public Type getType()

Returns:

corresponding type if any

getTypeId

public ConceptId getTypeId()

Returns:

type id of the corresponding type if any

getValueVariable

public Var getValueVariable()

Returns:

value variable name

getPredicates

public Set<Predicate> getPredicates()

Returns:

set of predicates relevant to this atom

getIdPredicates

public Set<IdPredicate> getIdPredicates()

Returns:

set of id predicates relevant to this atom

getValuePredicates

public Set<ValuePredicate> getValuePredicates()

Returns:

set of value predicates relevant to this atom

getTypeConstraints

public Set<TypeAtom> getTypeConstraints()

Returns:

set of types relevant to this atom

getNeighbours

public java.util.stream.Stream<Atom> getNeighbours()

Returns:

neighbours of this atoms, i.e. atoms connected to this atom via shared variable

getNonSelectableConstraints

public Set<Atomic> getNonSelectableConstraints()

Returns:

set of constraints of this atom (predicates + types) that are not selectable

getUnmappedIdPredicates

public Set<IdPredicate> getUnmappedIdPredicates()

getUnmappedTypeConstraints

public Set<TypeAtom> getUnmappedTypeConstraints()

getMappedTypeConstraints

public Set<TypeAtom> getMappedTypeConstraints()

getPermutationUnifiers

public Set<Unifier> getPermutationUnifiers(Atom headAtom)

inferTypes

public void inferTypes()

infers types (type, role types) fo the atom if applicable/possible

rewriteToUserDefined

public Atom rewriteToUserDefined()

rewrites the atom to one with user defined name

Returns:

pair of (rewritten atom, unifiers required to unify child with rewritten atom)

getUnifier

public abstract Unifier getUnifier(Atom parentAtom)

find unifier with parent atom

Parameters:

parentAtom - atom to be unified with

Returns:

unifier