com.orientechnologies.orient.core.command

Class OCommandRequestAbstract

java.lang.Object

com.orientechnologies.orient.core.command.OCommandRequestAbstract

All Implemented Interfaces:

OCommandRequest, OCommandRequestInternal, ODistributedCommand, OSerializableStream, Serializable

Direct Known Subclasses:

OCommandRequestTextAbstract, OQueryAbstract

public abstract class OCommandRequestAbstract
extends Object
implements OCommandRequestInternal, ODistributedCommand

Text based Command Request abstract class.

Author:

Luca Garulli

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	cacheableResult
protected OCommandContext	context
protected String	fetchPlan
protected int	limit
protected OAsyncReplicationError	onAsyncReplicationError
protected OAsyncReplicationOk	onAsyncReplicationOk
protected Map<Object,Object>	parameters
protected OProgressListener	progressListener
protected OCommandResultListener	resultListener
protected long	timeoutMs
protected OCommandContext.TIMEOUT_STRATEGY	timeoutStrategy
protected boolean	useCache

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OCommandRequestAbstract()

Method Summary

Modifier and Type	Method and Description
void	addExcludedNode(String node)
protected Map<Object,Object>	convertToParameters(Object... iArgs)
OCommandContext	getContext()
String	getFetchPlan() This api is deprecated use sql keyword "FETCHPLAN" instead Returns the fetch plan if any
int	getLimit() This api is deprecated use sql keyword "LIMIT" instead Returns the limit of result set.
OAsyncReplicationError	getOnAsyncReplicationError()
OAsyncReplicationOk	getOnAsyncReplicationOk()
Map<Object,Object>	getParameters()
OProgressListener	getProgressListener()
OCommandResultListener	getResultListener()
OCommandContext.TIMEOUT_STRATEGY	getTimeoutStrategy() This api is deprecated use sql keyword "TIMEOUT" instead Returns the command timeout strategy between the defined ones.
long	getTimeoutTime() This api is deprecated use sql keyword "TIMEOUT" instead Returns the command timeout.
boolean	isCacheableResult()
boolean	isRecordResultSet()
boolean	isUseCache()
Set<String>	nodesToExclude()
OCommandRequestAbstract	onAsyncReplicationError(OAsyncReplicationError iCallback) Defines a callback to call in case of error during the asynchronous replication.
OCommandRequestAbstract	onAsyncReplicationOk(OAsyncReplicationOk iCallback) Defines a callback to call in case of the asynchronous replication succeed.
void	removeExcludedNode(String node)
void	reset()
void	setCacheableResult(boolean iValue)
OCommandRequestAbstract	setContext(OCommandContext iContext)
<RET extends OCommandRequest> RET	setFetchPlan(String fetchPlan) This api is deprecated use sql keyword "FETCHPLAN" instead Set the fetch plan.
OCommandRequestAbstract	setLimit(int limit) This api is deprecated use sql keyword "LIMIT" instead Sets the maximum items the command can returns.
protected void	setParameters(Object... iArgs)
OCommandRequestAbstract	setProgressListener(OProgressListener progressListener)
void	setRecordResultSet(boolean recordResultSet) Communicate to a listener if the result set is an record based or anything else
void	setResultListener(OCommandResultListener iListener)
void	setTimeout(long timeout, OCommandContext.TIMEOUT_STRATEGY strategy) This api is deprecated use sql keyword "TIMEOUT" instead Sets the command timeout.
void	setUseCache(boolean useCache)

Methods inherited from class java.lang.Object

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

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

execute, isIdempotent

Methods inherited from interface com.orientechnologies.orient.core.serialization.OSerializableStream

fromStream, toStream

Field Detail

resultListener

protected OCommandResultListener resultListener

progressListener

protected OProgressListener progressListener

limit

protected int limit

timeoutMs

protected long timeoutMs

timeoutStrategy

protected OCommandContext.TIMEOUT_STRATEGY timeoutStrategy

parameters

protected Map<Object,Object> parameters

fetchPlan

protected String fetchPlan

useCache

protected boolean useCache

cacheableResult

protected boolean cacheableResult

context

protected OCommandContext context

onAsyncReplicationOk

protected OAsyncReplicationOk onAsyncReplicationOk

onAsyncReplicationError

protected OAsyncReplicationError onAsyncReplicationError

Constructor Detail

OCommandRequestAbstract

protected OCommandRequestAbstract()

Method Detail

getResultListener

public OCommandResultListener getResultListener()

Specified by:

getResultListener in interface OCommandRequestInternal

setResultListener

public void setResultListener(OCommandResultListener iListener)

Specified by:

setResultListener in interface OCommandRequestInternal

getParameters

public Map<Object,Object> getParameters()

Specified by:

getParameters in interface OCommandRequestInternal

setParameters

protected void setParameters(Object... iArgs)

convertToParameters

protected Map<Object,Object> convertToParameters(Object... iArgs)

onAsyncReplicationOk

public OCommandRequestAbstract onAsyncReplicationOk(OAsyncReplicationOk iCallback)

Defines a callback to call in case of the asynchronous replication succeed.

Specified by:

onAsyncReplicationOk in interface ODistributedCommand

onAsyncReplicationError

public OCommandRequestAbstract onAsyncReplicationError(OAsyncReplicationError iCallback)

Defines a callback to call in case of error during the asynchronous replication.

Specified by:

onAsyncReplicationError in interface ODistributedCommand

getProgressListener

public OProgressListener getProgressListener()

Specified by:

getProgressListener in interface OCommandRequestInternal

setProgressListener

public OCommandRequestAbstract setProgressListener(OProgressListener progressListener)

Specified by:

setProgressListener in interface OCommandRequestInternal

reset

public void reset()

Specified by:

reset in interface OCommandRequestInternal

getLimit

public int getLimit()

Description copied from interface: OCommandRequest

This api is deprecated use sql keyword "LIMIT" instead Returns the limit of result set. -1 means no limits.

Specified by:

getLimit in interface OCommandRequest

setLimit

public OCommandRequestAbstract setLimit(int limit)

Description copied from interface: OCommandRequest

This api is deprecated use sql keyword "LIMIT" instead Sets the maximum items the command can returns. -1 means no limits.

Specified by:

setLimit in interface OCommandRequest

Parameters:

limit - -1 = no limit. 1 to N to limit the result set.

Returns:

getFetchPlan

public String getFetchPlan()

Description copied from interface: OCommandRequest

This api is deprecated use sql keyword "FETCHPLAN" instead Returns the fetch plan if any

Specified by:

getFetchPlan in interface OCommandRequest

Returns:

Fetch plan as unique string or null if it was not defined.

setFetchPlan

public <RET extends OCommandRequest> RET setFetchPlan(String fetchPlan)

Description copied from interface: OCommandRequest

This api is deprecated use sql keyword "FETCHPLAN" instead Set the fetch plan. The format is:

 <field>:<depth-level>*
 

Where:

• field is the name of the field to specify the depth-level. * wildcard means any fields
• depth-level is the depth level to fetch. -1 means infinite, 0 means no fetch at all and 1-N the depth level value.

Uses the blank spaces to separate the fields strategies.
Example:

 children:-1 parent:0 sibling:3 *:0
 

Specified by:

setFetchPlan in interface OCommandRequest

Returns:

isUseCache

public boolean isUseCache()

setUseCache

public void setUseCache(boolean useCache)

Specified by:

setUseCache in interface OCommandRequest

isCacheableResult

public boolean isCacheableResult()

Specified by:

isCacheableResult in interface OCommandRequestInternal

setCacheableResult

public void setCacheableResult(boolean iValue)

Specified by:

setCacheableResult in interface OCommandRequestInternal

getContext

public OCommandContext getContext()

Specified by:

getContext in interface OCommandRequest

setContext

public OCommandRequestAbstract setContext(OCommandContext iContext)

Specified by:

setContext in interface OCommandRequest

getTimeoutTime

public long getTimeoutTime()

Description copied from interface: OCommandRequest

This api is deprecated use sql keyword "TIMEOUT" instead Returns the command timeout. 0 means no timeout.

Specified by:

getTimeoutTime in interface OCommandRequest

Returns:

setTimeout

public void setTimeout(long timeout,
                       OCommandContext.TIMEOUT_STRATEGY strategy)

Description copied from interface: OCommandRequest

This api is deprecated use sql keyword "TIMEOUT" instead Sets the command timeout. When the command execution time is major than the timeout the command returns

Specified by:

setTimeout in interface OCommandRequest

getTimeoutStrategy

public OCommandContext.TIMEOUT_STRATEGY getTimeoutStrategy()

Description copied from interface: OCommandRequest

This api is deprecated use sql keyword "TIMEOUT" instead Returns the command timeout strategy between the defined ones.

Specified by:

getTimeoutStrategy in interface OCommandRequest

Returns:

nodesToExclude

public Set<String> nodesToExclude()

Specified by:

nodesToExclude in interface ODistributedCommand

addExcludedNode

public void addExcludedNode(String node)

removeExcludedNode

public void removeExcludedNode(String node)

getOnAsyncReplicationOk

public OAsyncReplicationOk getOnAsyncReplicationOk()

getOnAsyncReplicationError

public OAsyncReplicationError getOnAsyncReplicationError()

setRecordResultSet

public void setRecordResultSet(boolean recordResultSet)

Description copied from interface: OCommandRequestInternal

Communicate to a listener if the result set is an record based or anything else

Specified by:

setRecordResultSet in interface OCommandRequestInternal

isRecordResultSet

public boolean isRecordResultSet()

Specified by:

isRecordResultSet in interface OCommandRequestInternal