com.tinkerpop.blueprints.impls.orient

Class OrientGraphCommand

java.lang.Object

com.tinkerpop.blueprints.impls.orient.OrientGraphCommand

All Implemented Interfaces:

OCommandRequest

public class OrientGraphCommand
extends Object
implements OCommandRequest

Command wraps the command request and return wrapped Graph Element such as Vertex and Edge

Author:

Luca Garulli (http://www.orientechnologies.com)

Constructor Summary

Constructors

Constructor and Description
OrientGraphCommand(OrientBaseGraph iGraph, OCommandRequest iCommand)

Method Summary

Modifier and Type	Method and Description
<RET> RET	execute(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.
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	isIdempotent() Returns true if the command doesn't change the database, otherwise false.
OCommandRequest	setContext(OCommandContext iContext)
<RET extends OCommandRequest> RET	setFetchPlan(String iFetchPlan) This api is deprecated use sql keyword "FETCHPLAN" instead Set the fetch plan.
OCommandRequest	setLimit(int iLimit) This api is deprecated use sql keyword "LIMIT" instead Sets the maximum items the command can returns.
void	setTimeout(long timeout, OCommandContext.TIMEOUT_STRATEGY strategy) This api is deprecated use sql keyword "TIMEOUT" instead Sets the command timeout.
void	setUseCache(boolean iUseCache)

Methods inherited from class java.lang.Object

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

Constructor Detail

OrientGraphCommand

public OrientGraphCommand(OrientBaseGraph iGraph,
                          OCommandRequest iCommand)

Method Detail

execute

public <RET> RET execute(Object... iArgs)

Specified by:

execute in interface OCommandRequest

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 OCommandRequest setLimit(int iLimit)

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:

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

Returns:

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:

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:

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

isIdempotent

public boolean isIdempotent()

Description copied from interface: OCommandRequest

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

Specified by:

isIdempotent in interface OCommandRequest

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 iFetchPlan)

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:

setUseCache

public void setUseCache(boolean iUseCache)

Specified by:

setUseCache in interface OCommandRequest

getContext

public OCommandContext getContext()

Specified by:

getContext in interface OCommandRequest

setContext

public OCommandRequest setContext(OCommandContext iContext)

Specified by:

setContext in interface OCommandRequest