ai.grakn.graql.admin

Interface VarAdmin

All Superinterfaces:

Pattern, PatternAdmin, Var

public interface VarAdmin
extends PatternAdmin, Var

Admin class for inspecting a Var

Author:

Felix Chapman

Method Summary

Modifier and Type	Method and Description
default VarAdmin	asVar()
Optional<ConceptId>	getId()
Collection<VarAdmin>	getImplicitInnerVars() Get all inner variables, including implicit variables such as in a has property
Collection<VarAdmin>	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<TypeLabel>	getTypeLabel()
Set<TypeLabel>	getTypeLabels()
VarName	getVarName()
<T extends VarProperty> boolean	hasProperty(Class<T> type) Get whether this Var has a VarProperty of the given type
boolean	isUserDefinedName()
default boolean	isVar()
<T extends VarProperty> VarAdmin	mapProperty(Class<T> type, java.util.function.UnaryOperator<T> mapper) Return this Var with instances of the given VarProperty modified.
VarAdmin	setVarName(VarName name)

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

asConjunction, asDisjunction, commonVarNames, getDisjunctiveNormalForm, getVars, isConjunction, isDisjunction

Methods inherited from interface ai.grakn.graql.Var

admin, datatype, has, has, has, has, has, has, hasScope, id, isa, isa, isAbstract, key, key, label, label, lhs, neq, neq, plays, plays, regex, rel, rel, rel, rel, rel, rel, relates, relates, rhs, sub, sub, val, val

Method Detail

isVar

default boolean isVar()

Specified by:

isVar in interface PatternAdmin

Returns:

true if this Pattern.Admin is a Var.Admin

asVar

default VarAdmin asVar()

Specified by:

asVar in interface PatternAdmin

Returns:

this Pattern.Admin as a Var.Admin, if it is one.

getVarName

VarName getVarName()

Returns:

the variable name of this variable

setVarName

@CheckReturnValue
VarAdmin setVarName(VarName name)

Parameters:

name - the new variable name of this variable

isUserDefinedName

boolean isUserDefinedName()

Returns:

whether the user specified a name for this variable

getProperties

java.util.stream.Stream<VarProperty> getProperties()

Get a stream of all properties on this variable

getProperties

<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

Type Parameters:

T - the type of VarProperty to return

Parameters:

type - the class of VarProperty to return

getProperty

<T extends UniqueVarProperty> Optional<T> getProperty(Class<T> type)

Get a unique property of a particular type on this variable, if it exists

Type Parameters:

T - the type of VarProperty to return

Parameters:

type - the class of VarProperty to return

hasProperty

<T extends VarProperty> boolean hasProperty(Class<T> type)

Get whether this Var has a VarProperty of the given type

Type Parameters:

T - the type of the VarProperty

Parameters:

type - the type of the VarProperty

Returns:

whether this Var has a VarProperty of the given type

mapProperty

@CheckReturnValue
<T extends VarProperty> VarAdmin mapProperty(Class<T> type,
                                                               java.util.function.UnaryOperator<T> mapper)

Return this Var with instances of the given VarProperty modified.

Type Parameters:

T - the type of the VarProperty

Parameters:

type - the type of the VarProperty

Returns:

whether this Var has a VarProperty of the given type

getId

Optional<ConceptId> getId()

Returns:

the ID this variable represents, if it represents something with a specific ID

getTypeLabel

Optional<TypeLabel> getTypeLabel()

Returns:

the name this variable represents, if it represents something with a specific name

getInnerVars

Collection<VarAdmin> getInnerVars()

Returns:

all variables that this variable references

getImplicitInnerVars

Collection<VarAdmin> getImplicitInnerVars()

Get all inner variables, including implicit variables such as in a has property

getTypeLabels

Set<TypeLabel> getTypeLabels()

Returns:

all type names that this variable refers to

getPrintableName

String getPrintableName()

Returns:

the name of this variable, as it would be referenced in a native Graql query (e.g. '$x', 'movie')