org.janusgraph.graphdb.query.vertex

Class BasicVertexCentricQueryBuilder<Q extends BaseVertexQuery<Q>>

java.lang.Object

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

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

All Implemented Interfaces:

BaseVertexQuery<Q>

Direct Known Subclasses:

MultiVertexCentricQueryBuilder, QueryContainer.QueryBuilder, VertexCentricQueryBuilder

public abstract class BasicVertexCentricQueryBuilder<Q extends BaseVertexQuery<Q>>
extends BaseVertexCentricQueryBuilder<Q>

Builds a BaseVertexQuery, optimizes the query and compiles the result into a BaseVertexCentricQuery which is then executed by one of the extending classes.

Author:

Matthias Broecheler ([email protected])

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	BasicVertexCentricQueryBuilder.RelationConstructor
protected static interface	BasicVertexCentricQueryBuilder.ResultConstructor<Q>
protected class	BasicVertexCentricQueryBuilder.VertexConstructor
protected class	BasicVertexCentricQueryBuilder.VertexIdConstructor

Field Summary

Fields

Modifier and Type	Field and Description
protected QueryProfiler	profiler The query profiler used to observe this query
protected StandardJanusGraphTx	tx Transaction in which this query is executed

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

adjacentVertex, constraints, dir, limit, orders, types

Constructor Summary

Constructors

Constructor and Description
BasicVertexCentricQueryBuilder(StandardJanusGraphTx tx)

Method Summary

Modifier and Type	Method and Description
protected List<InternalVertex>	allRequiredRepresentatives(InternalVertex partitionedVertex)
protected VertexCentricQuery	constructQuery(InternalVertex vertex, BaseVertexCentricQuery baseQuery) Constructs a VertexCentricQuery for this query builder.
protected BaseVertexCentricQuery	constructQuery(RelationCategory returnType)
protected BaseVertexCentricQuery	constructQueryWithoutProfile(RelationCategory returnType)
protected VertexList	edges2VertexIds(Iterable<JanusGraphEdge> edges, JanusGraphVertex other)
protected static Iterable<JanusGraphVertex>	edges2Vertices(Iterable<JanusGraphEdge> edges, JanusGraphVertex other)
protected Iterable<JanusGraphRelation>	executeImplicitKeyQuery(InternalVertex v) If BaseVertexCentricQueryBuilder.isImplicitKeyQuery(org.janusgraph.graphdb.internal.RelationCategory) is true, this method provides the result set for the query based on the evaluation of the ImplicitKey.
protected Iterable<JanusGraphRelation>	executeRelations(InternalVertex vertex, BaseVertexCentricQuery baseQuery)
VertexList	executeVertexIds(InternalVertex vertex, BaseVertexCentricQuery baseQuery)
Iterable<JanusGraphVertex>	executeVertices(InternalVertex vertex, BaseVertexCentricQuery baseQuery)
JanusGraphVertex	getVertex(long vertexId)
protected boolean	hasAllCanonicalTypes()
boolean	hasQueryOnlyGivenVertex()
boolean	hasQueryOnlyLoaded()
protected boolean	isPartitionedVertex(InternalVertex vertex)
Q	noPartitionRestriction() Removes any query partition restriction for this query
Q	profiler(QueryProfiler profiler) Sets the query profiler to observe this query.
Q	queryOnlyGivenVertex()
Q	queryOnlyLoaded() Calling this method will cause this query to only included loaded (i.e.
Q	system() Restricts the result set of this query to only system types.
protected boolean	useSimpleQueryProcessor(BaseVertexCentricQuery query, InternalVertex... vertices)

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

adjacent, direction, getSingleType, getThis, 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

Field Detail

tx

protected final StandardJanusGraphTx tx

Transaction in which this query is executed

profiler

protected QueryProfiler profiler

The query profiler used to observe this query

Constructor Detail

BasicVertexCentricQueryBuilder

public BasicVertexCentricQueryBuilder(StandardJanusGraphTx tx)

Method Detail

getVertex

public JanusGraphVertex getVertex(long vertexId)

Specified by:

getVertex in class BaseVertexCentricQueryBuilder<Q extends BaseVertexQuery<Q>>

noPartitionRestriction

public Q noPartitionRestriction()

Removes any query partition restriction for this query

Returns:

profiler

public Q profiler(QueryProfiler profiler)

Sets the query profiler to observe this query. Must be set before the query is executed to take effect.

Parameters:

profiler -

Returns:

system

public Q system()

Restricts the result set of this query to only system types.

Returns:

queryOnlyLoaded

public Q queryOnlyLoaded()

Calling this method will cause this query to only included loaded (i.e. unmodified) relations in the result set.

Returns:

queryOnlyGivenVertex

public Q queryOnlyGivenVertex()

hasAllCanonicalTypes

protected boolean hasAllCanonicalTypes()

hasQueryOnlyGivenVertex

public boolean hasQueryOnlyGivenVertex()

hasQueryOnlyLoaded

public boolean hasQueryOnlyLoaded()

edges2Vertices

protected static Iterable<JanusGraphVertex> edges2Vertices(Iterable<JanusGraphEdge> edges,
                                                           JanusGraphVertex other)

edges2VertexIds

protected VertexList edges2VertexIds(Iterable<JanusGraphEdge> edges,
                                     JanusGraphVertex other)

executeImplicitKeyQuery

protected Iterable<JanusGraphRelation> executeImplicitKeyQuery(InternalVertex v)

If BaseVertexCentricQueryBuilder.isImplicitKeyQuery(org.janusgraph.graphdb.internal.RelationCategory) is true, this method provides the result set for the query based on the evaluation of the ImplicitKey.

Handling of implicit keys is completely distinct from "normal" query execution and handled extra for completeness reasons.

Parameters:

v -

Returns:

allRequiredRepresentatives

protected List<InternalVertex> allRequiredRepresentatives(InternalVertex partitionedVertex)

isPartitionedVertex

protected final boolean isPartitionedVertex(InternalVertex vertex)

useSimpleQueryProcessor

protected boolean useSimpleQueryProcessor(BaseVertexCentricQuery query,
                                          InternalVertex... vertices)

executeRelations

protected Iterable<JanusGraphRelation> executeRelations(InternalVertex vertex,
                                                        BaseVertexCentricQuery baseQuery)

executeVertices

public Iterable<JanusGraphVertex> executeVertices(InternalVertex vertex,
                                                  BaseVertexCentricQuery baseQuery)

executeVertexIds

public VertexList executeVertexIds(InternalVertex vertex,
                                   BaseVertexCentricQuery baseQuery)

constructQuery

protected VertexCentricQuery constructQuery(InternalVertex vertex,
                                            BaseVertexCentricQuery baseQuery)

Constructs a VertexCentricQuery for this query builder. The query construction and optimization logic is taken from constructQuery(org.janusgraph.graphdb.internal.RelationCategory) This method only adds the additional conditions that are based on the base vertex.

Parameters:

vertex - for which to construct this query

baseQuery - as constructed by constructQuery(org.janusgraph.graphdb.internal.RelationCategory)

Returns:

constructQuery

protected BaseVertexCentricQuery constructQuery(RelationCategory returnType)

constructQueryWithoutProfile

protected BaseVertexCentricQuery constructQueryWithoutProfile(RelationCategory returnType)