com.orientechnologies.orient.core.command

Interface OCommandContext

All Known Implementing Classes:

OBasicCommandContext, OETLContext, OTraverseContext

public interface OCommandContext

Basic interface for commands. Manages the context variables during execution.

Author:

Luca Garulli (l.garulli--(at)--orientdb.com)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OCommandContext.TIMEOUT_STRATEGY

Method Summary

Modifier and Type	Method and Description
void	beginExecution(long timeoutMs, OCommandContext.TIMEOUT_STRATEGY iStrategy)
boolean	checkTimeout() Check if timeout is elapsed, if defined.
OCommandContext	copy() Creates a copy of execution context.
void	declareScriptVariable(String varName)
ODatabase	getDatabase()
Map<Object,Object>	getInputParameters()
OCommandContext	getParent()
Object	getVariable(String iName)
Object	getVariable(String iName, Object iDefaultValue)
Map<String,Object>	getVariables()
OCommandContext	incrementVariable(String getNeighbors)
boolean	isRecordingMetrics()
boolean	isScriptVariableDeclared(String varName)
void	merge(OCommandContext iContext) Merges a context with current one.
OCommandContext	setChild(OCommandContext context)
void	setInputParameters(Map<Object,Object> inputParameters)
OCommandContext	setParent(OCommandContext iParentContext)
OCommandContext	setRecordingMetrics(boolean recordMetrics)
OCommandContext	setVariable(String iName, Object iValue)
long	updateMetric(String iName, long iValue) Updates a counter.

Method Detail

getVariable

Object getVariable(String iName)

getVariable

Object getVariable(String iName,
                   Object iDefaultValue)

setVariable

OCommandContext setVariable(String iName,
                            Object iValue)

incrementVariable

OCommandContext incrementVariable(String getNeighbors)

getVariables

Map<String,Object> getVariables()

getParent

OCommandContext getParent()

setParent

OCommandContext setParent(OCommandContext iParentContext)

setChild

OCommandContext setChild(OCommandContext context)

updateMetric

long updateMetric(String iName,
                  long iValue)

Updates a counter. Used to record metrics.

Parameters:

iName - Metric's name

iValue - delta to add or subtract

Returns:

isRecordingMetrics

boolean isRecordingMetrics()

setRecordingMetrics

OCommandContext setRecordingMetrics(boolean recordMetrics)

beginExecution

void beginExecution(long timeoutMs,
                    OCommandContext.TIMEOUT_STRATEGY iStrategy)

checkTimeout

boolean checkTimeout()

Check if timeout is elapsed, if defined.

Returns:

false if it the timeout is elapsed and strategy is "return"

Throws:

OTimeoutException - if the strategy is "exception" (default)

getInputParameters

Map<Object,Object> getInputParameters()

setInputParameters

void setInputParameters(Map<Object,Object> inputParameters)

copy

OCommandContext copy()

Creates a copy of execution context.

merge

void merge(OCommandContext iContext)

Merges a context with current one.

Parameters:

iContext -

getDatabase

ODatabase getDatabase()

declareScriptVariable

void declareScriptVariable(String varName)

isScriptVariableDeclared

boolean isScriptVariableDeclared(String varName)