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

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)
protected	Atom(VarAdmin pattern, Query par)

Method Summary

Modifier and Type	Method and Description
Set<Rule>	getApplicableRules()
abstract Set<Predicate>	getIdPredicates()
abstract Set<Predicate>	getPredicates()
Map<RoleType,javafx.util.Pair<VarName,Type>>	getRoleVarTypeMap()
Type	getType()
Set<Atom>	getTypeConstraints()
ConceptId	getTypeId()
abstract Set<Predicate>	getValuePredicates()
VarName	getValueVariable()
Map<VarName,javafx.util.Pair<Type,RoleType>>	getVarTypeRoleMap()
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()
javafx.util.Pair<Atom,Map<VarName,VarName>>	rewrite(Atom parent, Query q) rewrites the atom to be compatible with parent atom

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

clone, containsVar, getCombinedPattern, getParentQuery, getPattern, getSelectedNames, getUnifiers, getVarName, getVarNames, isUserDefinedName, isValueUserDefinedName, resetNames, setParentQuery, toString, unify

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.grakn.graql.internal.reasoner.atom.Atomic

equivalenceHashCode, isEquivalent, isPredicate, isSelectable

Field Detail

type

protected Type type

typeId

protected ConceptId typeId

Constructor Detail

Atom

protected Atom(VarAdmin pattern)

Atom

protected Atom(VarAdmin pattern,
               Query 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

isRuleApplicable

protected abstract boolean isRuleApplicable(InferenceRule child)

getApplicableRules

public Set<Rule> 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()

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 abstract Set<Predicate> getPredicates()

Returns:

set of predicates relevant to this atom

getIdPredicates

public abstract Set<Predicate> getIdPredicates()

Returns:

set of id predicates relevant to this atom

getValuePredicates

public abstract Set<Predicate> getValuePredicates()

Returns:

set of value predicates relevant to this atom

getTypeConstraints

public Set<Atom> getTypeConstraints()

Returns:

set of types relevant to this atom

getVarTypeRoleMap

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

Returns:

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

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

rewrite

public javafx.util.Pair<Atom,Map<VarName,VarName>> rewrite(Atom parent,
                                                           Query q)

rewrites the atom to be compatible with parent atom

Parameters:

parent - atom to be compatible with

q - query the rewritten atom should belong to

Returns:

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