Package com.orientechnologies.orient.core.command

Class OBasicCommandContext

java.lang.Object

com.orientechnologies.orient.core.command.OBasicCommandContext

All Implemented Interfaces:

OCommandContext

Direct Known Subclasses:

OBasicServerCommandContext, OETLContext

public class OBasicCommandContext
extends Object
implements OCommandContext

Basic implementation of OCommandContext interface that stores variables in a map. Supports parent/child context to build a tree of contexts. If a variable is not found on current object the search is applied recursively on child contexts.

Author:

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.orientechnologies.orient.core.command.OCommandContext

OCommandContext.TIMEOUT_STRATEGY

Field Summary

Fields

Modifier and Type	Field	Description
protected OCommandContext	child
protected ODatabaseSession	database
protected Set<String>	declaredScriptVariables
static final String	EXECUTION_BEGUN
protected Map<Object,Object>	inputParameters
static final String	INVALID_COMPARE_COUNT
protected OCommandContext	parent
protected boolean	recordMetrics
protected AtomicLong	resultsProcessed
static final String	TIMEOUT_MS
static final String	TIMEOUT_STRATEGY
protected Map<String,Object>	variables

Constructor Summary

Constructors

Constructor	Description
OBasicCommandContext()
OBasicCommandContext(ODatabaseSession session)

Method Summary

Modifier and Type	Method	Description
void	beginExecution(long iTimeout, 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)
void	enableProfiling()
void	endProfiling(OExecutionStepInternal step)
OResult	getCurrent()
ODatabaseSession	getDatabase()
Map<Object,Object>	getInputParameters()
Object	getLocalVariable(String name)
OCommandContext	getParent()
AtomicLong	getResultsProcessed()	returns the number of results processed.
Object	getSimpleVariable(String name)
OStepStats	getStats(OExecutionStepInternal step)
Object	getVariable(String iName)
Object	getVariable(String iName, Object iDefault)
protected Object	getVariableFromParentHierarchy(String varName)
Map<String,Object>	getVariables()	Returns a read-only map with all the variables.
boolean	hasLocalVariable(String name)
OCommandContext	incrementVariable(String iName)
boolean	isProfiling()
boolean	isRecordingMetrics()
boolean	isScriptVariableDeclared(String varName)
void	merge(OCommandContext iContext)	Merges a context with current one.
void	setArrayParameters(Object[] args)
OCommandContext	setChild(OCommandContext iContext)	Set the inherited context avoiding to copy all the values every time.
void	setCurrent(OResult result)
void	setCurrentIfMissing(OResult result)
void	setDatabase(ODatabaseSession database)
OCommandContext	setDynamicVariable(String iName, ODynamicVariable iValue)
void	setInputParameters(Map<Object,Object> inputParameters)
void	setLocalVariable(String name, Object value)
OCommandContext	setParent(OCommandContext iParentContext)
OCommandContext	setParentWithoutOverridingChild(OCommandContext iParentContext)
OCommandContext	setRecordingMetrics(boolean recordMetrics)
OCommandContext	setVariable(String iName, Object iValue)
void	startProfiling(OExecutionStepInternal step)
String	toString()
long	updateMetric(String iName, long iValue)	Updates a counter.
void	updateProfilerIndex(List<OIndexStreamStat> stats)

Methods inherited from class java.lang.Object

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

Field Details

EXECUTION_BEGUN

public static final String EXECUTION_BEGUN

See Also:

• Constant Field Values

TIMEOUT_MS

public static final String TIMEOUT_MS

See Also:

• Constant Field Values

TIMEOUT_STRATEGY

public static final String TIMEOUT_STRATEGY

See Also:

• Constant Field Values

INVALID_COMPARE_COUNT

public static final String INVALID_COMPARE_COUNT

See Also:

• Constant Field Values

database

protected ODatabaseSession database

recordMetrics

protected boolean recordMetrics

parent

protected OCommandContext parent

child

protected OCommandContext child

variables

protected Map<String,Object> variables

inputParameters

protected Map<Object,Object> inputParameters

declaredScriptVariables

protected Set<String> declaredScriptVariables

resultsProcessed

protected AtomicLong resultsProcessed

Constructor Details

OBasicCommandContext

public OBasicCommandContext()

OBasicCommandContext

public OBasicCommandContext(ODatabaseSession session)

Method Details

getCurrent

public OResult getCurrent()

Specified by:

getCurrent in interface OCommandContext

setCurrentIfMissing

public void setCurrentIfMissing(OResult result)

Specified by:

setCurrentIfMissing in interface OCommandContext

setCurrent

public void setCurrent(OResult result)

Specified by:

setCurrent in interface OCommandContext

getVariable

public Object getVariable(String iName)

Specified by:

getVariable in interface OCommandContext

getVariable

public Object getVariable(String iName,
 Object iDefault)

Specified by:

getVariable in interface OCommandContext

getVariableFromParentHierarchy

protected Object getVariableFromParentHierarchy(String varName)

setDynamicVariable

public OCommandContext setDynamicVariable(String iName,
 ODynamicVariable iValue)

setVariable

public OCommandContext setVariable(String iName,
 Object iValue)

Specified by:

setVariable in interface OCommandContext

getLocalVariable

public Object getLocalVariable(String name)

setLocalVariable

public void setLocalVariable(String name,
 Object value)

hasLocalVariable

public boolean hasLocalVariable(String name)

getSimpleVariable

public Object getSimpleVariable(String name)

incrementVariable

public OCommandContext incrementVariable(String iName)

Specified by:

incrementVariable in interface OCommandContext

updateMetric

public long updateMetric(String iName,
 long iValue)

Description copied from interface: OCommandContext

Updates a counter. Used to record metrics.

Specified by:

updateMetric in interface OCommandContext

Parameters:

iName - Metric's name

iValue - delta to add or subtract

Returns:

getVariables

public Map<String,Object> getVariables()

Returns a read-only map with all the variables.

Specified by:

getVariables in interface OCommandContext

setChild

public OCommandContext setChild(OCommandContext iContext)

Set the inherited context avoiding to copy all the values every time.

Specified by:

setChild in interface OCommandContext

Returns:

getParent

public OCommandContext getParent()

Specified by:

getParent in interface OCommandContext

setParent

public OCommandContext setParent(OCommandContext iParentContext)

Specified by:

setParent in interface OCommandContext

setParentWithoutOverridingChild

public OCommandContext setParentWithoutOverridingChild(OCommandContext iParentContext)

toString

public String toString()

Overrides:

toString in class Object

isRecordingMetrics

public boolean isRecordingMetrics()

Specified by:

isRecordingMetrics in interface OCommandContext

setRecordingMetrics

public OCommandContext setRecordingMetrics(boolean recordMetrics)

Specified by:

setRecordingMetrics in interface OCommandContext

beginExecution

public void beginExecution(long iTimeout,
 OCommandContext.TIMEOUT_STRATEGY iStrategy)

Specified by:

beginExecution in interface OCommandContext

checkTimeout

public boolean checkTimeout()

Description copied from interface: OCommandContext

Check if timeout is elapsed, if defined.

Specified by:

checkTimeout in interface OCommandContext

Returns:

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

copy

public OCommandContext copy()

Description copied from interface: OCommandContext

Creates a copy of execution context.

Specified by:

copy in interface OCommandContext

merge

public void merge(OCommandContext iContext)

Description copied from interface: OCommandContext

Merges a context with current one.

Specified by:

merge in interface OCommandContext

getInputParameters

public Map<Object,Object> getInputParameters()

Specified by:

getInputParameters in interface OCommandContext

setInputParameters

public void setInputParameters(Map<Object,Object> inputParameters)

Specified by:

setInputParameters in interface OCommandContext

setArrayParameters

public void setArrayParameters(Object[] args)

getResultsProcessed

public AtomicLong getResultsProcessed()

returns the number of results processed. This is intended to be used with LIMIT in SQL statements

Returns:

getDatabase

public ODatabaseSession getDatabase()

Specified by:

getDatabase in interface OCommandContext

setDatabase

public void setDatabase(ODatabaseSession database)

declareScriptVariable

public void declareScriptVariable(String varName)

Specified by:

declareScriptVariable in interface OCommandContext

isScriptVariableDeclared

public boolean isScriptVariableDeclared(String varName)

Specified by:

isScriptVariableDeclared in interface OCommandContext

startProfiling

public void startProfiling(OExecutionStepInternal step)

Specified by:

startProfiling in interface OCommandContext

endProfiling

public void endProfiling(OExecutionStepInternal step)

Specified by:

endProfiling in interface OCommandContext

getStats

public OStepStats getStats(OExecutionStepInternal step)

Specified by:

getStats in interface OCommandContext

updateProfilerIndex

public void updateProfilerIndex(List<OIndexStreamStat> stats)

enableProfiling

public void enableProfiling()

isProfiling

public boolean isProfiling()

Specified by:

isProfiling in interface OCommandContext