RelationshipAtom (grakn-graql 1.1.0 API)

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.type.IsaAtom
        
        ai.grakn.graql.internal.reasoner.atom.binary.RelationshipAtom

All Implemented Interfaces:

Atomic
```
public class RelationshipAtom
extends IsaAtom
```
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

Constructor Summary

Constructors
Constructor and Description

RelationshipAtom(VarPattern pattern, Var predicateVar, IdPredicate predicate, ReasonerQuery par)

Constructors
Constructor and Description
`RelationshipAtom(VarPattern pattern, Var predicateVar, IdPredicate predicate, ReasonerQuery par)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RelationshipAtom`	`addType(SchemaConcept type)`
`int`	`alphaEquivalenceHashCode()`
`List<Atom>`	`atomOptions(Answer sub)`
`void`	`checkValid()`
`int`	`computePriority(Set<Var> subbedVars)` compute resolution priority based on provided substitution variables
`Atomic`	`copy()`
`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()`
`Set<Var>`	`getRoleExpansionVariables()`
`java.util.stream.Stream<IdPredicate>`	`getRolePredicates()`
`com.google.common.collect.Multimap<Role,Var>`	`getRoleVarMap()`
`Set<TypeAtom>`	`getSpecificTypeConstraints()`
`Unifier`	`getUnifier(Atom pAtom)`
`Set<Var>`	`getVarNames()`
`Class<? extends VarProperty>`	`getVarPropertyClass()`
`int`	`hashCode()`
`com.google.common.collect.ImmutableList<Type>`	`inferPossibleTypes(Answer sub)` infer `RelationshipType`s that this `RelationshipAtom` can potentially have NB: `EntityType`s and link `Role`s are treated separately as they behave differently: `EntityType`s only play the explicitly defined `Role`s (not the relevant part of the hierarchy of the specified `Role`) and the `Role` inherited from parent
`RelationshipAtom`	`inferTypes(Answer sub)`
`boolean`	`isAlphaEquivalent(Object obj)`
`boolean`	`isRelation()`
`boolean`	`isRuleApplicableViaAtom(Atom ruleAtom)`
`boolean`	`isSelectable()`
`boolean`	`isStructurallyEquivalent(Object obj)`
`boolean`	`isType()`
`java.util.stream.Stream<Answer>`	`materialise()`
`boolean`	`requiresMaterialisation()`
`boolean`	`requiresRoleExpansion()`
`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()`
`RelationshipAtom`	`toRelationshipAtom()`
`String`	`toString()`
`Set<String>`	`validateAsRuleHead(Rule rule)`
`Set<String>`	`validateOntologically()`

Methods inherited from class ai.grakn.graql.internal.reasoner.atom.binary.type.IsaAtom
getTypedPair, unify

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

Methods inherited from class ai.grakn.graql.internal.reasoner.atom.binary.Binary
getPredicateVariable, getTypeId, getTypePredicate, setParentQuery

Methods inherited from class ai.grakn.graql.internal.reasoner.atom.Atom
getApplicableRules, getIdPredicate, getInnerPredicates, getNeighbours, getNonSelectableConstraints, getPotentialRules, getPredicate, getPredicates, getPredicates, getTypeConstraints, getVarProperties, inferTypes, isAtom, isGround, isRecursive, isRuleResolvable, rewriteWithTypeVariable

Methods inherited from class ai.grakn.graql.internal.reasoner.atom.AtomicBase
containsVar, getCombinedPattern, getParentQuery, getPattern, getVarName, 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
isCompatibleWith, isResource

- Constructor Detail
  - RelationshipAtom
```
public RelationshipAtom(VarPattern pattern,
                        Var predicateVar,
                        @Nullable
                        IdPredicate predicate,
                        ReasonerQuery par)
```
- Method Detail
  - getVarPropertyClass
```
public Class<? extends VarProperty> getVarPropertyClass()
```
    Overrides:
    
    getVarPropertyClass in class IsaAtom
  - checkValid
```
public void checkValid()
```
    Specified by:
    
    checkValid in interface Atomic
    
    Overrides:
    
    checkValid in class Binary
  - toRelationshipAtom
```
public RelationshipAtom toRelationshipAtom()
```
    Overrides:
    
    toRelationshipAtom in class Atom
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class IsaAtom
  - copy
```
public Atomic copy()
```
    Specified by:
    
    copy in interface Atomic
    
    Overrides:
    
    copy in class IsaAtom
  - createCombinedPattern
```
protected Pattern createCombinedPattern()
```
    Overrides:
    
    createCombinedPattern in class IsaAtom
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class TypeAtom
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class TypeAtom
  - 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()
```
  - computePriority
```
public int computePriority(Set<Var> subbedVars)
```
    Description copied from class: Atom
    
    compute resolution priority based on provided substitution variables
    
    Overrides:
    
    computePriority in class TypeAtom
    
    Parameters:
    
    subbedVars - variables having a substitution
    
    Returns:
    
    resolution priority value
  - 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()
```
  - isRuleApplicableViaAtom
```
public boolean isRuleApplicableViaAtom(Atom ruleAtom)
```
    Overrides:
    
    isRuleApplicableViaAtom in class TypeAtom
  - addType
```
public RelationshipAtom addType(SchemaConcept type)
```
    Overrides:
    
    addType in class IsaAtom
    
    Parameters:
    
    type - to be added to this Atom
    
    Returns:
    
    new Atom with specified type
  - inferPossibleTypes
```
public com.google.common.collect.ImmutableList<Type> inferPossibleTypes(Answer sub)
```
    infer RelationshipTypes that this RelationshipAtom can potentially have NB: EntityTypes and link Roles are treated separately as they behave differently: EntityTypes only play the explicitly defined Roles (not the relevant part of the hierarchy of the specified Role) and the Role inherited from parent
    
    Returns:
    
    list of RelationshipTypes this atom can have ordered by the number of compatible Roles
  - inferTypes
```
public RelationshipAtom inferTypes(Answer sub)
```
    Overrides:
    
    inferTypes in class IsaAtom
  - atomOptions
```
public List<Atom> atomOptions(Answer sub)
```
    Overrides:
    
    atomOptions in class IsaAtom
    
    Parameters:
    
    sub - partial substitution
    
    Returns:
    
    list of possible atoms obtained by applying type inference
  - getVarNames
```
public Set<Var> getVarNames()
```
    Specified by:
    
    getVarNames in interface Atomic
    
    Overrides:
    
    getVarNames in class Binary
  - getRoleExpansionVariables
```
public Set<Var> getRoleExpansionVariables()
```
    Overrides:
    
    getRoleExpansionVariables in class Atom
    
    Returns:
    
    set of variables that need to be have their roles expanded
  - getSpecificTypeConstraints
```
public Set<TypeAtom> getSpecificTypeConstraints()
```
    Overrides:
    
    getSpecificTypeConstraints in class Atom
    
    Returns:
    
    set of type atoms that describe specific role players or resource owner
  - getInnerPredicates
```
public java.util.stream.Stream<Predicate> getInnerPredicates()
```
    Overrides:
    
    getInnerPredicates in class Binary
  - getRoleVarMap
```
public com.google.common.collect.Multimap<Role,Var> getRoleVarMap()
```
    Returns:
    
    map containing roleType - (rolePlayer var - rolePlayer type) pairs
  - getUnifier
```
public Unifier getUnifier(Atom pAtom)
```
    Overrides:
    
    getUnifier in class Binary
    
    Parameters:
    
    pAtom - atom to be unified with
    
    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<Answer> materialise()
```
    Overrides:
    
    materialise in class IsaAtom
  - 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()
```
    Overrides:
    
    rewriteWithTypeVariable in class IsaAtom
  - 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
    
    Overrides:
    
    rewriteToUserDefined in class IsaAtom
    
    Parameters:
    
    parentAtom - parent atom that triggers rewrite
    
    Returns:
    
    rewritten atom

Class RelationshipAtom

Constructor Summary

Method Summary

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

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

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

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RelationshipAtom

Method Detail

getVarPropertyClass

checkValid

toRelationshipAtom

toString

copy

createCombinedPattern

equals

hashCode

isAlphaEquivalent

alphaEquivalenceHashCode

isStructurallyEquivalent

structuralEquivalenceHashCode

isRelation

isSelectable

isType

requiresMaterialisation

requiresRoleExpansion

validateAsRuleHead

validateOntologically

computePriority

getPartialSubstitutions

getRolePredicates

isRuleApplicableViaAtom

addType

inferPossibleTypes

inferTypes

atomOptions

getVarNames

getRoleExpansionVariables

getSpecificTypeConstraints

getInnerPredicates

getRoleVarMap

getUnifier

getMultiUnifier

materialise

rewriteWithRelationVariable

rewriteWithTypeVariable

rewriteToUserDefined