OMatchStatement (OrientDB 3.1.2-SNAPSHOT API)

java.lang.Object
- com.orientechnologies.orient.core.sql.parser.SimpleNode
- - com.orientechnologies.orient.core.sql.parser.OStatement
  - - com.orientechnologies.orient.core.sql.parser.OMatchStatement

All Implemented Interfaces:: OCommandExecutor, OIterableRecordSource, Node

public class OMatchStatement
extends OStatement
implements OCommandExecutor, OIterableRecordSource

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`OMatchStatement.EdgeTraversal`
`class`	`OMatchStatement.MatchContext`
`static class`	`OMatchStatement.MatchExecutionPlan`

Field Summary

Fields
Modifier and Type	Field and Description
`protected OGroupBy`	`groupBy`
`static String`	`KEYWORD_MATCH`
`protected OLimit`	`limit`
`protected List<OMatchExpression>`	`matchExpressions`
`protected List<OMatchExpression>`	`notMatchExpressions`
`protected OOrderBy`	`orderBy`
`protected Pattern`	`pattern`
`protected List<OIdentifier>`	`returnAliases`
`protected boolean`	`returnDistinct`
`protected List<OExpression>`	`returnItems`
`protected List<ONestedProjection>`	`returnNestedProjections`
`protected OSkip`	`skip`
`protected OUnwind`	`unwind`

Fields inherited from class com.orientechnologies.orient.core.sql.parser.OStatement
CUSTOM_STRICT_SQL, originalStatement

Fields inherited from class com.orientechnologies.orient.core.sql.parser.SimpleNode
children, firstToken, id, lastToken, parent, parser, value

Constructor Summary

Constructors
Constructor and Description

OMatchStatement()

OMatchStatement(int id)

OMatchStatement(OrientSql p, int id)

Constructors
Constructor and Description
`OMatchStatement()`
`OMatchStatement(int id)`
`OMatchStatement(OrientSql p, int id)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`buildPatterns()`
`OMatchStatement`	`copy()`
`OInternalExecutionPlan`	`createExecutionPlan(OCommandContext ctx, boolean enableProfiling)` creates an execution plan for current statement
`boolean`	`equals(Object o)`
`Object`	`execute(Map<Object,Object> iArgs)` this method works statefully, using request and context variables from current Match statement.
`OResultSet`	`execute(ODatabase db, Map params, OCommandContext parentCtx, boolean usePlanCache)`
`OResultSet`	`execute(ODatabase db, Object[] args, OCommandContext parentCtx, boolean usePlanCache)`
`Object`	`execute(OSQLAsynchQuery<ODocument> request, OCommandContext context, OProgressListener progressListener)` executes the match statement.
`OCommandContext`	`getContext()`
`long`	`getDistributedTimeout()`
`String`	`getFetchPlan()`
`OGroupBy`	`getGroupBy()`
`Set<String>`	`getInvolvedClusters()` Returns the involved clusters.
`OLimit`	`getLimit()`
`List<OMatchExpression>`	`getMatchExpressions()`
`List<OMatchExpression>`	`getNotMatchExpressions()`
`OOrderBy`	`getOrderBy()`
`Map<Object,Object>`	`getParameters()`
`protected Object`	`getResult(OSQLAsynchQuery<ODocument> request)`
`List<OIdentifier>`	`getReturnAliases()`
`List<OExpression>`	`getReturnItems()`
`List<ONestedProjection>`	`getReturnNestedProjections()`
`int`	`getSecurityOperationType()` Returns the security operation type use to check about security.
`OSkip`	`getSkip()`
`String`	`getSyntax()`
`OUnwind`	`getUnwind()`
`int`	`hashCode()`
`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.
`boolean`	`isReturnDistinct()`
`Iterator<OIdentifiable>`	`iterator(Map<Object,Object> iArgs)`
`Object`	`mergeResults(Map<String,Object> results)`
`<RET extends OCommandExecutor> RET`	`parse(OCommandRequest iRequest)` this method parses the statement
`boolean`	`refersToParent()`
`boolean`	`returnsElements()`
`boolean`	`returnsPathElements()`
`boolean`	`returnsPaths()`
`boolean`	`returnsPatterns()`
`void`	`setContext(OCommandContext context)`
`void`	`setGroupBy(OGroupBy groupBy)`
`<RET extends OCommandExecutor> RET`	`setLimit(int iLimit)`
`void`	`setLimit(OLimit limit)`
`void`	`setMatchExpressions(List<OMatchExpression> matchExpressions)`
`void`	`setNotMatchExpressions(List<OMatchExpression> notMatchExpressions)`
`void`	`setOrderBy(OOrderBy orderBy)`
`<RET extends OCommandExecutor> RET`	`setProgressListener(OProgressListener progressListener)` Set the listener invoked while the command is executing.
`void`	`setReturnAliases(List<OIdentifier> returnAliases)`
`void`	`setReturnDistinct(boolean returnDistinct)`
`void`	`setReturnItems(List<OExpression> returnItems)`
`void`	`setReturnNestedProjections(List<ONestedProjection> returnNestedProjections)`
`void`	`setSkip(OSkip skip)`
`void`	`setUnwind(OUnwind unwind)`
`void`	`toString(Map<Object,Object> params, StringBuilder builder)`

Methods inherited from class com.orientechnologies.orient.core.sql.parser.OStatement
createExecutionPlan, createExecutionPlanNoCache, deserialize, deserializeFromOResult, execute, execute, execute, execute, execute, execute, executinPlanCanBeCached, getOriginalStatement, serialize, setOriginalStatement, toString, validate

Methods inherited from class com.orientechnologies.orient.core.sql.parser.SimpleNode
childrenAccept, dump, getDatabase, getValue, jjtAccept, jjtAddChild, jjtClose, jjtGetChild, jjtGetFirstToken, jjtGetLastToken, jjtGetNumChildren, jjtGetParent, jjtGetValue, jjtOpen, jjtSetFirstToken, jjtSetLastToken, jjtSetParent, jjtSetValue, toString

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

Field Detail

KEYWORD_MATCH

public static final String KEYWORD_MATCH

See Also:: Constant Field Values

matchExpressions

protected List<OMatchExpression> matchExpressions

notMatchExpressions

protected List<OMatchExpression> notMatchExpressions

returnItems

protected List<OExpression> returnItems

returnAliases

protected List<OIdentifier> returnAliases

returnNestedProjections

protected List<ONestedProjection> returnNestedProjections

returnDistinct
```
protected boolean returnDistinct
```

groupBy
```
protected OGroupBy groupBy
```

orderBy
```
protected OOrderBy orderBy
```

unwind
```
protected OUnwind unwind
```

skip
```
protected OSkip skip
```

limit
```
protected OLimit limit
```

pattern
```
protected Pattern pattern
```

Constructor Detail

OMatchStatement
```
public OMatchStatement()
```

OMatchStatement
```
public OMatchStatement(int id)
```

OMatchStatement

public OMatchStatement(OrientSql p,
                       int id)

Method Detail
- getReturnNestedProjections
```
public List<ONestedProjection> getReturnNestedProjections()
```
- setReturnNestedProjections
```
public void setReturnNestedProjections(List<ONestedProjection> returnNestedProjections)
```
- execute
```
public OResultSet execute(ODatabase db,
                          Object[] args,
                          OCommandContext parentCtx,
                          boolean usePlanCache)
```
  Overrides:
  
  execute in class OStatement
- execute
```
public OResultSet execute(ODatabase db,
                          Map params,
                          OCommandContext parentCtx,
                          boolean usePlanCache)
```
  Overrides:
  
  execute in class OStatement
- createExecutionPlan
```
public OInternalExecutionPlan createExecutionPlan(OCommandContext ctx,
                                                  boolean enableProfiling)
```
  Description copied from class: OStatement
  
  creates an execution plan for current statement
  
  Overrides:
  
  createExecutionPlan in class OStatement
  
  Parameters:
  
  ctx - the context that will be used to execute the statement
  
  enableProfiling - true to enable profiling, false to disable it
  
  Returns:
  
  an execution plan
- parse
```
public <RET extends OCommandExecutor> RET parse(OCommandRequest iRequest)
```
  this method parses the statement
  
  Specified by:
  
  parse in interface OCommandExecutor
  
  Type Parameters:
  
  RET -
  
  Parameters:
  
  iRequest - Command request implementation.
  
  Returns:
  
  See Also:
  
  #execute(Map...)
- buildPatterns
```
protected void buildPatterns()
```
- execute
```
public Object execute(Map<Object,Object> iArgs)
```
  this method works statefully, using request and context variables from current Match statement. This method will be deprecated in next releases
  
  Specified by:
  
  execute in interface OCommandExecutor
  
  Parameters:
  
  iArgs - Optional variable arguments to pass to the command.
  
  Returns:
  
  See Also:
  
  OCommandExecutor.parse(OCommandRequest)
- execute
```
public Object execute(OSQLAsynchQuery<ODocument> request,
                      OCommandContext context,
                      OProgressListener progressListener)
```
  executes the match statement. This is the preferred execute() method and it has to be used as the default one in the future. This method works in stateless mode
  
  Overrides:
  
  execute in class OStatement
  
  Parameters:
  
  request -
  
  context -
  
  Returns:
- getResult
```
protected Object getResult(OSQLAsynchQuery<ODocument> request)
```
- returnsPathElements
```
public boolean returnsPathElements()
```
- returnsElements
```
public boolean returnsElements()
```
- returnsPatterns
```
public boolean returnsPatterns()
```
- returnsPaths
```
public boolean returnsPaths()
```
- setProgressListener
```
public <RET extends OCommandExecutor> RET setProgressListener(OProgressListener progressListener)
```
  Description copied from interface: OCommandExecutor
  
  Set the listener invoked while the command is executing.
  
  Specified by:
  
  setProgressListener in interface OCommandExecutor
  
  Parameters:
  
  progressListener - OProgressListener implementation
  
  Returns:
- setLimit
```
public <RET extends OCommandExecutor> RET setLimit(int iLimit)
```
  Specified by:
  
  setLimit in interface OCommandExecutor
- getFetchPlan
```
public String getFetchPlan()
```
  Specified by:
  
  getFetchPlan in interface OCommandExecutor
- getParameters
```
public Map<Object,Object> getParameters()
```
  Specified by:
  
  getParameters in interface OCommandExecutor
- getContext
```
public OCommandContext getContext()
```
  Specified by:
  
  getContext in interface OCommandExecutor
- setContext
```
public void setContext(OCommandContext context)
```
  Specified by:
  
  setContext in interface OCommandExecutor
- isIdempotent
```
public boolean isIdempotent()
```
  Description copied from interface: OCommandExecutor
  
  Returns true if the command doesn't change the database, otherwise false.
  
  Specified by:
  
  isIdempotent in interface OCommandExecutor
  
  Overrides:
  
  isIdempotent in class OStatement
- getInvolvedClusters
```
public Set<String> getInvolvedClusters()
```
  Description copied from interface: OCommandExecutor
  
  Returns the involved clusters.
  
  Specified by:
  
  getInvolvedClusters in interface OCommandExecutor
- getSecurityOperationType
```
public int getSecurityOperationType()
```
  Description copied from interface: OCommandExecutor
  
  Returns the security operation type use to check about security.
  
  Specified by:
  
  getSecurityOperationType in interface OCommandExecutor
  
  Returns:
  
  See Also:
  
  PERMISSION_*
- involveSchema
```
public boolean involveSchema()
```
  Specified by:
  
  involveSchema in interface OCommandExecutor
- getSyntax
```
public String getSyntax()
```
  Specified by:
  
  getSyntax in interface OCommandExecutor
- isLocalExecution
```
public boolean isLocalExecution()
```
  Description copied from interface: OCommandExecutor
  
  Returns true if the command must be executed on local node on distributed configuration.
  
  Specified by:
  
  isLocalExecution in interface OCommandExecutor
- isCacheable
```
public boolean isCacheable()
```
  Description copied from interface: OCommandExecutor
  
  Returns true if the command results can be cached.
  
  Specified by:
  
  isCacheable in interface OCommandExecutor
- getDistributedTimeout
```
public long getDistributedTimeout()
```
  Specified by:
  
  getDistributedTimeout in interface OCommandExecutor
- mergeResults
```
public Object mergeResults(Map<String,Object> results)
                    throws Exception
```
  Specified by:
  
  mergeResults in interface OCommandExecutor
  
  Throws:
  
  Exception
- toString
```
public void toString(Map<Object,Object> params,
                     StringBuilder builder)
```
  Overrides:
  
  toString in class OStatement
- iterator
```
public Iterator<OIdentifiable> iterator(Map<Object,Object> iArgs)
```
  Specified by:
  
  iterator in interface OIterableRecordSource
- copy
```
public OMatchStatement copy()
```
  Overrides:
  
  copy in class OStatement
- equals
```
public boolean equals(Object o)
```
  Overrides:
  
  equals in class Object
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class Object
- getLimit
```
public OLimit getLimit()
```
- setLimit
```
public void setLimit(OLimit limit)
```
- getReturnAliases
```
public List<OIdentifier> getReturnAliases()
```
- setReturnAliases
```
public void setReturnAliases(List<OIdentifier> returnAliases)
```
- getReturnItems
```
public List<OExpression> getReturnItems()
```
- setReturnItems
```
public void setReturnItems(List<OExpression> returnItems)
```
- getMatchExpressions
```
public List<OMatchExpression> getMatchExpressions()
```
- setMatchExpressions
```
public void setMatchExpressions(List<OMatchExpression> matchExpressions)
```
- getNotMatchExpressions
```
public List<OMatchExpression> getNotMatchExpressions()
```
- setNotMatchExpressions
```
public void setNotMatchExpressions(List<OMatchExpression> notMatchExpressions)
```
- isReturnDistinct
```
public boolean isReturnDistinct()
```
- setReturnDistinct
```
public void setReturnDistinct(boolean returnDistinct)
```
- getOrderBy
```
public OOrderBy getOrderBy()
```
- setOrderBy
```
public void setOrderBy(OOrderBy orderBy)
```
- getGroupBy
```
public OGroupBy getGroupBy()
```
- setGroupBy
```
public void setGroupBy(OGroupBy groupBy)
```
- getUnwind
```
public OUnwind getUnwind()
```
- setUnwind
```
public void setUnwind(OUnwind unwind)
```
- getSkip
```
public OSkip getSkip()
```
- setSkip
```
public void setSkip(OSkip skip)
```
- refersToParent
```
public boolean refersToParent()
```
  Overrides:
  
  refersToParent in class OStatement

Class OMatchStatement

Nested Class Summary

Field Summary

Fields inherited from class com.orientechnologies.orient.core.sql.parser.OStatement

Fields inherited from class com.orientechnologies.orient.core.sql.parser.SimpleNode

Constructor Summary

Method Summary

Methods inherited from class com.orientechnologies.orient.core.sql.parser.OStatement

Methods inherited from class com.orientechnologies.orient.core.sql.parser.SimpleNode

Methods inherited from class java.lang.Object

Field Detail

KEYWORD_MATCH

matchExpressions

notMatchExpressions

returnItems

returnAliases

returnNestedProjections

returnDistinct

groupBy

orderBy

unwind

skip

limit

pattern

Constructor Detail

OMatchStatement

OMatchStatement

OMatchStatement

Method Detail

getReturnNestedProjections

setReturnNestedProjections

execute

execute

createExecutionPlan

parse

buildPatterns

execute

execute

getResult

returnsPathElements

returnsElements

returnsPatterns

returnsPaths

setProgressListener

setLimit

getFetchPlan

getParameters

getContext

setContext

isIdempotent

getInvolvedClusters

getSecurityOperationType

involveSchema

getSyntax

isLocalExecution

isCacheable

getDistributedTimeout

mergeResults

toString

iterator

copy

equals

hashCode

getLimit

setLimit

getReturnAliases

setReturnAliases

getReturnItems

setReturnItems

getMatchExpressions

setMatchExpressions

getNotMatchExpressions

setNotMatchExpressions

isReturnDistinct

setReturnDistinct

getOrderBy

setOrderBy

getGroupBy

setGroupBy

getUnwind