com.thinkaurelius.titan.graphdb.query.vertex

Class AbstractVertexCentricQueryBuilder<Q extends BaseVertexQuery<Q>>

java.lang.Object

com.thinkaurelius.titan.graphdb.query.vertex.AbstractVertexCentricQueryBuilder<Q>

All Implemented Interfaces:

BaseVertexQuery<Q>

Direct Known Subclasses:

MultiVertexCentricQueryBuilder, VertexCentricQueryBuilder

public abstract class AbstractVertexCentricQueryBuilder<Q extends BaseVertexQuery<Q>>
extends Object
implements BaseVertexQuery<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 (me@matthiasb.com)

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected StandardTitanTx	tx Transaction in which this query is executed

Constructor Summary

Constructors

Constructor and Description
AbstractVertexCentricQueryBuilder(StandardTitanTx tx)

Method Summary

Methods

Modifier and Type	Method and Description
Q	adjacent(TitanVertex vertex) Restricts this query to only those edges that point to the given vertex.
protected List<InternalVertex>	allRepresentatives(InternalVertex partitionedVertex)
protected VertexCentricQuery	constructQuery(InternalVertex vertex, BaseVertexCentricQuery baseQuery) Constructs a VertexCentricQuery for this query builder.
protected BaseVertexCentricQuery	constructQuery(RelationCategory returnType)
protected QueryDescription	describe(int numVertices, RelationCategory returnType)
QueryDescription	describeForEdges() Returns a description of this query for edges as a QueryDescription object.
QueryDescription	describeForProperties() Returns a description of this query for properties as a QueryDescription object.
QueryDescription	describeForRelations()
Q	direction(com.tinkerpop.blueprints.Direction d) Query only for relations in the given direction.
protected VertexList	edges2VertexIds(Iterable<TitanEdge> edges, TitanVertex other)
protected static Iterable<TitanVertex>	edges2Vertices(Iterable<TitanEdge> edges, TitanVertex other)
protected Iterable<TitanRelation>	executeImplicitKeyQuery(InternalVertex v) If isImplicitKeyQuery(com.thinkaurelius.titan.graphdb.internal.RelationCategory) is true, this method provides the result set for the query based on the evaluation of the ImplicitKey.
protected Iterable<TitanRelation>	executeRelations(InternalVertex vertex, BaseVertexCentricQuery baseQuery)
VertexList	executeVertexIds(InternalVertex vertex, BaseVertexCentricQuery baseQuery)
Iterable<TitanVertex>	executeVertices(InternalVertex vertex, BaseVertexCentricQuery baseQuery)
protected RelationType	getSingleType()
protected abstract Q	getThis()
Q	has(EdgeLabel label, TitanVertex vertex) Query only for edges or properties that have a unidirected edge pointing to the given vertex 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 given vertex.
Q	has(PropertyKey key, Object value) Query only for edges or properties that have an incident property matching the given value.
Q	has(PropertyKey key, com.tinkerpop.blueprints.Predicate predicate, Object value) Query only for those edges or properties which have a property for the given key that satisfies the specified predicate relationship to the provided value.
Q	has(String key) Query for edges or properties that have defined property with the given key
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	has(String key, com.tinkerpop.blueprints.Predicate predicate, Object value) Query only for those edges or properties which have a property for the given key that satisfies the specified predicate relationship to the provided value.
<T extends Comparable<T>> Q	has(String key, T value, com.tinkerpop.blueprints.Query.Compare compare) Deprecated.
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.
protected boolean	hasSingleType()
protected boolean	hasTypes()
<T extends Comparable<?>> Q	interval(PropertyKey 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).
<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).
protected boolean	isImplicitKeyQuery(RelationCategory returnType) Whether this query is asking for the value of an ImplicitKey.
protected boolean	isPartitionedVertex(InternalVertex vertex)
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	noPartitionRestriction() Removes any query partition restriction for this query
Q	orderBy(PropertyKey key, Order order) Orders the relation results of this query according to their property for the given key in the given order (increasing/decreasing).
Q	orderBy(String key, Order order) Orders the relation results of this query according to their property for the given key in the given order (increasing/decreasing).
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.
Q	type(RelationType type)
Q	types(RelationType... types) Query for only those relations matching one of the given relation types.
protected boolean	useSimpleQueryProcessor(BaseVertexCentricQuery query, InternalVertex... vertices)

Methods inherited from class java.lang.Object

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

Field Detail

tx

protected final StandardTitanTx tx

Transaction in which this query is executed

Constructor Detail

AbstractVertexCentricQueryBuilder

public AbstractVertexCentricQueryBuilder(StandardTitanTx tx)

Method Detail

getThis

protected abstract Q getThis()

noPartitionRestriction

public Q noPartitionRestriction()

Removes any query partition restriction for this query

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:

adjacent

public Q adjacent(TitanVertex 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 BaseVertexQuery<Q>>

Returns:

this query builder

has

public Q has(PropertyKey key,
    Object value)

Description copied from interface: BaseVertexQuery

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

Specified by:

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

Parameters:

key - key

value - Value for the property of the given key to match

Returns:

this query

has

public Q has(EdgeLabel label,
    TitanVertex vertex)

Description copied from interface: BaseVertexQuery

Query only for edges or properties that have a unidirected edge pointing to the given vertex

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 given vertex.

Specified by:

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

Parameters:

label - Label

vertex - Vertex to point unidirectional edge to

Returns:

this query

has

public 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 TitanVertex.

Specified by:

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

Parameters:

type - TitanType name

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

Returns:

this query

hasNot

public 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 BaseVertexQuery<Q>>

Returns:

has

public Q has(String key,
    com.tinkerpop.blueprints.Predicate predicate,
    Object value)

Description copied from interface: BaseVertexQuery

Query only for those edges or properties which have a property for the given key that satisfies the specified predicate relationship to the provided value.

Specified by:

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

Parameters:

key - property key

predicate - boolean relationship to satisfy with the given value

value - value

Returns:

has

public Q has(PropertyKey key,
    com.tinkerpop.blueprints.Predicate predicate,
    Object value)

Description copied from interface: BaseVertexQuery

Query only for those edges or properties which have a property for the given key that satisfies the specified predicate relationship to the provided value.

Specified by:

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

Parameters:

key - property key

predicate - boolean relationship to satisfy with the given value

value - value

Returns:

has

public 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 BaseVertexQuery<Q>>

Returns:

this query

hasNot

public 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 BaseVertexQuery<Q>>

Returns:

this query

interval

public <T extends Comparable<?>> Q interval(PropertyKey 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 BaseVertexQuery<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

interval

public <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 BaseVertexQuery<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

has

@Deprecated
public <T extends Comparable<T>> Q has(String key,
                                         T value,
                                         com.tinkerpop.blueprints.Query.Compare compare)

Deprecated.

types

public Q types(RelationType... types)

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 BaseVertexQuery<Q>>

Parameters:

types - relation types to query for

Returns:

this query

labels

public 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 BaseVertexQuery<Q>>

Parameters:

labels - edge labels to query for

Returns:

this query

keys

public 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 BaseVertexQuery<Q>>

Parameters:

keys - property keys to query for

Returns:

this query

type

public Q type(RelationType type)

direction

public Q direction(com.tinkerpop.blueprints.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 BaseVertexQuery<Q>>

Parameters:

d - Direction to query for

Returns:

this query

limit

public 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 BaseVertexQuery<Q>>

Parameters:

limit - maximum number of relations to retrieve for this query

Returns:

this query

orderBy

public Q orderBy(String key,
        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 BaseVertexQuery<Q>>

Parameters:

key - The key of the properties on which to order

order - the ordering direction

Returns:

orderBy

public Q orderBy(PropertyKey key,
        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 BaseVertexQuery<Q>>

Parameters:

key - The key of the properties on which to order

order - the ordering direction

Returns:

hasTypes

protected final boolean hasTypes()

hasSingleType

protected final boolean hasSingleType()

getSingleType

protected final RelationType getSingleType()

isImplicitKeyQuery

protected final boolean isImplicitKeyQuery(RelationCategory returnType)

Whether this query is asking for the value of an ImplicitKey.

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

Parameters:

returnType -

Returns:

edges2Vertices

protected static Iterable<TitanVertex> edges2Vertices(Iterable<TitanEdge> edges,
                                   TitanVertex other)

edges2VertexIds

protected VertexList edges2VertexIds(Iterable<TitanEdge> edges,
                         TitanVertex other)

executeImplicitKeyQuery

protected Iterable<TitanRelation> executeImplicitKeyQuery(InternalVertex v)

If isImplicitKeyQuery(com.thinkaurelius.titan.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:

allRepresentatives

protected List<InternalVertex> allRepresentatives(InternalVertex partitionedVertex)

isPartitionedVertex

protected final boolean isPartitionedVertex(InternalVertex vertex)

useSimpleQueryProcessor

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

executeRelations

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

executeVertices

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

executeVertexIds

public VertexList executeVertexIds(InternalVertex vertex,
                          BaseVertexCentricQuery baseQuery)

describeForEdges

public QueryDescription describeForEdges()

Description copied from interface: BaseVertexQuery

Returns a description of this query for edges as a QueryDescription object. This can be used to inspect the query plan for this query. Note, that calling this method does not actually execute the query but only optimizes it and constructs a query plan.

Specified by:

describeForEdges in interface BaseVertexQuery<Q extends BaseVertexQuery<Q>>

Returns:

A description of this query for edges

describeForProperties

public QueryDescription describeForProperties()

Description copied from interface: BaseVertexQuery

Returns a description of this query for properties as a QueryDescription object. This can be used to inspect the query plan for this query. Note, that calling this method does not actually execute the query but only optimizes it and constructs a query plan.

Specified by:

describeForProperties in interface BaseVertexQuery<Q extends BaseVertexQuery<Q>>

Returns:

A description of this query for properties

describeForRelations

public QueryDescription describeForRelations()

describe

protected QueryDescription describe(int numVertices,
                        RelationCategory returnType)

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(com.thinkaurelius.titan.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(com.thinkaurelius.titan.graphdb.internal.RelationCategory)

Returns:

constructQuery

protected BaseVertexCentricQuery constructQuery(RelationCategory returnType)