com.orientechnologies.orient.core.command

Interface OCommandExecutor

All Known Implementing Classes:

OCommandExecutorAbstract, OCommandExecutorFunction, OCommandExecutorScript, OCommandExecutorSQLAbstract, OCommandExecutorSQLAlterClass, OCommandExecutorSQLAlterCluster, OCommandExecutorSQLAlterDatabase, OCommandExecutorSQLAlterProperty, OCommandExecutorSQLAlterSequence, OCommandExecutorSQLCreateClass, OCommandExecutorSQLCreateCluster, OCommandExecutorSQLCreateEdge, OCommandExecutorSQLCreateFunction, OCommandExecutorSQLCreateIndex, OCommandExecutorSQLCreateLink, OCommandExecutorSQLCreateProperty, OCommandExecutorSQLCreateSequence, OCommandExecutorSQLCreateUser, OCommandExecutorSQLCreateVertex, OCommandExecutorSQLDelegate, OCommandExecutorSQLDelete, OCommandExecutorSQLDeleteEdge, OCommandExecutorSQLDeleteVertex, OCommandExecutorSQLDropClass, OCommandExecutorSQLDropCluster, OCommandExecutorSQLDropIndex, OCommandExecutorSQLDropProperty, OCommandExecutorSQLDropSequence, OCommandExecutorSQLDropUser, OCommandExecutorSQLEarlyResultsetAbstract, OCommandExecutorSQLExplain, OCommandExecutorSQLFindReferences, OCommandExecutorSQLGrant, OCommandExecutorSQLHARemoveServer, OCommandExecutorSQLHAStatus, OCommandExecutorSQLHASyncCluster, OCommandExecutorSQLHASyncDatabase, OCommandExecutorSQLInsert, OCommandExecutorSQLLiveSelect, OCommandExecutorSQLLiveUnsubscribe, OCommandExecutorSQLMoveVertex, OCommandExecutorSQLOptimizeDatabase, OCommandExecutorSQLPermissionAbstract, OCommandExecutorSQLRebuildIndex, OCommandExecutorSQLResultsetAbstract, OCommandExecutorSQLResultsetDelegate, OCommandExecutorSQLRetryAbstract, OCommandExecutorSQLRevoke, OCommandExecutorSQLSelect, OCommandExecutorSQLSetAware, OCommandExecutorSQLTransactional, OCommandExecutorSQLTraverse, OCommandExecutorSQLTruncateClass, OCommandExecutorSQLTruncateCluster, OCommandExecutorSQLTruncateRecord, OCommandExecutorSQLUpdate, OCommandExecutorToOStatementWrapper, OCommandGremlinExecutor, OMatchStatement

public interface OCommandExecutor

Generic GOF command pattern implementation.

Author:

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

Method Summary

Modifier and Type	Method and Description
Object	execute(Map<Object,Object> iArgs) Execute the requested command parsed previously.
OCommandContext	getContext()
long	getDistributedTimeout()
String	getFetchPlan()
Set<String>	getInvolvedClusters() Returns the involved clusters.
Map<Object,Object>	getParameters()
int	getSecurityOperationType() Returns the security operation type use to check about security.
String	getSyntax()
boolean	involveSchema()
boolean	isCacheable() Returns true if the command results can be cached.
boolean	isIdempotent() Returns true if the command doesn't change the database, otherwise false.
boolean	isLocalExecution() Returns true if the command must be executed on local node on distributed configuration.
Object	mergeResults(Map<String,Object> results)
<RET extends OCommandExecutor> RET	parse(OCommandRequest iRequest) Parse the request.
void	setContext(OCommandContext context)
<RET extends OCommandExecutor> RET	setLimit(int iLimit)
<RET extends OCommandExecutor> RET	setProgressListener(OProgressListener progressListener) Set the listener invoked while the command is executing.

Method Detail

parse

<RET extends OCommandExecutor> RET parse(OCommandRequest iRequest)

Parse the request. Once parsed the command can be executed multiple times by using the execute() method.

Parameters:

iRequest - Command request implementation.

Returns:

See Also:

#execute(Map...)

execute

Object execute(Map<Object,Object> iArgs)

Execute the requested command parsed previously.

Parameters:

iArgs - Optional variable arguments to pass to the command.

Returns:

See Also:

parse(OCommandRequest)

setProgressListener

<RET extends OCommandExecutor> RET setProgressListener(OProgressListener progressListener)

Set the listener invoked while the command is executing.

Parameters:

progressListener - OProgressListener implementation

Returns:

setLimit

<RET extends OCommandExecutor> RET setLimit(int iLimit)

getFetchPlan

String getFetchPlan()

getParameters

Map<Object,Object> getParameters()

getContext

OCommandContext getContext()

setContext

void setContext(OCommandContext context)

isIdempotent

boolean isIdempotent()

Returns true if the command doesn't change the database, otherwise false.

getInvolvedClusters

Set<String> getInvolvedClusters()

Returns the involved clusters.

getSecurityOperationType

int getSecurityOperationType()

Returns the security operation type use to check about security.

Returns:

See Also:

PERMISSION_*

involveSchema

boolean involveSchema()

getSyntax

String getSyntax()

isLocalExecution

boolean isLocalExecution()

Returns true if the command must be executed on local node on distributed configuration.

isCacheable

boolean isCacheable()

Returns true if the command results can be cached.

getDistributedTimeout

long getDistributedTimeout()

mergeResults

Object mergeResults(Map<String,Object> results)
             throws Exception

Throws:

Exception