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

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, IdPredicate predicate, ReasonerQuery par)
Relation(VarName name, VarName typeVariable, Map<VarName,Var> roleMap, IdPredicate pred, ReasonerQuery par)

Method Summary

Modifier and Type	Method and Description
Relation	addType(Type type)
boolean	containsVar(VarName name)
Atomic	copy()
boolean	equals(Object obj)
int	equivalenceHashCode()
protected VarName	extractValueVariableName(VarAdmin var)
Set<TypeAtom>	getMappedTypeConstraints()
Set<Unifier>	getPermutationUnifiers(Atom headAtom)
Set<RelationPlayer>	getRelationPlayers()
Set<VarName>	getRolePlayers()
Map<RoleType,javafx.util.Pair<VarName,Type>>	getRoleVarTypeMap()
Unifier	getUnifier(Atomic pAtom) get unifiers by comparing this atom with parent
Set<IdPredicate>	getUnmappedIdPredicates()
Set<VarName>	getUnmappedRolePlayers()
Set<TypeAtom>	getUnmappedTypeConstraints()
Set<VarName>	getVarNames()
int	hashCode()
boolean	hasSubstitution()
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()
boolean	isType()
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
protected void	setValueVariable(VarName var)
void	unify(Unifier mappings) perform unification on the atom by applying unifiers

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

extractTypeId, getType

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

getCombinedPattern, getPredicate, predicatesEquivalent, setParentQuery, setPredicate

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

getLinkedAtoms, getValueVariable, isBinary, requiresMaterialisation

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

getApplicableRules, getIdPredicates, getNonSelectableConstraints, getPredicates, getTypeConstraints, getTypeId, getValuePredicates, isAtom, isRecursive, isResource

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

getParentQuery, getPattern, getVarName, graph, isUserDefinedName, toString

Methods inherited from class java.lang.Object

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

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

isPredicate

Constructor Detail

Relation

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

Relation

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

Method Detail

getRelationPlayers

public Set<RelationPlayer> getRelationPlayers()

extractValueVariableName

protected VarName extractValueVariableName(VarAdmin var)

Overrides:

extractValueVariableName in class TypeAtom

setValueVariable

protected void setValueVariable(VarName var)

Overrides:

setValueVariable in class TypeAtom

copy

public Atomic copy()

Specified by:

copy in interface Atomic

Overrides:

copy 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()

Specified by:

isSelectable in interface Atomic

Overrides:

isSelectable in class TypeAtom

Returns:

true if the atom can form an atomic query

isType

public boolean isType()

Overrides:

isType in class TypeAtom

Returns:

true if the atom corresponds to a atom

hasSubstitution

public boolean hasSubstitution()

Overrides:

hasSubstitution in class Atom

Returns:

true if atom contains a substitution (id predicates)

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)

addType

public Relation addType(Type type)

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

unify

public void unify(Unifier 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

getRolePlayers

public Set<VarName> getRolePlayers()

Returns:

set constituting the role player var names

getUnmappedRolePlayers

public Set<VarName> getUnmappedRolePlayers()

Returns:

set constituting the role player var names that do not have a specified role type

getUnmappedIdPredicates

public Set<IdPredicate> getUnmappedIdPredicates()

Overrides:

getUnmappedIdPredicates in class Atom

getMappedTypeConstraints

public Set<TypeAtom> getMappedTypeConstraints()

Overrides:

getMappedTypeConstraints in class Atom

getUnmappedTypeConstraints

public Set<TypeAtom> getUnmappedTypeConstraints()

Overrides:

getUnmappedTypeConstraints in class Atom

getPermutationUnifiers

public Set<Unifier> getPermutationUnifiers(Atom headAtom)

Overrides:

getPermutationUnifiers in class Atom

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

getUnifier

public Unifier getUnifier(Atomic pAtom)

Description copied from class: AtomBase

get unifiers by comparing this atom with parent

Specified by:

getUnifier in interface Atomic

Overrides:

getUnifier in class BinaryBase

Parameters:

pAtom - atom defining variable names

Returns:

unifier

rewriteToUserDefined

public Atom rewriteToUserDefined()

Description copied from class: Atom

rewrites the atom to one with user defined name

Overrides:

rewriteToUserDefined in class Atom

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

Overrides:

rewriteToUserDefinedWithUnifiers in class Atom

Returns:

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