org.janusgraph.core

Interface JanusGraphQuery<Q extends JanusGraphQuery<Q>>

All Known Implementing Classes:

GraphCentricQueryBuilder

public interface JanusGraphQuery<Q extends JanusGraphQuery<Q>>

Constructs a query against a mixed index to retrieve all elements (either vertices or edges) that match all conditions.

Finding matching elements efficiently using this query mechanism requires that appropriate index structures have been defined for the keys. See JanusGraphManagement for more information on how to define index structures in JanusGraph.

Since:

0.3.0

Author:

Matthias Broecheler ([email protected])

Method Summary

Modifier and Type	Method and Description
Iterable<JanusGraphEdge>	edges() Returns all edges that match the conditions.
Q	has(String key)
Q	has(String key, JanusGraphPredicate predicate, Object condition) The returned element must have a property for the given key that matches the condition according to the specified relation
Q	has(String key, Object value)
Q	hasNot(String key)
Q	hasNot(String key, Object value)
<T extends Comparable<?>> Q	interval(String key, T startValue, T endValue)
Q	limit(int max) Limits the size of the returned result set
Q	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).
Iterable<JanusGraphVertexProperty>	properties() Returns all properties that match the conditions
Iterable<JanusGraphVertex>	vertices() Returns all vertices that match the conditions.

Method Detail

has

Q has(String key,
      JanusGraphPredicate predicate,
      Object condition)

The returned element must have a property for the given key that matches the condition according to the specified relation

Parameters:

key - Key that identifies the property

predicate - Relation between property and condition

condition -

Returns:

This query

has

Q has(String key)

hasNot

Q hasNot(String key)

has

Q has(String key,
      Object value)

hasNot

Q hasNot(String key,
         Object value)

interval

<T extends Comparable<?>> Q interval(String key,
                                     T startValue,
                                     T endValue)

limit

Q limit(int max)

Limits the size of the returned result set

Parameters:

max - The maximum number of results to return

Returns:

This query

orderBy

Q 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).

Parameters:

key - The key of the properties on which to order

order - the ordering direction

Returns:

vertices

Iterable<JanusGraphVertex> vertices()

Returns all vertices that match the conditions.

Returns:

edges

Iterable<JanusGraphEdge> edges()

Returns all edges that match the conditions.

Returns:

properties

Iterable<JanusGraphVertexProperty> properties()

Returns all properties that match the conditions

Returns: