com.orientechnologies.orient.core.command.script

Class OCommandScript

java.lang.Object

com.orientechnologies.orient.core.command.OCommandRequestAbstract

com.orientechnologies.orient.core.command.OCommandRequestTextAbstract

com.orientechnologies.orient.core.command.script.OCommandScript

All Implemented Interfaces:

OCommandRequest, OCommandRequestInternal, OCommandRequestText, ODistributedCommand, OSerializableStream, Serializable

public class OCommandScript
extends OCommandRequestTextAbstract

Script command request implementation. It just stores the request and delegated the execution to the configured OCommandExecutor.

Author:

Luca Garulli

See Also:

OCommandExecutorScript, Serialized Form

Field Summary

Fields inherited from class com.orientechnologies.orient.core.command.OCommandRequestTextAbstract

text

Fields inherited from class com.orientechnologies.orient.core.command.OCommandRequestAbstract

cacheableResult, context, fetchPlan, limit, onAsyncReplicationError, onAsyncReplicationOk, parameters, progressListener, resultListener, timeoutMs, timeoutStrategy, useCache

Constructor Summary

Constructors

Constructor and Description
OCommandScript()
OCommandScript(String iText)
OCommandScript(String iLanguage, String iText)

Method Summary

Modifier and Type	Method and Description
OSerializableStream	fromStream(byte[] iStream) Unmarshalls the object.
CompiledScript	getCompiledScript()
OCommandDistributedReplicateRequest.DISTRIBUTED_EXECUTION_MODE	getExecutionMode()
String	getLanguage()
boolean	isIdempotent() Returns true if the command doesn't change the database, otherwise false.
void	setCompiledScript(CompiledScript script)
OCommandScript	setExecutionMode(OCommandDistributedReplicateRequest.DISTRIBUTED_EXECUTION_MODE executionMode)
OCommandScript	setLanguage(String language)
byte[]	toStream() Marshalls the object.
String	toString()

Methods inherited from class com.orientechnologies.orient.core.command.OCommandRequestTextAbstract

execute, fromStream, getText, setText, toStream

Methods inherited from class com.orientechnologies.orient.core.command.OCommandRequestAbstract

addExcludedNode, convertToParameters, getContext, getFetchPlan, getLimit, getOnAsyncReplicationError, getOnAsyncReplicationOk, getParameters, getProgressListener, getResultListener, getTimeoutStrategy, getTimeoutTime, isCacheableResult, isRecordResultSet, isUseCache, nodesToExclude, onAsyncReplicationError, onAsyncReplicationOk, removeExcludedNode, reset, setCacheableResult, setContext, setFetchPlan, setLimit, setParameters, setProgressListener, setRecordResultSet, setResultListener, setTimeout, setUseCache

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.orientechnologies.orient.core.command.OCommandRequestInternal

getParameters, getProgressListener, getResultListener, isCacheableResult, isRecordResultSet, reset, setCacheableResult, setProgressListener, setRecordResultSet, setResultListener

Methods inherited from interface com.orientechnologies.orient.core.command.OCommandRequest

getContext, getFetchPlan, getLimit, getTimeoutStrategy, getTimeoutTime, setContext, setFetchPlan, setLimit, setTimeout, setUseCache

Constructor Detail

OCommandScript

public OCommandScript()

OCommandScript

public OCommandScript(String iLanguage,
                      String iText)

OCommandScript

public OCommandScript(String iText)

Method Detail

isIdempotent

public boolean isIdempotent()

Description copied from interface: OCommandRequest

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

getLanguage

public String getLanguage()

setLanguage

public OCommandScript setLanguage(String language)

fromStream

public OSerializableStream fromStream(byte[] iStream)
                               throws OSerializationException

Description copied from interface: OSerializableStream

Unmarshalls the object. Fills the current object with the values contained in the byte array representation restoring a previous state. Usually byte[] comes from the storage or network.

Specified by:

fromStream in interface OSerializableStream

Overrides:

fromStream in class OCommandRequestTextAbstract

Parameters:

iStream - byte array representation of the object

Returns:

The Object instance itself giving a "fluent interface". Useful to call multiple methods in chain.

Throws:

OSerializationException - if the unmarshalling does not succeed

toStream

public byte[] toStream()
                throws OSerializationException

Description copied from interface: OSerializableStream

Marshalls the object. Transforms the current object in byte[] form to being stored or transferred over the network.

Specified by:

toStream in interface OSerializableStream

Overrides:

toStream in class OCommandRequestTextAbstract

Returns:

The byte array representation of the object

Throws:

OSerializationException - if the marshalling does not succeed

See Also:

OSerializableStream.fromStream(byte[])

getCompiledScript

public CompiledScript getCompiledScript()

setCompiledScript

public void setCompiledScript(CompiledScript script)

toString

public String toString()

Overrides:

toString in class OCommandRequestTextAbstract

getExecutionMode

public OCommandDistributedReplicateRequest.DISTRIBUTED_EXECUTION_MODE getExecutionMode()

setExecutionMode

public OCommandScript setExecutionMode(OCommandDistributedReplicateRequest.DISTRIBUTED_EXECUTION_MODE executionMode)