IndexQueryBuilder (JanusGraph-Core: Core Library for JanusGraph 1.0.0 API)

java.lang.Object
- org.janusgraph.graphdb.query.BaseQuery
- - org.janusgraph.graphdb.query.graph.IndexQueryBuilder

All Implemented Interfaces:

JanusGraphIndexQuery, Query
```
public class IndexQueryBuilder
extends BaseQuery
implements JanusGraphIndexQuery
```
Implementation of JanusGraphIndexQuery for string based queries that are issued directly against the specified indexing backend. It is assumed that the given string conforms to the query language of the indexing backend. This class does not understand or verify the provided query. However, it will introspect the query and replace any reference to `v.SOME_KEY`, `e.SOME_KEY` or `p.SOME_KEY` with the respective key reference. This replacement is 'dumb' in the sense that it relies on simple string replacements to accomplish this. If the key contains special characters (in particular space) then it must be encapsulated in quotation marks.
In addition to the query string, a number of parameters can be specified which will be passed verbatim to the indexing backend during query execution.
This class essentially just acts as a builder, uses the IndexSerializer to execute the query, and then post-processes the result set to return to the user.

Author:

Matthias Broecheler (me@matthiasb.com)

Nested Class Summary
- Nested classes/interfaces inherited from interface org.janusgraph.core.JanusGraphIndexQuery
  JanusGraphIndexQuery.Result<V extends org.apache.tinkerpop.gremlin.structure.Element>

Field Summary
- Fields inherited from interface org.janusgraph.graphdb.query.Query
  NO_LIMIT

Constructor Summary

Constructors
Constructor and Description

IndexQueryBuilder(StandardJanusGraphTx tx, IndexSerializer serializer)

Constructors
Constructor and Description
`IndexQueryBuilder(StandardJanusGraphTx tx, IndexSerializer serializer)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IndexQueryBuilder`	`addParameter(Parameter para)` Adds the given parameter to the list of parameters of this query.
`IndexQueryBuilder`	`addParameters(Iterable<Parameter> paras)` Adds the given parameters to the list of parameters of this query.
`IndexQueryBuilder`	`addParameters(Parameter... paras)` Adds the given parameters to the list of parameters of this query.
`Stream<JanusGraphIndexQuery.Result<JanusGraphEdge>>`	`edgeStream()` Returns all edges that match the query in the indexing backend.
`Long`	`edgeTotals()` Returns total edges that match the query in the indexing backend ignoring limit and offset.
`String`	`getIndex()`
`int`	`getOffset()`
`List<Parameter<org.apache.tinkerpop.gremlin.process.traversal.Order>>`	`getOrders()`
`Parameter[]`	`getParameters()`
`String`	`getPrefix()`
`String`	`getQuery()`
`String`	`getUnknownKeyName()`
`IndexQueryBuilder`	`limit(int limit)` Specifies the maximum number of elements to return
`IndexQueryBuilder`	`offset(int offset)` Specifies the offset of the query.
`JanusGraphIndexQuery`	`orderBy(String key, org.apache.tinkerpop.gremlin.process.traversal.Order order)` Orders the element results of this query according to their property for the given key in the given order (increasing/decreasing).
`Stream<JanusGraphIndexQuery.Result<JanusGraphVertexProperty>>`	`propertyStream()` Returns all properties that match the query in the indexing backend.
`Long`	`propertyTotals()` Returns total properties that match the query in the indexing backend ignoring limit and offset.
`IndexQueryBuilder`	`setElementIdentifier(String identifier)` Sets the element identifier string that is used by this query builder as the token to identifier key references in the query string.
`IndexQueryBuilder`	`setIndex(String indexName)`
`IndexQueryBuilder`	`setQuery(String query)`
`Stream<JanusGraphIndexQuery.Result<JanusGraphVertex>>`	`vertexStream()` Returns all vertices that match the query in the indexing backend.
`Long`	`vertexTotals()` Returns total vertices that match the query in the indexing backend ignoring limit and offset.

Methods inherited from class org.janusgraph.graphdb.query.BaseQuery
getLimit, hasLimit, setLimit

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

- Constructor Detail
  - IndexQueryBuilder
```
public IndexQueryBuilder(StandardJanusGraphTx tx,
                         IndexSerializer serializer)
```
- Method Detail
  - getIndex
```
public String getIndex()
```
  - getParameters
```
public Parameter[] getParameters()
```
  - getQuery
```
public String getQuery()
```
  - getOrders
```
public List<Parameter<org.apache.tinkerpop.gremlin.process.traversal.Order>> getOrders()
```
  - getOffset
```
public int getOffset()
```
  - getPrefix
```
public String getPrefix()
```
  - setElementIdentifier
```
public IndexQueryBuilder setElementIdentifier(String identifier)
```
    Description copied from interface: JanusGraphIndexQuery
    
    Sets the element identifier string that is used by this query builder as the token to identifier key references in the query string.
    For example, in the query 'v.name: Tom' the element identifier is 'v.'
    
    Specified by:
    
    setElementIdentifier in interface JanusGraphIndexQuery
    
    Parameters:
    
    identifier - The element identifier which must not be blank
    
    Returns:
    
    This query builder
  - getUnknownKeyName
```
public String getUnknownKeyName()
```
  - setIndex
```
public IndexQueryBuilder setIndex(String indexName)
```
  - setQuery
```
public IndexQueryBuilder setQuery(String query)
```
  - offset
```
public IndexQueryBuilder offset(int offset)
```
    Description copied from interface: JanusGraphIndexQuery
    
    Specifies the offset of the query. Query results will be retrieved starting at the given offset.
    
    Specified by:
    
    offset in interface JanusGraphIndexQuery
    
    Returns:
  - orderBy
```
public JanusGraphIndexQuery orderBy(String key,
                                    org.apache.tinkerpop.gremlin.process.traversal.Order order)
```
    Description copied from interface: JanusGraphIndexQuery
    
    Orders the element results of this query according to their property for the given key in the given order (increasing/decreasing).
    
    Specified by:
    
    orderBy in interface JanusGraphIndexQuery
    
    Parameters:
    
    key - The key of the properties on which to order
    
    order - the ordering direction
    
    Returns:
  - limit
```
public IndexQueryBuilder limit(int limit)
```
    Description copied from interface: JanusGraphIndexQuery
    
    Specifies the maximum number of elements to return
    
    Specified by:
    
    limit in interface JanusGraphIndexQuery
    
    Returns:
  - addParameter
```
public IndexQueryBuilder addParameter(Parameter para)
```
    Description copied from interface: JanusGraphIndexQuery
    
    Adds the given parameter to the list of parameters of this query. Parameters are passed right through to the indexing backend to modify the query behavior.
    
    Specified by:
    
    addParameter in interface JanusGraphIndexQuery
    
    Returns:
  - addParameters
```
public IndexQueryBuilder addParameters(Iterable<Parameter> paras)
```
    Description copied from interface: JanusGraphIndexQuery
    
    Adds the given parameters to the list of parameters of this query. Parameters are passed right through to the indexing backend to modify the query behavior.
    
    Specified by:
    
    addParameters in interface JanusGraphIndexQuery
    
    Returns:
  - addParameters
```
public IndexQueryBuilder addParameters(Parameter... paras)
```
    Description copied from interface: JanusGraphIndexQuery
    
    Adds the given parameters to the list of parameters of this query. Parameters are passed right through to the indexing backend to modify the query behavior.
    
    Specified by:
    
    addParameters in interface JanusGraphIndexQuery
    
    Returns:
  - vertexStream
```
public Stream<JanusGraphIndexQuery.Result<JanusGraphVertex>> vertexStream()
```
    Description copied from interface: JanusGraphIndexQuery
    
    Returns all vertices that match the query in the indexing backend.
    
    Specified by:
    
    vertexStream in interface JanusGraphIndexQuery
    
    Returns:
  - edgeStream
```
public Stream<JanusGraphIndexQuery.Result<JanusGraphEdge>> edgeStream()
```
    Description copied from interface: JanusGraphIndexQuery
    
    Returns all edges that match the query in the indexing backend.
    
    Specified by:
    
    edgeStream in interface JanusGraphIndexQuery
    
    Returns:
  - propertyStream
```
public Stream<JanusGraphIndexQuery.Result<JanusGraphVertexProperty>> propertyStream()
```
    Description copied from interface: JanusGraphIndexQuery
    
    Returns all properties that match the query in the indexing backend.
    
    Specified by:
    
    propertyStream in interface JanusGraphIndexQuery
    
    Returns:
  - vertexTotals
```
public Long vertexTotals()
```
    Description copied from interface: JanusGraphIndexQuery
    
    Returns total vertices that match the query in the indexing backend ignoring limit and offset.
    
    Specified by:
    
    vertexTotals in interface JanusGraphIndexQuery
    
    Returns:
  - edgeTotals
```
public Long edgeTotals()
```
    Description copied from interface: JanusGraphIndexQuery
    
    Returns total edges that match the query in the indexing backend ignoring limit and offset.
    
    Specified by:
    
    edgeTotals in interface JanusGraphIndexQuery
    
    Returns:
  - propertyTotals
```
public Long propertyTotals()
```
    Description copied from interface: JanusGraphIndexQuery
    
    Returns total properties that match the query in the indexing backend ignoring limit and offset.
    
    Specified by:
    
    propertyTotals in interface JanusGraphIndexQuery
    
    Returns:

Class IndexQueryBuilder

Nested Class Summary

Nested classes/interfaces inherited from interface org.janusgraph.core.JanusGraphIndexQuery

Field Summary

Fields inherited from interface org.janusgraph.graphdb.query.Query

Constructor Summary

Method Summary

Methods inherited from class org.janusgraph.graphdb.query.BaseQuery

Methods inherited from class java.lang.Object

Constructor Detail

IndexQueryBuilder

Method Detail

getIndex

getParameters

getQuery

getOrders

getOffset

getPrefix

setElementIdentifier

getUnknownKeyName

setIndex

setQuery

offset

orderBy

limit

addParameter

addParameters

addParameters

vertexStream

edgeStream

propertyStream

vertexTotals

edgeTotals

propertyTotals