org.janusgraph.core

Interface JanusGraphMultiVertexQuery<Q extends JanusGraphMultiVertexQuery<Q>>

All Superinterfaces:

BaseVertexQuery<Q>

All Known Implementing Classes:

MultiVertexCentricQueryBuilder

public interface JanusGraphMultiVertexQuery<Q extends JanusGraphMultiVertexQuery<Q>>
extends BaseVertexQuery<Q>

A MultiVertexQuery is identical to a JanusGraphVertexQuery but executed against a set of vertices simultaneously. In other words, JanusGraphMultiVertexQuery allows identical JanusGraphVertexQuery executed against a non-trivial set of vertices to be executed in one batch which can significantly reduce the query latency.

The query specification methods are identical to JanusGraphVertexQuery. The result set method return Maps from the specified set of anchor vertices to their respective individual result sets.

Call Transaction.multiQuery(java.util.Collection) to construct a multi query in the enclosing transaction.

Note, that the limit(int) constraint applies to each individual result set.

Author:

Matthias Broecheler ([email protected])

See Also:

JanusGraphVertexQuery

Method Summary

Modifier and Type	Method and Description
JanusGraphMultiVertexQuery	addAllVertices(Collection<? extends org.apache.tinkerpop.gremlin.structure.Vertex> vertices) Adds the given collection of vertices to the set of vertices against which to execute this query.
JanusGraphMultiVertexQuery	addVertex(org.apache.tinkerpop.gremlin.structure.Vertex vertex) Adds the given vertex to the set of vertices against which to execute this query.
Q	adjacent(org.apache.tinkerpop.gremlin.structure.Vertex vertex) Restricts this query to only those edges that point to the given vertex.
Q	direction(org.apache.tinkerpop.gremlin.structure.Direction d) Query only for relations in the given direction.
Map<JanusGraphVertex,Iterable<JanusGraphEdge>>	edges() Returns an iterable over all incident edges that match this query for each vertex
Q	has(String key) Query for edges or properties that have defined property with the given key
Q	has(String key, JanusGraphPredicate predicate, Object value)
Q	has(String type, Object value) Query only for edges or properties that have an incident property or unidirected edge matching the given value.
Q	hasNot(String key) Query for edges or properties that DO NOT have a defined property with the given key
Q	hasNot(String key, Object value) Identical to BaseVertexQuery.has(String, Object) but negates the condition, i.e.
<T extends Comparable<?>> Q	interval(String key, T start, T end) Query for those edges or properties that have a property for the given key whose values lies in the interval by [start,end).
Q	keys(String... keys) Query for only those properties having one of the given property keys.
Q	labels(String... labels) Query for only those edges matching one of the given edge labels.
Q	limit(int limit) Sets the retrieval limit for this query.
Q	orderBy(String key, org.apache.tinkerpop.gremlin.process.traversal.Order order) Orders the relation results of this query according to their property for the given key in the given order (increasing/decreasing).
void	preFetch() Makes a call to properties to pre-fetch the properties into the vertex cache
Map<JanusGraphVertex,Iterable<JanusGraphVertexProperty>>	properties() Returns an iterable over all incident properties that match this query for each vertex
Map<JanusGraphVertex,Iterable<JanusGraphRelation>>	relations() Returns an iterable over all incident relations that match this query for each vertex
Q	types(RelationType... type) Query for only those relations matching one of the given relation types.
Q	types(String... type) Query for only those relations matching one of the given relation types.
Map<JanusGraphVertex,VertexList>	vertexIds() Retrieves all vertices connected to each of the query's central vertices by edges matching the conditions defined in this query.
Map<JanusGraphVertex,Iterable<JanusGraphVertex>>	vertices() Retrieves all vertices connected to each of the query's base vertices by edges matching the conditions defined in this query.

Method Detail

addVertex

JanusGraphMultiVertexQuery addVertex(org.apache.tinkerpop.gremlin.structure.Vertex vertex)

Adds the given vertex to the set of vertices against which to execute this query.

Parameters:

vertex -

Returns:

this query builder

addAllVertices

JanusGraphMultiVertexQuery addAllVertices(Collection<? extends org.apache.tinkerpop.gremlin.structure.Vertex> vertices)

Adds the given collection of vertices to the set of vertices against which to execute this query.

Parameters:

vertices -

Returns:

this query builder

adjacent

Q adjacent(org.apache.tinkerpop.gremlin.structure.Vertex vertex)

Description copied from interface: BaseVertexQuery

Restricts this query to only those edges that point to the given vertex.

Specified by:

adjacent in interface BaseVertexQuery<Q extends JanusGraphMultiVertexQuery<Q>>

Returns:

this query builder

types

Q types(String... type)

Description copied from interface: BaseVertexQuery

Query for only those relations matching one of the given relation types. By default, a query includes all relations in the result set.

Specified by:

types in interface BaseVertexQuery<Q extends JanusGraphMultiVertexQuery<Q>>

Parameters:

type - relation types to query for

Returns:

this query

types

Q types(RelationType... type)

Description copied from interface: BaseVertexQuery

Query for only those relations matching one of the given relation types. By default, a query includes all relations in the result set.

Specified by:

types in interface BaseVertexQuery<Q extends JanusGraphMultiVertexQuery<Q>>

Parameters:

type - relation types to query for

Returns:

this query

labels

Q labels(String... labels)

Description copied from interface: BaseVertexQuery

Query for only those edges matching one of the given edge labels. By default, an edge query includes all edges in the result set.

Specified by:

labels in interface BaseVertexQuery<Q extends JanusGraphMultiVertexQuery<Q>>

Parameters:

labels - edge labels to query for

Returns:

this query

keys

Q keys(String... keys)

Description copied from interface: BaseVertexQuery

Query for only those properties having one of the given property keys. By default, a query includes all properties in the result set.

Specified by:

keys in interface BaseVertexQuery<Q extends JanusGraphMultiVertexQuery<Q>>

Parameters:

keys - property keys to query for

Returns:

this query

direction

Q direction(org.apache.tinkerpop.gremlin.structure.Direction d)

Description copied from interface: BaseVertexQuery

Query only for relations in the given direction. By default, both directions are queried.

Specified by:

direction in interface BaseVertexQuery<Q extends JanusGraphMultiVertexQuery<Q>>

Parameters:

d - Direction to query for

Returns:

this query

has

Q has(String type,
      Object value)

Description copied from interface: BaseVertexQuery

Query only for edges or properties that have an incident property or unidirected edge matching the given value.

If type is a property key, then the query is restricted to edges or properties having an incident property matching this key-value pair. If type is an edge label, then it is expected that this label is unidirected (EdgeLabel.isUnidirected() and the query is restricted to edges or properties having an incident unidirectional edge pointing to the value which is expected to be a JanusGraphVertex.

Specified by:

has in interface BaseVertexQuery<Q extends JanusGraphMultiVertexQuery<Q>>

Parameters:

type - JanusGraphType name

value - Value for the property of the given key to match, or vertex to point unidirectional edge to

Returns:

this query

has

Q has(String key)

Description copied from interface: BaseVertexQuery

Query for edges or properties that have defined property with the given key

Specified by:

has in interface BaseVertexQuery<Q extends JanusGraphMultiVertexQuery<Q>>

Returns:

this query

hasNot

Q hasNot(String key)

Description copied from interface: BaseVertexQuery

Query for edges or properties that DO NOT have a defined property with the given key

Specified by:

hasNot in interface BaseVertexQuery<Q extends JanusGraphMultiVertexQuery<Q>>

Returns:

this query

hasNot

Q hasNot(String key,
         Object value)

Description copied from interface: BaseVertexQuery

Identical to BaseVertexQuery.has(String, Object) but negates the condition, i.e. matches those edges or properties that DO NOT satisfy this property condition.

Specified by:

hasNot in interface BaseVertexQuery<Q extends JanusGraphMultiVertexQuery<Q>>

Returns:

has

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

Specified by:

has in interface BaseVertexQuery<Q extends JanusGraphMultiVertexQuery<Q>>

interval

<T extends Comparable<?>> Q interval(String key,
                                     T start,
                                     T end)

Description copied from interface: BaseVertexQuery

Query for those edges or properties that have a property for the given key whose values lies in the interval by [start,end).

Specified by:

interval in interface BaseVertexQuery<Q extends JanusGraphMultiVertexQuery<Q>>

Parameters:

key - property key

start - value defining the start of the interval (inclusive)

end - value defining the end of the interval (exclusive)

Returns:

this query

limit

Q limit(int limit)

Description copied from interface: BaseVertexQuery

Sets the retrieval limit for this query.

When setting a limit, executing this query will only retrieve the specified number of relations. Note, that this also applies to counts.

Specified by:

limit in interface BaseVertexQuery<Q extends JanusGraphMultiVertexQuery<Q>>

Parameters:

limit - maximum number of relations to retrieve for this query

Returns:

this query

orderBy

Q orderBy(String key,
          org.apache.tinkerpop.gremlin.process.traversal.Order order)

Description copied from interface: BaseVertexQuery

Orders the relation results of this query according to their property for the given key in the given order (increasing/decreasing).

Note, that the ordering always applies to the incident relations (edges/properties) and NOT to the adjacent vertices even if only vertices are being returned.

Specified by:

orderBy in interface BaseVertexQuery<Q extends JanusGraphMultiVertexQuery<Q>>

Parameters:

key - The key of the properties on which to order

order - the ordering direction

Returns:

edges

Map<JanusGraphVertex,Iterable<JanusGraphEdge>> edges()

Returns an iterable over all incident edges that match this query for each vertex

Returns:

Iterable over all incident edges that match this query for each vertex

properties

Map<JanusGraphVertex,Iterable<JanusGraphVertexProperty>> properties()

Returns an iterable over all incident properties that match this query for each vertex

Returns:

Iterable over all incident properties that match this query for each vertex

preFetch

void preFetch()

Makes a call to properties to pre-fetch the properties into the vertex cache

relations

Map<JanusGraphVertex,Iterable<JanusGraphRelation>> relations()

Returns an iterable over all incident relations that match this query for each vertex

Returns:

Iterable over all incident relations that match this query for each vertex

vertices

Map<JanusGraphVertex,Iterable<JanusGraphVertex>> vertices()

Retrieves all vertices connected to each of the query's base vertices by edges matching the conditions defined in this query.

Returns:

An iterable of all vertices connected to each of the query's central vertices by matching edges

vertexIds

Map<JanusGraphVertex,VertexList> vertexIds()

Retrieves all vertices connected to each of the query's central vertices by edges matching the conditions defined in this query.

The query engine will determine the most efficient way to retrieve the vertices that match this query.

Returns:

A list of all vertices' ids connected to each of the query's central vertex by matching edges