AbstractVarPattern (Grakn 0.16.0 API)

java.lang.Object
- ai.grakn.graql.internal.pattern.AbstractPattern
- - ai.grakn.graql.internal.pattern.AbstractVarPattern

All Implemented Interfaces:

PatternAdmin, VarPatternAdmin, Pattern, VarPattern
```
public abstract class AbstractVarPattern
extends AbstractPattern
implements VarPatternAdmin
```
Abstract implementation of VarPatternAdmin.

Author:

Felix Chapman

Constructor Summary

Constructors
Constructor and Description

AbstractVarPattern()

Constructors
Constructor and Description
`AbstractVarPattern()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`VarPatternAdmin`	`admin()`
`Set<Var>`	`commonVarNames()` Get all common, user-defined variable names in the pattern.
`VarPattern`	`datatype(ResourceType.DataType<?> datatype)`
`Disjunction<Conjunction<VarPatternAdmin>>`	`getDisjunctiveNormalForm()` Get the disjunctive normal form of this pattern group.
`Optional<ConceptId>`	`getId()`
`Collection<VarPatternAdmin>`	`getImplicitInnerVars()` Get all inner variables, including implicit variables such as in a has property
`Collection<VarPatternAdmin>`	`getInnerVars()`
`String`	`getPrintableName()`
`java.util.stream.Stream<VarProperty>`	`getProperties()` Get a stream of all properties on this variable
`<T extends VarProperty> java.util.stream.Stream<T>`	`getProperties(Class<T> type)` Get a stream of all properties of a particular type on this variable
`<T extends UniqueVarProperty> Optional<T>`	`getProperty(Class<T> type)` Get a unique property of a particular type on this variable, if it exists
`Optional<Label>`	`getTypeLabel()`
`Set<Label>`	`getTypeLabels()`
`abstract Var`	`getVarName()`
`VarPattern`	`has(Label type, VarPattern varPattern)` the variable must have a resource of the given type that matches the given atom
`VarPattern`	`has(String type)`
`VarPattern`	`has(String type, Object value)` the variable must have a resource of the given type with an exact matching value
`VarPattern`	`has(String type, ValuePredicate predicate)` the variable must have a resource of the given type that matches the given atom
`VarPattern`	`has(String type, VarPattern varPattern)` the variable must have a resource of the given type that matches the given atom
`VarPattern`	`has(VarPattern type)`
`<T extends VarProperty> boolean`	`hasProperty(Class<T> type)` Get whether this `VarPattern` has a `VarProperty` of the given type
`VarPattern`	`hasScope(VarPattern type)`
`VarPattern`	`id(ConceptId id)`
`VarPattern`	`isa(String type)`
`VarPattern`	`isa(VarPattern type)`
`VarPattern`	`isAbstract()` set this concept type variable as abstract, meaning it cannot have direct instances
`VarPattern`	`key(String type)`
`VarPattern`	`key(VarPattern type)`
`VarPattern`	`label(Label label)`
`VarPattern`	`label(String label)`
`VarPattern`	`neq(String var)` Specify that the variable is different to another variable
`VarPattern`	`neq(VarPattern varPattern)` Specify that the variable is different to another variable
`VarPattern`	`plays(String type)`
`VarPattern`	`plays(VarPattern type)`
`protected abstract Set<VarProperty>`	`properties()`
`VarPattern`	`regex(String regex)` Specify the regular expression instances of this resource type must match
`VarPattern`	`rel(String roleplayer)` the variable must be a relation with the given roleplayer
`VarPattern`	`rel(String role, String roleplayer)` the variable must be a relation with the given roleplayer playing the given `Role`
`VarPattern`	`rel(String role, VarPattern roleplayer)` the variable must be a relation with the given roleplayer playing the given `Role`
`VarPattern`	`rel(VarPattern roleplayer)` the variable must be a relation with the given roleplayer
`VarPattern`	`rel(VarPattern role, String roleplayer)` the variable must be a relation with the given roleplayer playing the given `Role`
`VarPattern`	`rel(VarPattern role, VarPattern roleplayer)` the variable must be a relation with the given roleplayer playing the given `Role`
`VarPattern`	`relates(String type)`
`VarPattern`	`relates(VarPattern type)`
`VarPattern`	`sub(String type)`
`VarPattern`	`sub(VarPattern type)`
`VarPattern`	`then(Pattern then)`
`VarPattern`	`val(Object value)`
`VarPattern`	`val(ValuePredicate predicate)`
`VarPattern`	`when(Pattern when)`

Methods inherited from class ai.grakn.graql.internal.pattern.AbstractPattern
and, or

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ai.grakn.graql.admin.VarPatternAdmin
asVar, isVar

Methods inherited from interface ai.grakn.graql.admin.PatternAdmin
asConjunction, asDisjunction, getVars, isConjunction, isDisjunction

Methods inherited from interface ai.grakn.graql.Pattern
and, or

- Constructor Detail
  - AbstractVarPattern
```
public AbstractVarPattern()
```
- Method Detail
  - getVarName
```
public abstract Var getVarName()
```
    Specified by:
    
    getVarName in interface VarPatternAdmin
    
    Returns:
    
    the variable name of this variable
  - properties
```
protected abstract Set<VarProperty> properties()
```
  - admin
```
public final VarPatternAdmin admin()
```
    Specified by:
    
    admin in interface Pattern
    
    Specified by:
    
    admin in interface VarPattern
    
    Returns:
    
    an Admin class that allows inspecting or manipulating this pattern
  - getId
```
public final Optional<ConceptId> getId()
```
    Specified by:
    
    getId in interface VarPatternAdmin
    
    Returns:
    
    the ID this variable represents, if it represents something with a specific ID
  - getTypeLabel
```
public final Optional<Label> getTypeLabel()
```
    Specified by:
    
    getTypeLabel in interface VarPatternAdmin
    
    Returns:
    
    the name this variable represents, if it represents something with a specific name
  - getProperties
```
public final <T extends VarProperty> java.util.stream.Stream<T> getProperties(Class<T> type)
```
    Description copied from interface: VarPatternAdmin
    
    Get a stream of all properties of a particular type on this variable
    
    Specified by:
    
    getProperties in interface VarPatternAdmin
    
    Type Parameters:
    
    T - the type of VarProperty to return
    
    Parameters:
    
    type - the class of VarProperty to return
  - getProperty
```
public final <T extends UniqueVarProperty> Optional<T> getProperty(Class<T> type)
```
    Description copied from interface: VarPatternAdmin
    
    Get a unique property of a particular type on this variable, if it exists
    
    Specified by:
    
    getProperty in interface VarPatternAdmin
    
    Type Parameters:
    
    T - the type of VarProperty to return
    
    Parameters:
    
    type - the class of VarProperty to return
  - hasProperty
```
public final <T extends VarProperty> boolean hasProperty(Class<T> type)
```
    Description copied from interface: VarPatternAdmin
    
    Get whether this VarPattern has a VarProperty of the given type
    
    Specified by:
    
    hasProperty in interface VarPatternAdmin
    
    Type Parameters:
    
    T - the type of the VarProperty
    
    Parameters:
    
    type - the type of the VarProperty
    
    Returns:
    
    whether this VarPattern has a VarProperty of the given type
  - getInnerVars
```
public final Collection<VarPatternAdmin> getInnerVars()
```
    Specified by:
    
    getInnerVars in interface VarPatternAdmin
    
    Returns:
    
    all variables that this variable references
  - getImplicitInnerVars
```
public final Collection<VarPatternAdmin> getImplicitInnerVars()
```
    Description copied from interface: VarPatternAdmin
    
    Get all inner variables, including implicit variables such as in a has property
    
    Specified by:
    
    getImplicitInnerVars in interface VarPatternAdmin
  - getTypeLabels
```
public final Set<Label> getTypeLabels()
```
    Specified by:
    
    getTypeLabels in interface VarPatternAdmin
    
    Returns:
    
    all type names that this variable refers to
  - getDisjunctiveNormalForm
```
public final Disjunction<Conjunction<VarPatternAdmin>> getDisjunctiveNormalForm()
```
    Description copied from interface: PatternAdmin
    
    Get the disjunctive normal form of this pattern group. This means the pattern group will be transformed into a number of conjunctive patterns, where each is disjunct. e.g. p = (A or B) and (C or D) p.getDisjunctiveNormalForm() = (A and C) or (A and D) or (B and C) or (B and D)
    
    Specified by:
    
    getDisjunctiveNormalForm in interface PatternAdmin
    
    Returns:
    
    the pattern group in disjunctive normal form
  - commonVarNames
```
public final Set<Var> commonVarNames()
```
    Description copied from interface: PatternAdmin
    
    Get all common, user-defined variable names in the pattern.
    
    Specified by:
    
    commonVarNames in interface PatternAdmin
  - id
```
public final VarPattern id(ConceptId id)
```
    Specified by:
    
    id in interface VarPattern
    
    Parameters:
    
    id - a ConceptId that this variable's ID must match
    
    Returns:
    
    this
  - label
```
public final VarPattern label(String label)
```
    Specified by:
    
    label in interface VarPattern
    
    Parameters:
    
    label - a string that this variable's label must match
    
    Returns:
    
    this
  - label
```
public final VarPattern label(Label label)
```
    Specified by:
    
    label in interface VarPattern
    
    Parameters:
    
    label - a type label that this variable's label must match
    
    Returns:
    
    this
  - val
```
public final VarPattern val(Object value)
```
    Specified by:
    
    val in interface VarPattern
    
    Parameters:
    
    value - a value that this variable's value must exactly match
    
    Returns:
    
    this
  - val
```
public final VarPattern val(ValuePredicate predicate)
```
    Specified by:
    
    val in interface VarPattern
    
    Parameters:
    
    predicate - a atom this variable's value must match
    
    Returns:
    
    this
  - has
```
public final VarPattern has(String type,
                            Object value)
```
    Description copied from interface: VarPattern
    
    the variable must have a resource of the given type with an exact matching value
    
    Specified by:
    
    has in interface VarPattern
    
    Parameters:
    
    type - a resource type in the ontology
    
    value - a value of a resource
    
    Returns:
    
    this
  - has
```
public final VarPattern has(String type,
                            ValuePredicate predicate)
```
    Description copied from interface: VarPattern
    
    the variable must have a resource of the given type that matches the given atom
    
    Specified by:
    
    has in interface VarPattern
    
    Parameters:
    
    type - a resource type in the ontology
    
    predicate - a atom on the value of a resource
    
    Returns:
    
    this
  - has
```
public final VarPattern has(String type,
                            VarPattern varPattern)
```
    Description copied from interface: VarPattern
    
    the variable must have a resource of the given type that matches the given atom
    
    Specified by:
    
    has in interface VarPattern
    
    Parameters:
    
    type - a resource type in the ontology
    
    varPattern - a variable pattern representing a resource
    
    Returns:
    
    this
  - has
```
public final VarPattern has(Label type,
                            VarPattern varPattern)
```
    Description copied from interface: VarPattern
    
    the variable must have a resource of the given type that matches the given atom
    
    Specified by:
    
    has in interface VarPattern
    
    Parameters:
    
    type - a resource type in the ontology
    
    varPattern - a variable pattern representing a resource
    
    Returns:
    
    this
  - isa
```
public final VarPattern isa(String type)
```
    Specified by:
    
    isa in interface VarPattern
    
    Parameters:
    
    type - a concept type id that the variable must be of this type
    
    Returns:
    
    this
  - isa
```
public final VarPattern isa(VarPattern type)
```
    Specified by:
    
    isa in interface VarPattern
    
    Parameters:
    
    type - a concept type that this variable must be an instance of
    
    Returns:
    
    this
  - sub
```
public final VarPattern sub(String type)
```
    Specified by:
    
    sub in interface VarPattern
    
    Parameters:
    
    type - a concept type id that this variable must be a kind of
    
    Returns:
    
    this
  - sub
```
public final VarPattern sub(VarPattern type)
```
    Specified by:
    
    sub in interface VarPattern
    
    Parameters:
    
    type - a concept type that this variable must be a kind of
    
    Returns:
    
    this
  - relates
```
public final VarPattern relates(String type)
```
    Specified by:
    
    relates in interface VarPattern
    
    Parameters:
    
    type - a Role id that this relation type variable must have
    
    Returns:
    
    this
  - relates
```
public final VarPattern relates(VarPattern type)
```
    Specified by:
    
    relates in interface VarPattern
    
    Parameters:
    
    type - a Role that this relation type variable must have
    
    Returns:
    
    this
  - plays
```
public final VarPattern plays(String type)
```
    Specified by:
    
    plays in interface VarPattern
    
    Parameters:
    
    type - a Role id that this concept type variable must play
    
    Returns:
    
    this
  - plays
```
public final VarPattern plays(VarPattern type)
```
    Specified by:
    
    plays in interface VarPattern
    
    Parameters:
    
    type - a Role that this concept type variable must play
    
    Returns:
    
    this
  - hasScope
```
public final VarPattern hasScope(VarPattern type)
```
    Specified by:
    
    hasScope in interface VarPattern
    
    Parameters:
    
    type - a scope that this variable must have
    
    Returns:
    
    this
  - has
```
public final VarPattern has(String type)
```
    Specified by:
    
    has in interface VarPattern
    
    Parameters:
    
    type - a resource type that this type variable can be related to
    
    Returns:
    
    this
  - has
```
public final VarPattern has(VarPattern type)
```
    Specified by:
    
    has in interface VarPattern
    
    Parameters:
    
    type - a resource type that this type variable can be related to
    
    Returns:
    
    this
  - key
```
public final VarPattern key(String type)
```
    Specified by:
    
    key in interface VarPattern
    
    Parameters:
    
    type - a resource type that this type variable can be one-to-one related to
    
    Returns:
    
    this
  - key
```
public final VarPattern key(VarPattern type)
```
    Specified by:
    
    key in interface VarPattern
    
    Parameters:
    
    type - a resource type that this type variable can be one-to-one related to
    
    Returns:
    
    this
  - rel
```
public final VarPattern rel(String roleplayer)
```
    Description copied from interface: VarPattern
    
    the variable must be a relation with the given roleplayer
    
    Specified by:
    
    rel in interface VarPattern
    
    Parameters:
    
    roleplayer - a variable representing a roleplayer
    
    Returns:
    
    this
  - rel
```
public final VarPattern rel(VarPattern roleplayer)
```
    Description copied from interface: VarPattern
    
    the variable must be a relation with the given roleplayer
    
    Specified by:
    
    rel in interface VarPattern
    
    Parameters:
    
    roleplayer - a variable pattern representing a roleplayer
    
    Returns:
    
    this
  - rel
```
public final VarPattern rel(String role,
                            String roleplayer)
```
    Description copied from interface: VarPattern
    
    the variable must be a relation with the given roleplayer playing the given Role
    
    Specified by:
    
    rel in interface VarPattern
    
    Parameters:
    
    role - a Role in the ontology
    
    roleplayer - a variable representing a roleplayer
    
    Returns:
    
    this
  - rel
```
public final VarPattern rel(VarPattern role,
                            String roleplayer)
```
    Description copied from interface: VarPattern
    
    the variable must be a relation with the given roleplayer playing the given Role
    
    Specified by:
    
    rel in interface VarPattern
    
    Parameters:
    
    role - a variable pattern representing a Role
    
    roleplayer - a variable representing a roleplayer
    
    Returns:
    
    this
  - rel
```
public final VarPattern rel(String role,
                            VarPattern roleplayer)
```
    Description copied from interface: VarPattern
    
    the variable must be a relation with the given roleplayer playing the given Role
    
    Specified by:
    
    rel in interface VarPattern
    
    Parameters:
    
    role - a Role in the ontology
    
    roleplayer - a variable pattern representing a roleplayer
    
    Returns:
    
    this
  - rel
```
public final VarPattern rel(VarPattern role,
                            VarPattern roleplayer)
```
    Description copied from interface: VarPattern
    
    the variable must be a relation with the given roleplayer playing the given Role
    
    Specified by:
    
    rel in interface VarPattern
    
    Parameters:
    
    role - a variable pattern representing a Role
    
    roleplayer - a variable pattern representing a roleplayer
    
    Returns:
    
    this
  - isAbstract
```
public final VarPattern isAbstract()
```
    Description copied from interface: VarPattern
    
    set this concept type variable as abstract, meaning it cannot have direct instances
    
    Specified by:
    
    isAbstract in interface VarPattern
    
    Returns:
    
    this
  - datatype
```
public final VarPattern datatype(ResourceType.DataType<?> datatype)
```
    Specified by:
    
    datatype in interface VarPattern
    
    Parameters:
    
    datatype - the datatype to set for this resource type variable
    
    Returns:
    
    this
  - regex
```
public final VarPattern regex(String regex)
```
    Description copied from interface: VarPattern
    
    Specify the regular expression instances of this resource type must match
    
    Specified by:
    
    regex in interface VarPattern
    
    Parameters:
    
    regex - the regex to set for this resource type variable
    
    Returns:
    
    this
  - when
```
public final VarPattern when(Pattern when)
```
    Specified by:
    
    when in interface VarPattern
    
    Parameters:
    
    when - the left-hand side of this rule
    
    Returns:
    
    this
  - then
```
public final VarPattern then(Pattern then)
```
    Specified by:
    
    then in interface VarPattern
    
    Parameters:
    
    then - the right-hand side of this rule
    
    Returns:
    
    this
  - neq
```
public final VarPattern neq(String var)
```
    Description copied from interface: VarPattern
    
    Specify that the variable is different to another variable
    
    Specified by:
    
    neq in interface VarPattern
    
    Parameters:
    
    var - the variable that this variable should not be equal to
    
    Returns:
    
    this
  - neq
```
public final VarPattern neq(VarPattern varPattern)
```
    Description copied from interface: VarPattern
    
    Specify that the variable is different to another variable
    
    Specified by:
    
    neq in interface VarPattern
    
    Parameters:
    
    varPattern - the variable pattern that this variable should not be equal to
    
    Returns:
    
    this
  - getPrintableName
```
public final String getPrintableName()
```
    Specified by:
    
    getPrintableName in interface VarPatternAdmin
    
    Returns:
    
    the name of this variable, as it would be referenced in a native Graql query (e.g. '$x', 'movie')
  - getProperties
```
public final java.util.stream.Stream<VarProperty> getProperties()
```
    Description copied from interface: VarPatternAdmin
    
    Get a stream of all properties on this variable
    
    Specified by:
    
    getProperties in interface VarPatternAdmin

Class AbstractVarPattern

Constructor Summary

Method Summary

Methods inherited from class ai.grakn.graql.internal.pattern.AbstractPattern

Methods inherited from class java.lang.Object

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

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

Methods inherited from interface ai.grakn.graql.Pattern

Constructor Detail

AbstractVarPattern

Method Detail

getVarName

properties

admin

getId

getTypeLabel

getProperties

getProperty

hasProperty

getInnerVars

getImplicitInnerVars

getTypeLabels

getDisjunctiveNormalForm

commonVarNames

id

label

label

val

val

has

has

has

has

isa

isa

sub

sub

relates

relates

plays

plays

hasScope

has

has

key

key

rel

rel

rel

rel

rel

rel

isAbstract

datatype

regex

when

then

neq

neq

getPrintableName

getProperties