org.janusgraph.graphdb.query.vertex

Class MultiVertexCentricQueryBuilder

java.lang.Object

org.janusgraph.graphdb.query.vertex.BaseVertexCentricQueryBuilder<Q>

org.janusgraph.graphdb.query.vertex.BasicVertexCentricQueryBuilder<MultiVertexCentricQueryBuilder>

org.janusgraph.graphdb.query.vertex.MultiVertexCentricQueryBuilder

All Implemented Interfaces:

BaseVertexQuery<MultiVertexCentricQueryBuilder>, JanusGraphMultiVertexQuery<MultiVertexCentricQueryBuilder>

public class MultiVertexCentricQueryBuilder
extends BasicVertexCentricQueryBuilder<MultiVertexCentricQueryBuilder>
implements JanusGraphMultiVertexQuery<MultiVertexCentricQueryBuilder>

Implementation of JanusGraphMultiVertexQuery that extends BasicVertexCentricQueryBuilder for all the query building and optimization and adds only the execution logic in execute(org.janusgraph.graphdb.internal.RelationCategory, BasicVertexCentricQueryBuilder.ResultConstructor).

All other methods just prepare or transform that result set to fit the particular method semantics.

Author:

Matthias Broecheler (me@matthiasb.com)

Nested Class Summary

Nested classes/interfaces inherited from class org.janusgraph.graphdb.query.vertex.BasicVertexCentricQueryBuilder

BasicVertexCentricQueryBuilder.CachedRelationConstructor, BasicVertexCentricQueryBuilder.RelationConstructor, BasicVertexCentricQueryBuilder.ResultConstructor<Q>, BasicVertexCentricQueryBuilder.VertexConstructor, BasicVertexCentricQueryBuilder.VertexIdConstructor

Field Summary

Fields inherited from class org.janusgraph.graphdb.query.vertex.BasicVertexCentricQueryBuilder

profiler, tx

Fields inherited from class org.janusgraph.graphdb.query.vertex.BaseVertexCentricQueryBuilder

adjacentVertex, constraints, dir, limit, orders, types

Constructor Summary

Constructors

Constructor and Description
MultiVertexCentricQueryBuilder(StandardJanusGraphTx tx)
MultiVertexCentricQueryBuilder(StandardJanusGraphTx tx, Integer initialVerticesCapacity)

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.
Integer	drop() Drops all vertices that match this query
Map<JanusGraphVertex,Iterable<JanusGraphEdge>>	edges() Returns an iterable over all incident edges that match this query for each vertex
protected <Q> Map<JanusGraphVertex,Q>	execute(RelationCategory returnType, BasicVertexCentricQueryBuilder.ResultConstructor<Q> resultConstructor) Constructs the BaseVertexCentricQuery through BasicVertexCentricQueryBuilder.constructQuery(org.janusgraph.graphdb.internal.RelationCategory).
Map<JanusGraphVertex,Iterable<? extends JanusGraphRelation>>	executeImplicitKeyQuery()
protected MultiVertexCentricQueryBuilder	getThis()
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
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.

Methods inherited from class org.janusgraph.graphdb.query.vertex.BasicVertexCentricQueryBuilder

all, allRequiredRepresentatives, constructQuery, constructQuery, constructQueryWithoutProfile, edges2VertexIds, edges2Vertices, executeImplicitKeyQuery, executeRelations, executeVertexIds, executeVertices, getVertex, hasAllCanonicalTypes, hasQueryOnlyGivenVertex, hasQueryOnlyLoaded, isPartitionedVertex, loadRelationsFromCache, noPartitionRestriction, profiler, queryOnlyGivenVertex, queryOnlyLoaded, system, useSimpleQueryProcessor

Methods inherited from class org.janusgraph.graphdb.query.vertex.BaseVertexCentricQueryBuilder

adjacent, direction, getSingleType, has, has, has, hasNot, hasNot, hasSingleType, hasTypes, interval, isImplicitKeyQuery, keys, labels, limit, orderBy, type, types, types

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.janusgraph.core.JanusGraphMultiVertexQuery

adjacent, direction, has, has, has, hasNot, hasNot, interval, keys, labels, limit, orderBy, types, types

Constructor Detail

MultiVertexCentricQueryBuilder

public MultiVertexCentricQueryBuilder(StandardJanusGraphTx tx)

MultiVertexCentricQueryBuilder

public MultiVertexCentricQueryBuilder(StandardJanusGraphTx tx,
                                      Integer initialVerticesCapacity)

Method Detail

getThis

protected MultiVertexCentricQueryBuilder getThis()

Specified by:

getThis in class BaseVertexCentricQueryBuilder<MultiVertexCentricQueryBuilder>

addVertex

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

Description copied from interface: JanusGraphMultiVertexQuery

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

Specified by:

addVertex in interface JanusGraphMultiVertexQuery<MultiVertexCentricQueryBuilder>

Returns:

this query builder

addAllVertices

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

Description copied from interface: JanusGraphMultiVertexQuery

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

Specified by:

addAllVertices in interface JanusGraphMultiVertexQuery<MultiVertexCentricQueryBuilder>

Returns:

this query builder

execute

protected <Q> Map<JanusGraphVertex,Q> execute(RelationCategory returnType,
                                              BasicVertexCentricQueryBuilder.ResultConstructor<Q> resultConstructor)

Constructs the BaseVertexCentricQuery through BasicVertexCentricQueryBuilder.constructQuery(org.janusgraph.graphdb.internal.RelationCategory). If the query asks for an implicit key, the resulting map is computed and returned directly. If the query is empty, a map that maps each vertex to an empty list is returned. Otherwise, the query is executed for all vertices through the transaction which will effectively pre-load the return result sets into the associated CacheVertex or don't do anything at all if the vertex is new (and hence no edges in the storage backend). After that, a map is constructed that maps each vertex to the corresponding VertexCentricQuery and wrapped into a QueryProcessor. Hence, upon iteration the query will be executed like any other VertexCentricQuery with the performance difference that the SliceQueries will have already been preloaded and not further calls to the storage backend are needed.

Parameters:

returnType -

Returns:

executeImplicitKeyQuery

public Map<JanusGraphVertex,Iterable<? extends JanusGraphRelation>> executeImplicitKeyQuery()

edges

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

Description copied from interface: JanusGraphMultiVertexQuery

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

Specified by:

edges in interface JanusGraphMultiVertexQuery<MultiVertexCentricQueryBuilder>

Returns:

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

properties

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

Description copied from interface: JanusGraphMultiVertexQuery

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

Specified by:

properties in interface JanusGraphMultiVertexQuery<MultiVertexCentricQueryBuilder>

Returns:

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

preFetch

public void preFetch()

Description copied from interface: JanusGraphMultiVertexQuery

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

Specified by:

preFetch in interface JanusGraphMultiVertexQuery<MultiVertexCentricQueryBuilder>

relations

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

Description copied from interface: JanusGraphMultiVertexQuery

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

Specified by:

relations in interface JanusGraphMultiVertexQuery<MultiVertexCentricQueryBuilder>

Returns:

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

vertices

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

Description copied from interface: JanusGraphMultiVertexQuery

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

Specified by:

vertices in interface JanusGraphMultiVertexQuery<MultiVertexCentricQueryBuilder>

Returns:

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

vertexIds

public Map<JanusGraphVertex,VertexList> vertexIds()

Description copied from interface: JanusGraphMultiVertexQuery

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.

Specified by:

vertexIds in interface JanusGraphMultiVertexQuery<MultiVertexCentricQueryBuilder>

Returns:

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

drop

public Integer drop()

Description copied from interface: JanusGraphMultiVertexQuery

Drops all vertices that match this query

Specified by:

drop in interface JanusGraphMultiVertexQuery<MultiVertexCentricQueryBuilder>

Returns:

Count of dropped vertices