OBasicCommandContext (OrientDB 3.1.2-SNAPSHOT API)

java.lang.Object
- com.orientechnologies.orient.core.command.OBasicCommandContext

All Implemented Interfaces:

OCommandContext

Direct Known Subclasses:

OETLContext, OTraverseContext
```
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 and Description
`protected Object[]`	`args`
`protected OCommandContext`	`child`
`protected ODatabase`	`database`
`protected Set<String>`	`declaredScriptVariables`
`static String`	`EXECUTION_BEGUN`
`protected Map<Object,Object>`	`inputParameters`
`static String`	`INVALID_COMPARE_COUNT`
`protected OCommandContext`	`parent`
`protected boolean`	`recordMetrics`
`protected AtomicLong`	`resultsProcessed`
`static String`	`TIMEOUT_MS`
`static String`	`TIMEOUT_STRATEGY`
`protected Set<Object>`	`uniqueResult`
`protected Map<String,Object>`	`variables`

Constructor Summary

Constructors
Constructor and Description

OBasicCommandContext()

Constructors
Constructor and Description
`OBasicCommandContext()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addToUniqueResult(Object o)` adds an item to the unique result set
`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)`
`ODatabase`	`getDatabase()`
`Map<Object,Object>`	`getInputParameters()`
`OCommandContext`	`getParent()`
`AtomicLong`	`getResultsProcessed()` returns the number of results processed.
`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.
`OCommandContext`	`incrementVariable(String iName)`
`boolean`	`isRecordingMetrics()`
`boolean`	`isScriptVariableDeclared(String varName)`
`void`	`merge(OCommandContext iContext)` Merges a context with current one.
`OCommandContext`	`setChild(OCommandContext iContext)` Set the inherited context avoiding to copy all the values every time.
`void`	`setDatabase(ODatabase database)`
`void`	`setInputParameters(Map<Object,Object> inputParameters)`
`OCommandContext`	`setParent(OCommandContext iParentContext)`
`OCommandContext`	`setParentWithoutOverridingChild(OCommandContext iParentContext)`
`OCommandContext`	`setRecordingMetrics(boolean recordMetrics)`
`OCommandContext`	`setVariable(String iName, Object iValue)`
`String`	`toString()`
`long`	`updateMetric(String iName, long iValue)` Updates a counter.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - 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 ODatabase database
```
  - args
```
protected Object[] args
```
  - 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
```
  - uniqueResult
```
protected Set<Object> uniqueResult
```
- Constructor Detail
  - OBasicCommandContext
```
public OBasicCommandContext()
```
- Method Detail
  - 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)
```
  - setVariable
```
public OCommandContext setVariable(String iName,
                                   Object iValue)
```
    Specified by:
    
    setVariable in interface OCommandContext
  - 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
  - getResultsProcessed
```
public AtomicLong getResultsProcessed()
```
    returns the number of results processed. This is intended to be used with LIMIT in SQL statements
    
    Returns:
  - addToUniqueResult
```
public boolean addToUniqueResult(Object o)
```
    adds an item to the unique result set
    
    Parameters:
    
    o - the result item to add
    
    Returns:
    
    true if the element is successfully added (it was not present yet), false otherwise (it was already present)
  - getDatabase
```
public ODatabase getDatabase()
```
    Specified by:
    
    getDatabase in interface OCommandContext
  - setDatabase
```
public void setDatabase(ODatabase 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

Class OBasicCommandContext

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EXECUTION_BEGUN

TIMEOUT_MS

TIMEOUT_STRATEGY

INVALID_COMPARE_COUNT

database

args

recordMetrics

parent

child

variables

inputParameters

declaredScriptVariables

resultsProcessed

uniqueResult

Constructor Detail

OBasicCommandContext

Method Detail

getVariable

getVariable

getVariableFromParentHierarchy

setVariable

incrementVariable

updateMetric

getVariables

setChild

getParent

setParent

setParentWithoutOverridingChild

toString

isRecordingMetrics

setRecordingMetrics

beginExecution

checkTimeout

copy

merge

getInputParameters

setInputParameters

getResultsProcessed

addToUniqueResult

getDatabase

setDatabase

declareScriptVariable

isScriptVariableDeclared