ai.grakn.graql.internal.reasoner.atom.binary

Class Relation

java.lang.Object

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

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

ai.grakn.graql.internal.reasoner.atom.binary.BinaryBase

ai.grakn.graql.internal.reasoner.atom.binary.Binary

ai.grakn.graql.internal.reasoner.atom.binary.TypeAtom

ai.grakn.graql.internal.reasoner.atom.binary.Relation

All Implemented Interfaces:

Atomic, Cloneable

public class Relation
extends TypeAtom

Atom implementation defining a relation atom.

Author:

Kasper Piskorski

Field Summary

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

type, typeId

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

atomPattern, varName

Constructor Summary

Constructors

Constructor and Description
Relation(VarAdmin pattern)
Relation(VarAdmin pattern, IdPredicate predicate, Query par)
Relation(VarAdmin pattern, Query par)
Relation(VarName name, VarName typeVariable, Map<VarName,Var> roleMap, IdPredicate pred, Query par)

Method Summary

Modifier and Type	Method and Description
Atomic	clone()
boolean	containsVar(VarName name)
boolean	equals(Object obj)
int	equivalenceHashCode()
protected VarName	extractValueVariableName(VarAdmin var)
Set<Predicate>	getIdPredicates()
Set<VarName>	getRolePlayers()
Map<RoleType,javafx.util.Pair<VarName,Type>>	getRoleVarTypeMap()
Set<VarName>	getSelectedNames()
Map<VarName,VarName>	getUnifiers(Atomic pAtom) get unifiers by comparing this atom with parent
Set<VarName>	getVarNames()
Map<VarName,javafx.util.Pair<Type,RoleType>>	getVarTypeRoleMap()
int	hashCode()
void	inferTypes() infers types (type, role types) fo the atom if applicable/possible
boolean	isEquivalent(Object obj)
boolean	isRelation()
protected boolean	isRuleApplicable(InferenceRule child)
boolean	isRuleResolvable()
boolean	isSelectable()
javafx.util.Pair<Atom,Map<VarName,VarName>>	rewrite(Atom parentAtom, Query parent) rewrites the atom to be compatible with parent atom
protected void	setValueVariable(VarName var)
void	unify(Map<VarName,VarName> mappings) perform unification on the atom by applying unifiers

Methods inherited from class ai.grakn.graql.internal.reasoner.atom.binary.TypeAtom

extractTypeId, getType, isType

Methods inherited from class ai.grakn.graql.internal.reasoner.atom.binary.Binary

getCombinedPattern, getPredicate, isValueUserDefinedName, predicatesEquivalent, setParentQuery, setPredicate

Methods inherited from class ai.grakn.graql.internal.reasoner.atom.binary.BinaryBase

getLinkedAtoms, getPredicates, getValuePredicates, getValueVariable, isBinary, requiresMaterialisation

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

getApplicableRules, getTypeConstraints, getTypeId, isAtom, isRecursive, isResource

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

getParentQuery, getPattern, getVarName, isUserDefinedName, resetNames, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

isPredicate

Constructor Detail

Relation

public Relation(VarAdmin pattern)

Relation

public Relation(VarAdmin pattern,
                Query par)

Relation

public Relation(VarAdmin pattern,
                IdPredicate predicate,
                Query par)

Relation

public Relation(VarName name,
                VarName typeVariable,
                Map<VarName,Var> roleMap,
                IdPredicate pred,
                Query par)

Method Detail

extractValueVariableName

protected VarName extractValueVariableName(VarAdmin var)

Overrides:

extractValueVariableName in class TypeAtom

setValueVariable

protected void setValueVariable(VarName var)

Overrides:

setValueVariable in class TypeAtom

clone

public Atomic clone()

Specified by:

clone in interface Atomic

Overrides:

clone in class TypeAtom

equals

public boolean equals(Object obj)

Overrides:

equals in class BinaryBase

hashCode

public int hashCode()

Overrides:

hashCode in class BinaryBase

isEquivalent

public boolean isEquivalent(Object obj)

Specified by:

isEquivalent in interface Atomic

Overrides:

isEquivalent in class BinaryBase

Returns:

true if atom alpha-equivalent

equivalenceHashCode

public int equivalenceHashCode()

Specified by:

equivalenceHashCode in interface Atomic

Overrides:

equivalenceHashCode in class Binary

Returns:

equivalence hash code

isRelation

public boolean isRelation()

Overrides:

isRelation in class Atom

Returns:

true if the atom corresponds to a non-unary atom

isSelectable

public boolean isSelectable()

Returns:

true if the atom can form an atomic query

isRuleApplicable

protected boolean isRuleApplicable(InferenceRule child)

Overrides:

isRuleApplicable in class BinaryBase

isRuleResolvable

public boolean isRuleResolvable()

Specified by:

isRuleResolvable in interface Atomic

Overrides:

isRuleResolvable in class Atom

Returns:

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

inferTypes

public void inferTypes()

Description copied from class: Atom

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

Overrides:

inferTypes in class Atom

containsVar

public boolean containsVar(VarName name)

Specified by:

containsVar in interface Atomic

Overrides:

containsVar in class AtomBase

Parameters:

name - variable name

Returns:

true if atom contains an occurrence of the variable name

getIdPredicates

public Set<Predicate> getIdPredicates()

Overrides:

getIdPredicates in class TypeAtom

Returns:

set of id predicates relevant to this atom

unify

public void unify(Map<VarName,VarName> mappings)

Description copied from class: AtomBase

perform unification on the atom by applying unifiers

Specified by:

unify in interface Atomic

Overrides:

unify in class Binary

Parameters:

mappings - contain variable mappings to be applied

getVarNames

public Set<VarName> getVarNames()

Specified by:

getVarNames in interface Atomic

Overrides:

getVarNames in class BinaryBase

Returns:

all addressable variable names in the atom

getSelectedNames

public Set<VarName> getSelectedNames()

Overrides:

getSelectedNames in class BinaryBase

getRolePlayers

public Set<VarName> getRolePlayers()

getVarTypeRoleMap

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

Overrides:

getVarTypeRoleMap in class Atom

Returns:

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

getRoleVarTypeMap

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

Overrides:

getRoleVarTypeMap in class Atom

Returns:

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

getUnifiers

public Map<VarName,VarName> getUnifiers(Atomic pAtom)

Description copied from class: AtomBase

get unifiers by comparing this atom with parent

Specified by:

getUnifiers in interface Atomic

Overrides:

getUnifiers in class BinaryBase

Parameters:

pAtom - atom defining variable names

Returns:

map of unifiers

rewrite

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

Description copied from class: Atom

rewrites the atom to be compatible with parent atom

Overrides:

rewrite in class Atom

Parameters:

parentAtom - atom to be compatible with

parent - query the rewritten atom should belong to

Returns:

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