ai.grakn.graql.internal.template

Class Scope

java.lang.Object

ai.grakn.graql.internal.template.Scope

public class Scope
extends Object

Represents a scope (association of name to a value) and corresponds to a block in the TemplateVisitor class. This can also be thought of as a block in Graql Temaplates. I.e. any body of text surrounded by {} or the root.

Author:

alexandraorth

Constructor Summary

Constructors

Constructor and Description
Scope(Map<String,Object> data)
Scope(Scope parent)

Method Summary

Modifier and Type	Method and Description
void	assign(String prefix, Object value) Associate a value with the given key.
boolean	hasSeen(String variable) Check if the variable has been seen before in this scope
boolean	isGlobalScope() Check if this scope is "global", i.e.
void	markAsSeen(String variable) Mark a variable as seen within this scope
Object	resolve(String var) Retrieve the value of a key from this scope, or the parent scope if it is not present in the current one.
void	unassign(String prefix) Remove a key/value pair from this scope
Scope	up() Move up one level to the parent scope

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Scope

public Scope(Map<String,Object> data)

Scope

public Scope(Scope parent)

Method Detail

up

public Scope up()

Move up one level to the parent scope

Returns:

the parent scope

assign

public void assign(String prefix,
                   Object value)

Associate a value with the given key. If the given value is a map, recurse through it and concatenate the given prefix with the keys in the map separated by ".".

Parameters:

prefix - key to use in the map of values.

value - value to associate.

unassign

public void unassign(String prefix)

Remove a key/value pair from this scope

Parameters:

prefix - key to remove from the scope

resolve

public Object resolve(String var)

Retrieve the value of a key from this scope, or the parent scope if it is not present in the current one.

Parameters:

var - key to retrieve

Returns:

value associated with the provided key

isGlobalScope

public boolean isGlobalScope()

Check if this scope is "global", i.e. has no parent

Returns:

true if this is the "root" scope

hasSeen

public boolean hasSeen(String variable)

Check if the variable has been seen before in this scope

Parameters:

variable - variable to check the presence of

Returns:

true if the variable has been seen, false otherwise

markAsSeen

public void markAsSeen(String variable)

Mark a variable as seen within this scope

Parameters:

variable - variable to mark as seen