ResourceAtom (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.ResourceAtom

All Implemented Interfaces:

Atomic
```
public class ResourceAtom
extends Binary
```
Atom implementation defining a resource atom corresponding to a HasAttributeProperty. The resource structure is the following: has($varName, $predicateVariable = resource variable), type($predicateVariable) or in graql terms: $varName has $predicateVariable; $predicateVariable isa ;

Author:

Kasper Piskorski

Constructor Summary

Constructors
Constructor and Description
`ResourceAtom(VarPattern pattern, Var attributeVar, Var relationVariable, IdPredicate idPred, Set<ValuePredicate> ps, ReasonerQuery par)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`alphaEquivalenceHashCode()`
`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()`
`Set<ValuePredicate>`	`getMultiPredicate()`
`Var`	`getRelationVariable()`
`Set<TypeAtom>`	`getSpecificTypeConstraints()`
`Unifier`	`getUnifier(Atom parentAtom)`
`Set<Var>`	`getVarNames()`
`Class<? extends VarProperty>`	`getVarPropertyClass()`
`int`	`hashCode()`
`boolean`	`isResource()`
`boolean`	`isRuleApplicableViaAtom(Atom ruleAtom)`
`boolean`	`isSelectable()`
`java.util.stream.Stream<Answer>`	`materialise()`
`boolean`	`requiresMaterialisation()`
`Atom`	`rewriteToUserDefined(Atom parentAtom)` rewrites the atom to one with suitably user-defined names depending on provided parent
`ResourceAtom`	`rewriteWithRelationVariable()` rewrites the atom to one with user defined relation variable
`Atom`	`rewriteWithTypeVariable()`
`void`	`setParentQuery(ReasonerQuery q)`
`RelationshipAtom`	`toRelationshipAtom()`
`String`	`toString()`
`Set<String>`	`validateAsRuleHead(Rule rule)`
`Set<String>`	`validateOntologically()`

Methods inherited from class ai.grakn.graql.internal.reasoner.atom.binary.Binary
checkValid, getPredicateVariable, getSchemaConcept, getTypeId, getTypePredicate, isAlphaEquivalent, isStructurallyEquivalent, structuralEquivalenceHashCode

Methods inherited from class ai.grakn.graql.internal.reasoner.atom.Atom
addType, atomOptions, getApplicableRules, getIdPredicate, getInnerPredicates, getMultiUnifier, getNeighbours, getNonSelectableConstraints, getPartialSubstitutions, getPotentialRules, getPredicate, getPredicates, getPredicates, getRoleExpansionVariables, getTypeConstraints, getVarProperties, inferTypes, inferTypes, isAtom, isGround, isRecursive, isRuleResolvable, requiresRoleExpansion, 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, isRelation, isType

- Constructor Detail
  - ResourceAtom
```
public ResourceAtom(VarPattern pattern,
                    Var attributeVar,
                    Var relationVariable,
                    @Nullable
                    IdPredicate idPred,
                    Set<ValuePredicate> ps,
                    ReasonerQuery par)
```
- Method Detail
  - getVarPropertyClass
```
public Class<? extends VarProperty> getVarPropertyClass()
```
    Specified by:
    
    getVarPropertyClass in class Atom
  - toRelationshipAtom
```
public RelationshipAtom toRelationshipAtom()
```
    Overrides:
    
    toRelationshipAtom in class Atom
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AtomicBase
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - alphaEquivalenceHashCode
```
public int alphaEquivalenceHashCode()
```
    Specified by:
    
    alphaEquivalenceHashCode in interface Atomic
    
    Overrides:
    
    alphaEquivalenceHashCode in class Binary
  - setParentQuery
```
public void setParentQuery(ReasonerQuery q)
```
    Specified by:
    
    setParentQuery in interface Atomic
    
    Overrides:
    
    setParentQuery in class Binary
  - getMultiPredicate
```
public Set<ValuePredicate> getMultiPredicate()
```
  - getRelationVariable
```
public Var getRelationVariable()
```
  - createCombinedPattern
```
protected Pattern createCombinedPattern()
```
    Overrides:
    
    createCombinedPattern in class Binary
  - isRuleApplicableViaAtom
```
public boolean isRuleApplicableViaAtom(Atom ruleAtom)
```
    Specified by:
    
    isRuleApplicableViaAtom in class Atom
  - copy
```
public Atomic copy()
```
    Specified by:
    
    copy in interface Atomic
    
    Specified by:
    
    copy in class AtomicBase
  - isResource
```
public boolean isResource()
```
  - isSelectable
```
public boolean isSelectable()
```
  - requiresMaterialisation
```
public boolean requiresMaterialisation()
```
    Overrides:
    
    requiresMaterialisation in class Atom
    
    Returns:
    
    true if the atom requires materialisation in order to be referenced
  - validateAsRuleHead
```
public Set<String> validateAsRuleHead(Rule rule)
```
    Specified by:
    
    validateAsRuleHead in interface Atomic
    
    Overrides:
    
    validateAsRuleHead in class Atom
  - getVarNames
```
public Set<Var> getVarNames()
```
    Specified by:
    
    getVarNames in interface Atomic
    
    Overrides:
    
    getVarNames in class Binary
  - 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 Atom
    
    Parameters:
    
    subbedVars - variables having a substitution
    
    Returns:
    
    resolution priority value
  - getUnifier
```
public Unifier getUnifier(Atom parentAtom)
```
    Overrides:
    
    getUnifier in class Binary
    
    Parameters:
    
    parentAtom - atom to be unified with
    
    Returns:
    
    corresponding unifier
  - getInnerPredicates
```
public java.util.stream.Stream<Predicate> getInnerPredicates()
```
    Overrides:
    
    getInnerPredicates in class Binary
  - getSpecificTypeConstraints
```
public Set<TypeAtom> getSpecificTypeConstraints()
```
    Overrides:
    
    getSpecificTypeConstraints in class Atom
    
    Returns:
    
    set of type atoms that describe specific role players or resource owner
  - materialise
```
public java.util.stream.Stream<Answer> materialise()
```
    Overrides:
    
    materialise in class Atom
  - rewriteWithRelationVariable
```
public ResourceAtom 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 Atom 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

Class ResourceAtom

Constructor Summary

Method Summary

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

ResourceAtom

Method Detail

getVarPropertyClass

toRelationshipAtom

toString

equals

hashCode

alphaEquivalenceHashCode

setParentQuery

getMultiPredicate

getRelationVariable

createCombinedPattern

isRuleApplicableViaAtom

copy

isResource

isSelectable

requiresMaterialisation

validateAsRuleHead

getVarNames

validateOntologically

computePriority

getUnifier

getInnerPredicates

getSpecificTypeConstraints

materialise

rewriteWithRelationVariable

rewriteWithTypeVariable

rewriteToUserDefined