ai.grakn.graql.internal.reasoner.atom

Class Atom

java.lang.Object

ai.grakn.graql.internal.reasoner.atom.AtomBase

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

All Implemented Interfaces:

Atomic

Direct Known Subclasses:

BinaryBase

public abstract class Atom
extends AtomBase

Atom implementation defining specialised functionalities.

Author:

Kasper Piskorski

Field Summary

Fields

Modifier and Type	Field and Description
protected Type	type
protected ConceptId	typeId

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

atomPattern, varName

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Set<InferenceRule>	getApplicableRules()
Set<IdPredicate>	getIdPredicates()
Set<TypeAtom>	getMappedTypeConstraints()
Set<Atomic>	getNonSelectableConstraints()
Set<Unifier>	getPermutationUnifiers(Atom headAtom)
Set<Predicate>	getPredicates()
Map<RoleType,javafx.util.Pair<VarName,Type>>	getRoleVarTypeMap()
Type	getType()
Set<TypeAtom>	getTypeConstraints()
ConceptId	getTypeId()
Set<IdPredicate>	getUnmappedIdPredicates()
Set<TypeAtom>	getUnmappedTypeConstraints()
Set<ValuePredicate>	getValuePredicates()
VarName	getValueVariable()
boolean	hasSubstitution()
void	inferTypes() infers types (type, role types) fo the atom if applicable/possible
boolean	isAtom()
boolean	isBinary()
boolean	isRecursive()
boolean	isRelation()
boolean	isResource()
protected abstract boolean	isRuleApplicable(InferenceRule child)
boolean	isRuleResolvable()
boolean	isType()
boolean	requiresMaterialisation()
Atom	rewriteToUserDefined() rewrites the atom to one with user defined name
javafx.util.Pair<Atom,Unifier>	rewriteToUserDefinedWithUnifiers() rewrites the atom to one with user defined name, need unifiers for cases when we have variable clashes between the relation variable and relation players

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

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

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

type

protected Type type

typeId

protected ConceptId typeId

Constructor Detail

Atom

protected Atom(VarAdmin pattern,
               ReasonerQuery par)

Atom

protected Atom(Atom a)

Method Detail

isAtom

public boolean isAtom()

isBinary

public boolean isBinary()

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

hasSubstitution

public boolean hasSubstitution()

Returns:

true if atom contains a substitution (id predicates)

isRuleApplicable

protected abstract boolean isRuleApplicable(InferenceRule child)

getApplicableRules

public Set<InferenceRule> getApplicableRules()

isRuleResolvable

public boolean isRuleResolvable()

Returns:

true if the atom can be resolved by a rule (atom exists in one of the rule's head)

isRecursive

public boolean isRecursive()

Returns:

true if atom is recursive

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

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)

getRoleVarTypeMap

public Map<RoleType,javafx.util.Pair<VarName,Type>> getRoleVarTypeMap()

Returns:

map of role type- (var name, var type) pairs

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)

rewriteToUserDefinedWithUnifiers

public javafx.util.Pair<Atom,Unifier> rewriteToUserDefinedWithUnifiers()

rewrites the atom to one with user defined name, need unifiers for cases when we have variable clashes between the relation variable and relation players

Returns:

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