Package uk.gov.gchq.gaffer.tinkerpop

Class GafferPopGraphVariables

java.lang.Object

uk.gov.gchq.gaffer.tinkerpop.GafferPopGraphVariables

All Implemented Interfaces:

org.apache.tinkerpop.gremlin.structure.Graph.Variables

public final class GafferPopGraphVariables
extends Object
implements org.apache.tinkerpop.gremlin.structure.Graph.Variables

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GafferPopGraphVariables.HasStepFilterStage

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.structure.Graph.Variables

org.apache.tinkerpop.gremlin.structure.Graph.Variables.Exceptions

Field Summary

Fields

Modifier and Type	Field	Description
static String	CYPHER_KEY	Key used in a with step to include a opencypher query traversal
static String	DATA_AUTHS	Variable key for the list of data auths for the default user.
static int	DEFAULT_GET_ELEMENTS_LIMIT	Default value for the max number of elements returned by getElements
static GafferPopGraphVariables.HasStepFilterStage	DEFAULT_HAS_STEP_FILTER_STAGE	Default to pre-aggregation filtering for HasStep predicates
static String	GET_ELEMENTS_LIMIT	The max number of elements that can be returned by a single GetElements or GetAllElements
static String	HAS_STEP_FILTER_STAGE	When to apply HasStep filtering
static String	INCLUDE_ORPHANED_VERTICES	The key to set if orphaned vertices (e.g.
static String	LAST_OPERATION_CHAIN	The variable with the last Gaffer operation chain that was ran from the Gremlin query
static String	OP_OPTIONS	Variable key for the Map of Gaffer operation options.
static String	USER	Variable key for the user who is interacting with the graph.
static String	USER_ID	Variable key for the userId used for constructing a default user.

Constructor Summary

Constructors

Constructor	Description
GafferPopGraphVariables()
GafferPopGraphVariables(Map<String,Object> variables)

Method Summary

Modifier and Type	Method	Description
<R> Optional<R>	get(String key)
Integer	getElementsLimit()
String	getHasStepFilterStage()
boolean	getIncludeOrphanedVertices()
OperationChain<?>	getLastOperationChain()
Map<String,String>	getOperationOptions()	Gets the operation options if available.
User	getUser()
Set<String>	keys()
void	remove(String key)
void	set(String key, Object value)
void	setOperationOptions(Iterable<String> opOptions)	Sets the operation options key, attempts to convert to a String Map by spitting each value on ':'.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.Graph.Variables

asMap

Field Detail

OP_OPTIONS

public static final String OP_OPTIONS

Variable key for the Map of Gaffer operation options.

See Also:

Constant Field Values

DATA_AUTHS

public static final String DATA_AUTHS

Variable key for the list of data auths for the default user.

See Also:

Constant Field Values

USER_ID

public static final String USER_ID

Variable key for the userId used for constructing a default user.

See Also:

Constant Field Values

USER

public static final String USER

Variable key for the user who is interacting with the graph.

See Also:

Constant Field Values

GET_ELEMENTS_LIMIT

public static final String GET_ELEMENTS_LIMIT

The max number of elements that can be returned by a single GetElements or GetAllElements

See Also:

Constant Field Values

HAS_STEP_FILTER_STAGE

public static final String HAS_STEP_FILTER_STAGE

When to apply HasStep filtering

See Also:

Constant Field Values

CYPHER_KEY

public static final String CYPHER_KEY

Key used in a with step to include a opencypher query traversal

See Also:

Constant Field Values

LAST_OPERATION_CHAIN

public static final String LAST_OPERATION_CHAIN

The variable with the last Gaffer operation chain that was ran from the Gremlin query

See Also:

Constant Field Values

INCLUDE_ORPHANED_VERTICES

public static final String INCLUDE_ORPHANED_VERTICES

The key to set if orphaned vertices (e.g. vertices without an entity) should be included in the result

See Also:

Constant Field Values

DEFAULT_GET_ELEMENTS_LIMIT

public static final int DEFAULT_GET_ELEMENTS_LIMIT

Default value for the max number of elements returned by getElements

See Also:

Constant Field Values

DEFAULT_HAS_STEP_FILTER_STAGE

public static final GafferPopGraphVariables.HasStepFilterStage DEFAULT_HAS_STEP_FILTER_STAGE

Default to pre-aggregation filtering for HasStep predicates

Constructor Detail

GafferPopGraphVariables

public GafferPopGraphVariables(Map<String,Object> variables)

GafferPopGraphVariables

public GafferPopGraphVariables()

Method Detail

keys

public Set<String> keys()

Specified by:

keys in interface org.apache.tinkerpop.gremlin.structure.Graph.Variables

get

public <R> Optional<R> get(String key)

Specified by:

get in interface org.apache.tinkerpop.gremlin.structure.Graph.Variables

remove

public void remove(String key)

Specified by:

remove in interface org.apache.tinkerpop.gremlin.structure.Graph.Variables

set

public void set(String key,
                Object value)

Specified by:

set in interface org.apache.tinkerpop.gremlin.structure.Graph.Variables

setOperationOptions

public void setOperationOptions(Iterable<String> opOptions)

Sets the operation options key, attempts to convert to a String Map by spitting each value on ':'.

Parameters:

opOptions - List of String key value pairs e.g.

 [ "key:value", "key2:value2" ] 

getOperationOptions

public Map<String,String> getOperationOptions()

Gets the operation options if available.

Returns:

Operation options map

getUser

public User getUser()

getElementsLimit

public Integer getElementsLimit()

getHasStepFilterStage

public String getHasStepFilterStage()

getLastOperationChain

public OperationChain<?> getLastOperationChain()

getIncludeOrphanedVertices

public boolean getIncludeOrphanedVertices()

toString

public String toString()

Overrides:

toString in class Object