OrientGraphQuery (OrientDB 3.1.2-SNAPSHOT API)

java.lang.Object
- com.tinkerpop.blueprints.util.DefaultQuery
- - com.tinkerpop.blueprints.util.DefaultGraphQuery
  - - com.tinkerpop.blueprints.impls.orient.OrientGraphQuery

All Implemented Interfaces:

com.tinkerpop.blueprints.GraphQuery, com.tinkerpop.blueprints.Query
```
public class OrientGraphQuery
extends com.tinkerpop.blueprints.util.DefaultGraphQuery
```
OrientDB implementation for Graph query.

Author:

Luca Garulli (l.garulli--(at)--orientdb.com) (http://orientdb.com)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class OrientGraphQuery.OrientGraphQueryIterable<T extends com.tinkerpop.blueprints.Element>
- Nested classes/interfaces inherited from class com.tinkerpop.blueprints.util.DefaultGraphQuery
  com.tinkerpop.blueprints.util.DefaultGraphQuery.DefaultGraphQueryIterable<T extends com.tinkerpop.blueprints.Element>
- Nested classes/interfaces inherited from class com.tinkerpop.blueprints.util.DefaultQuery
  com.tinkerpop.blueprints.util.DefaultQuery.HasContainer
- Nested classes/interfaces inherited from interface com.tinkerpop.blueprints.Query
  com.tinkerpop.blueprints.Query.Compare

Nested Classes
Modifier and Type	Class and Description
`class`	`OrientGraphQuery.OrientGraphQueryIterable<T extends com.tinkerpop.blueprints.Element>`

Field Summary

Fields
Modifier and Type	Field and Description
`protected static char`	`COLLECTION_BEGIN`
`protected static char`	`COLLECTION_END`
`protected String`	`fetchPlan`
`protected static String`	`LIMIT`
`protected static String`	`OPERATOR_DIFFERENT`
`protected static String`	`OPERATOR_EQUALS`
`protected static char`	`OPERATOR_GT`
`protected static String`	`OPERATOR_GTE`
`protected static String`	`OPERATOR_IN`
`protected static String`	`OPERATOR_IS`
`protected static String`	`OPERATOR_IS_NOT`
`protected static String`	`OPERATOR_LET`
`protected static String`	`OPERATOR_LIKE`
`protected static char`	`OPERATOR_LT`
`protected static String`	`OPERATOR_NOT`
`String`	`orderBy`
`protected static String`	`ORDERBY`
`String`	`orderByDir`
`protected static char`	`PARENTHESIS_BEGIN`
`protected static char`	`PARENTHESIS_END`
`protected static String`	`QUERY_FILTER_AND`
`protected static String`	`QUERY_FILTER_OR`
`protected static String`	`QUERY_LABEL_BEGIN`
`protected static String`	`QUERY_LABEL_END`
`protected static String`	`QUERY_SELECT_FROM`
`protected static char`	`QUERY_SEPARATOR`
`protected static char`	`QUERY_STRING`
`protected static String`	`QUERY_WHERE`
`int`	`skip`
`protected static String`	`SKIP`
`protected static char`	`SPACE`

Fields inherited from class com.tinkerpop.blueprints.util.DefaultGraphQuery
graph

Fields inherited from class com.tinkerpop.blueprints.util.DefaultQuery
direction, hasContainers, labels, limit

Constructor Summary

Constructors
Modifier Constructor and Description

protected OrientGraphQuery(com.tinkerpop.blueprints.Graph iGraph)

Constructors
Modifier	Constructor and Description
`protected`	`OrientGraphQuery(com.tinkerpop.blueprints.Graph iGraph)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Iterable<com.tinkerpop.blueprints.Edge>`	`edges()` Returns the result set of the query as iterable edges.
`protected void`	`generateFilterValue(StringBuilder text, Object iValue)`
`String`	`getFetchPlan()` (Blueprints Extension) Returns the fetch plan used.
`protected boolean`	`hasCustomPredicate()`
`com.tinkerpop.blueprints.Query`	`labels(String... labels)` (Blueprints Extension) Sets the labels to filter.
`protected List<Object>`	`manageFilters(StringBuilder text)`
`protected void`	`manageLabels(boolean usedWhere, StringBuilder text)`
`com.tinkerpop.blueprints.Query`	`order(String props)` (Blueprints Extension) Sets the order of results by a field in ascending (asc) order.
`com.tinkerpop.blueprints.Query`	`order(String props, String dir)` (Blueprints Extension) Sets the order of results by a field in ascending (asc) or descending (desc) order based on dir parameter.
`void`	`setFetchPlan(String fetchPlan)` (Blueprints Extension) Sets the fetch plan to use on returning result set.
`com.tinkerpop.blueprints.Query`	`skip(int iSkip)` Skips first iSkip items from the result set.
`Iterable<com.tinkerpop.blueprints.Vertex>`	`vertices()` Returns the result set of the query as iterable vertices.

Methods inherited from class com.tinkerpop.blueprints.util.DefaultGraphQuery
has, has, has, has, hasNot, hasNot, interval, limit

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

- Field Detail
  - SPACE
```
protected static final char SPACE
```
    See Also:
    
    Constant Field Values
  - OPERATOR_DIFFERENT
```
protected static final String OPERATOR_DIFFERENT
```
    See Also:
    
    Constant Field Values
  - OPERATOR_NOT
```
protected static final String OPERATOR_NOT
```
    See Also:
    
    Constant Field Values
  - OPERATOR_IS_NOT
```
protected static final String OPERATOR_IS_NOT
```
    See Also:
    
    Constant Field Values
  - OPERATOR_LET
```
protected static final String OPERATOR_LET
```
    See Also:
    
    Constant Field Values
  - OPERATOR_LT
```
protected static final char OPERATOR_LT
```
    See Also:
    
    Constant Field Values
  - OPERATOR_GTE
```
protected static final String OPERATOR_GTE
```
    See Also:
    
    Constant Field Values
  - OPERATOR_GT
```
protected static final char OPERATOR_GT
```
    See Also:
    
    Constant Field Values
  - OPERATOR_EQUALS
```
protected static final String OPERATOR_EQUALS
```
    See Also:
    
    Constant Field Values
  - OPERATOR_IS
```
protected static final String OPERATOR_IS
```
    See Also:
    
    Constant Field Values
  - OPERATOR_IN
```
protected static final String OPERATOR_IN
```
    See Also:
    
    Constant Field Values
  - OPERATOR_LIKE
```
protected static final String OPERATOR_LIKE
```
    See Also:
    
    Constant Field Values
  - QUERY_FILTER_AND
```
protected static final String QUERY_FILTER_AND
```
    See Also:
    
    Constant Field Values
  - QUERY_FILTER_OR
```
protected static final String QUERY_FILTER_OR
```
    See Also:
    
    Constant Field Values
  - QUERY_STRING
```
protected static final char QUERY_STRING
```
    See Also:
    
    Constant Field Values
  - QUERY_SEPARATOR
```
protected static final char QUERY_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - COLLECTION_BEGIN
```
protected static final char COLLECTION_BEGIN
```
    See Also:
    
    Constant Field Values
  - COLLECTION_END
```
protected static final char COLLECTION_END
```
    See Also:
    
    Constant Field Values
  - PARENTHESIS_BEGIN
```
protected static final char PARENTHESIS_BEGIN
```
    See Also:
    
    Constant Field Values
  - PARENTHESIS_END
```
protected static final char PARENTHESIS_END
```
    See Also:
    
    Constant Field Values
  - QUERY_LABEL_BEGIN
```
protected static final String QUERY_LABEL_BEGIN
```
    See Also:
    
    Constant Field Values
  - QUERY_LABEL_END
```
protected static final String QUERY_LABEL_END
```
    See Also:
    
    Constant Field Values
  - QUERY_WHERE
```
protected static final String QUERY_WHERE
```
    See Also:
    
    Constant Field Values
  - QUERY_SELECT_FROM
```
protected static final String QUERY_SELECT_FROM
```
    See Also:
    
    Constant Field Values
  - SKIP
```
protected static final String SKIP
```
    See Also:
    
    Constant Field Values
  - LIMIT
```
protected static final String LIMIT
```
    See Also:
    
    Constant Field Values
  - ORDERBY
```
protected static final String ORDERBY
```
    See Also:
    
    Constant Field Values
  - skip
```
public int skip
```
  - orderBy
```
public String orderBy
```
  - orderByDir
```
public String orderByDir
```
  - fetchPlan
```
protected String fetchPlan
```
- Constructor Detail
  - OrientGraphQuery
```
protected OrientGraphQuery(com.tinkerpop.blueprints.Graph iGraph)
```
- Method Detail
  - labels
```
public com.tinkerpop.blueprints.Query labels(String... labels)
```
    (Blueprints Extension) Sets the labels to filter. Labels are bound to Class names by default.
    
    Parameters:
    
    labels - String vararg of labels
    
    Returns:
    
    Current Query Object to allow calls in chain.
  - skip
```
public com.tinkerpop.blueprints.Query skip(int iSkip)
```
    Skips first iSkip items from the result set.
    
    Parameters:
    
    iSkip - Number of items to skip on result set
    
    Returns:
    
    Current Query Object to allow calls in chain.
  - order
```
public com.tinkerpop.blueprints.Query order(String props)
```
    (Blueprints Extension) Sets the order of results by a field in ascending (asc) order. This is translated on ORDER BY in the underlying SQL query.
    
    Parameters:
    
    props - Field to order by
    
    Returns:
    
    Current Query Object to allow calls in chain.
  - order
```
public com.tinkerpop.blueprints.Query order(String props,
                                            String dir)
```
    (Blueprints Extension) Sets the order of results by a field in ascending (asc) or descending (desc) order based on dir parameter. This is translated on ORDER BY in the underlying SQL query.
    
    Parameters:
    
    props - Field to order by
    
    dir - Direction. Use "asc" for ascending and "desc" for descending
    
    Returns:
    
    Current Query Object to allow calls in chain.
  - vertices
```
public Iterable<com.tinkerpop.blueprints.Vertex> vertices()
```
    Returns the result set of the query as iterable vertices.
    
    Specified by:
    
    vertices in interface com.tinkerpop.blueprints.Query
    
    Overrides:
    
    vertices in class com.tinkerpop.blueprints.util.DefaultGraphQuery
  - edges
```
public Iterable<com.tinkerpop.blueprints.Edge> edges()
```
    Returns the result set of the query as iterable edges.
    
    Specified by:
    
    edges in interface com.tinkerpop.blueprints.Query
    
    Overrides:
    
    edges in class com.tinkerpop.blueprints.util.DefaultGraphQuery
  - getFetchPlan
```
public String getFetchPlan()
```
    (Blueprints Extension) Returns the fetch plan used.
  - setFetchPlan
```
public void setFetchPlan(String fetchPlan)
```
    (Blueprints Extension) Sets the fetch plan to use on returning result set.
  - manageLabels
```
protected void manageLabels(boolean usedWhere,
                            StringBuilder text)
```
  - hasCustomPredicate
```
protected boolean hasCustomPredicate()
```
  - manageFilters
```
protected List<Object> manageFilters(StringBuilder text)
```
  - generateFilterValue
```
protected void generateFilterValue(StringBuilder text,
                                   Object iValue)
```

Class OrientGraphQuery

Nested Class Summary

Nested classes/interfaces inherited from class com.tinkerpop.blueprints.util.DefaultGraphQuery

Nested classes/interfaces inherited from class com.tinkerpop.blueprints.util.DefaultQuery

Nested classes/interfaces inherited from interface com.tinkerpop.blueprints.Query

Field Summary

Fields inherited from class com.tinkerpop.blueprints.util.DefaultGraphQuery

Fields inherited from class com.tinkerpop.blueprints.util.DefaultQuery

Constructor Summary

Method Summary

Methods inherited from class com.tinkerpop.blueprints.util.DefaultGraphQuery

Methods inherited from class java.lang.Object

Field Detail

SPACE

OPERATOR_DIFFERENT

OPERATOR_NOT

OPERATOR_IS_NOT

OPERATOR_LET

OPERATOR_LT

OPERATOR_GTE

OPERATOR_GT

OPERATOR_EQUALS

OPERATOR_IS

OPERATOR_IN

OPERATOR_LIKE

QUERY_FILTER_AND

QUERY_FILTER_OR

QUERY_STRING

QUERY_SEPARATOR

COLLECTION_BEGIN

COLLECTION_END

PARENTHESIS_BEGIN

PARENTHESIS_END

QUERY_LABEL_BEGIN

QUERY_LABEL_END

QUERY_WHERE

QUERY_SELECT_FROM

SKIP

LIMIT

ORDERBY

skip

orderBy

orderByDir

fetchPlan

Constructor Detail

OrientGraphQuery

Method Detail

labels

skip

order

order

vertices

edges

getFetchPlan

setFetchPlan

manageLabels

hasCustomPredicate

manageFilters

generateFilterValue