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

Class RelationshipAtom

java.lang.Object

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

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

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

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

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

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

All Implemented Interfaces:

Atomic

public abstract class RelationshipAtom
extends IsaAtomBase

Atom implementation defining a relation atom corresponding to a combined RelationshipProperty and (optional) IsaProperty. The relation atom is a TypeAtom with relationship players.

Author:

Kasper Piskorski

Field Summary

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

applicableRules

Constructor Summary

Constructors

Constructor and Description
RelationshipAtom()

Method Summary

Modifier and Type	Method and Description
RelationshipAtom	addType(SchemaConcept type)
int	alphaEquivalenceHashCode()
List<Atom>	atomOptions(ConceptMap sub)
void	checkValid()
Atomic	copy(ReasonerQuery parent)
static RelationshipAtom	create(VarPattern pattern, Var predicateVar, ConceptId predicateId, ReasonerQuery parent)
protected Pattern	createCombinedPattern()
boolean	equals(Object obj)
java.util.stream.Stream<Predicate>	getInnerPredicates()
MultiUnifier	getMultiUnifier(Atom pAtom, UnifierComparison unifierType) find the (multi) unifier with parent atom
java.util.stream.Stream<IdPredicate>	getPartialSubstitutions()
com.google.common.collect.ImmutableList<SchemaConcept>	getPossibleTypes()
abstract com.google.common.collect.ImmutableList<RelationPlayer>	getRelationPlayers()
com.google.common.collect.Multimap<Role,String>	getRoleConceptIdMap()
Set<Var>	getRoleExpansionVariables()
abstract com.google.common.collect.ImmutableSet<Label>	getRoleLabels()
com.google.common.collect.Multimap<Role,NeqPredicate>	getRoleNeqPredicateMap()
java.util.stream.Stream<IdPredicate>	getRolePredicates()
com.google.common.collect.Multimap<Role,Type>	getRoleTypeMap()
com.google.common.collect.Multimap<Role,Type>	getRoleTypeMap(boolean inferTypes)
com.google.common.collect.Multimap<Role,ValuePredicate>	getRoleValueMap()
com.google.common.collect.Multimap<Role,Var>	getRoleVarMap()
Unifier	getUnifier(Atom pAtom, UnifierComparison unifierType) attempt to find a UNIQUE unifier with the parent atom
Set<Var>	getVarNames()
Class<? extends VarProperty>	getVarPropertyClass()
int	hashCode()
RelationshipAtom	inferTypes(ConceptMap sub)
boolean	isAlphaEquivalent(Object obj)
boolean	isRelation()
boolean	isRuleApplicableViaAtom(Atom ruleAtom)
boolean	isSelectable()
boolean	isStructurallyEquivalent(Object obj)
boolean	isType()
boolean	isUnifiableWith(Atom atom)
java.util.stream.Stream<ConceptMap>	materialise()
boolean	requiresMaterialisation()
boolean	requiresRoleExpansion()
Set<Atom>	rewriteToAtoms()
Atom	rewriteToUserDefined(Atom parentAtom) rewrites the atom to one with suitably user-defined names depending on provided parent
RelationshipAtom	rewriteWithRelationVariable() rewrites the atom to one with user defined relation variable
RelationshipAtom	rewriteWithTypeVariable()
int	structuralEquivalenceHashCode()
IsaAtom	toIsaAtom()
RelationshipAtom	toRelationshipAtom()
String	toString()
Set<String>	validateAsRuleHead(Rule rule)
Set<String>	validateOntologically()

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

unify

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

getPredicateVariable, getSchemaConcept, getTypeId, getTypePredicate, isDirect

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

getApplicableRules, getInnerPredicates, getNeighbours, getNonSelectableConstraints, getPotentialRules, getTypeConstraints, getVarProperties, inferTypes, isAtom, isBounded, isDisconnected, isGround, isRecursive, isRuleResolvable, requiresDecomposition, requiresSchema, rewriteWithTypeVariable

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

getCombinedPattern, getIdPredicate, getPredicate, getPredicates, getPredicates, isUserDefined, tx

Methods inherited from class java.lang.Object

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

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

getParentQuery, getPattern, getVarName, isCompatibleWith, isResource

Constructor Detail

RelationshipAtom

public RelationshipAtom()

Method Detail

getRelationPlayers

public abstract com.google.common.collect.ImmutableList<RelationPlayer> getRelationPlayers()

getRoleLabels

public abstract com.google.common.collect.ImmutableSet<Label> getRoleLabels()

create

public static RelationshipAtom create(VarPattern pattern,
                                      Var predicateVar,
                                      @Nullable
                                      ConceptId predicateId,
                                      ReasonerQuery parent)

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

@Memoized
public int hashCode()

Overrides:

hashCode in class Object

getVarPropertyClass

public Class<? extends VarProperty> getVarPropertyClass()

Specified by:

getVarPropertyClass in class Atom

checkValid

public void checkValid()

Specified by:

checkValid in interface Atomic

Overrides:

checkValid in class Binary

toRelationshipAtom

public RelationshipAtom toRelationshipAtom()

Overrides:

toRelationshipAtom in class Atom

toIsaAtom

public IsaAtom toIsaAtom()

Overrides:

toIsaAtom in class Atom

rewriteToAtoms

public Set<Atom> rewriteToAtoms()

Overrides:

rewriteToAtoms in class Atom

Returns:

set of atoms this atom can be decomposed to

toString

public String toString()

Overrides:

toString in class AtomicBase

getVarNames

public Set<Var> getVarNames()

Specified by:

getVarNames in interface Atomic

Overrides:

getVarNames in class Binary

copy

public Atomic copy(ReasonerQuery parent)

createCombinedPattern

protected Pattern createCombinedPattern()

Overrides:

createCombinedPattern in class Binary

isAlphaEquivalent

public boolean isAlphaEquivalent(Object obj)

Specified by:

isAlphaEquivalent in interface Atomic

Overrides:

isAlphaEquivalent in class Binary

alphaEquivalenceHashCode

public int alphaEquivalenceHashCode()

Specified by:

alphaEquivalenceHashCode in interface Atomic

Overrides:

alphaEquivalenceHashCode in class Binary

isStructurallyEquivalent

public boolean isStructurallyEquivalent(Object obj)

Specified by:

isStructurallyEquivalent in interface Atomic

Overrides:

isStructurallyEquivalent in class Binary

structuralEquivalenceHashCode

public int structuralEquivalenceHashCode()

Specified by:

structuralEquivalenceHashCode in interface Atomic

Overrides:

structuralEquivalenceHashCode in class Binary

isRelation

public boolean isRelation()

isSelectable

public boolean isSelectable()

Specified by:

isSelectable in interface Atomic

Overrides:

isSelectable in class TypeAtom

isType

public boolean isType()

Specified by:

isType in interface Atomic

Overrides:

isType in class TypeAtom

requiresMaterialisation

public boolean requiresMaterialisation()

Overrides:

requiresMaterialisation in class TypeAtom

Returns:

true if the atom requires materialisation in order to be referenced

requiresRoleExpansion

public boolean requiresRoleExpansion()

Overrides:

requiresRoleExpansion in class Atom

Returns:

true if the atom requires role expansion

validateAsRuleHead

public Set<String> validateAsRuleHead(Rule rule)

Specified by:

validateAsRuleHead in interface Atomic

Overrides:

validateAsRuleHead in class Atom

validateOntologically

public Set<String> validateOntologically()

getPartialSubstitutions

public java.util.stream.Stream<IdPredicate> getPartialSubstitutions()

Overrides:

getPartialSubstitutions in class Atom

Returns:

partial substitutions for this atom (NB: instances)

getRolePredicates

public java.util.stream.Stream<IdPredicate> getRolePredicates()

getRoleConceptIdMap

@Memoized
public com.google.common.collect.Multimap<Role,String> getRoleConceptIdMap()

Returns:

map of pairs role type - Id predicate describing the role player playing this role (substitution)

getRoleValueMap

@Memoized
public com.google.common.collect.Multimap<Role,ValuePredicate> getRoleValueMap()

getRoleNeqPredicateMap

@Memoized
public com.google.common.collect.Multimap<Role,NeqPredicate> getRoleNeqPredicateMap()

getRoleTypeMap

@Memoized
public com.google.common.collect.Multimap<Role,Type> getRoleTypeMap()

getRoleTypeMap

public com.google.common.collect.Multimap<Role,Type> getRoleTypeMap(boolean inferTypes)

isUnifiableWith

public boolean isUnifiableWith(Atom atom)

Overrides:

isUnifiableWith in class TypeAtom

isRuleApplicableViaAtom

public boolean isRuleApplicableViaAtom(Atom ruleAtom)

Overrides:

isRuleApplicableViaAtom in class TypeAtom

addType

public RelationshipAtom addType(SchemaConcept type)

Overrides:

addType in class Atom

Parameters:

type - to be added to this Atom

Returns:

new Atom with specified type

getPossibleTypes

public com.google.common.collect.ImmutableList<SchemaConcept> getPossibleTypes()

Overrides:

getPossibleTypes in class Atom

Returns:

list of types this atom can take

inferTypes

public RelationshipAtom inferTypes(ConceptMap sub)

Overrides:

inferTypes in class Atom

atomOptions

public List<Atom> atomOptions(ConceptMap sub)

Overrides:

atomOptions in class Atom

Parameters:

sub - partial substitution

Returns:

list of possible atoms obtained by applying type inference

getRoleExpansionVariables

public Set<Var> getRoleExpansionVariables()

Overrides:

getRoleExpansionVariables in class Atom

Returns:

set of variables that need to be have their roles expanded

getInnerPredicates

public java.util.stream.Stream<Predicate> getInnerPredicates()

Overrides:

getInnerPredicates in class Binary

getRoleVarMap

@Memoized
public com.google.common.collect.Multimap<Role,Var> getRoleVarMap()

Returns:

map containing roleType - (rolePlayer var - rolePlayer type) pairs

getUnifier

public Unifier getUnifier(Atom pAtom,
                          UnifierComparison unifierType)

Description copied from class: Atom

attempt to find a UNIQUE unifier with the parent atom

Overrides:

getUnifier in class Binary

Parameters:

pAtom - atom to be unified with

unifierType - type of unifier to be computed

Returns:

corresponding unifier

getMultiUnifier

public MultiUnifier getMultiUnifier(Atom pAtom,
                                    UnifierComparison unifierType)

Description copied from class: Atom

find the (multi) unifier with parent atom

Overrides:

getMultiUnifier in class Atom

Parameters:

pAtom - atom to be unified with

unifierType - type of unifier to be computed

Returns:

multiunifier

materialise

public java.util.stream.Stream<ConceptMap> materialise()

Overrides:

materialise in class Atom

rewriteWithRelationVariable

public RelationshipAtom rewriteWithRelationVariable()

Description copied from class: Atom

rewrites the atom to one with user defined relation variable

Overrides:

rewriteWithRelationVariable in class Atom

Returns:

rewritten atom

rewriteWithTypeVariable

public RelationshipAtom rewriteWithTypeVariable()

Specified by:

rewriteWithTypeVariable in class Atom

rewriteToUserDefined

public Atom rewriteToUserDefined(Atom parentAtom)

Description copied from class: Atom

rewrites the atom to one with suitably user-defined names depending on provided parent

Specified by:

rewriteToUserDefined in class Atom

Parameters:

parentAtom - parent atom that triggers rewrite

Returns:

rewritten atom