org.janusgraph.graphdb.olap

Class QueryContainer.QueryBuilder

java.lang.Object

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

org.janusgraph.graphdb.query.vertex.BasicVertexCentricQueryBuilder<QueryContainer.QueryBuilder>

org.janusgraph.graphdb.olap.QueryContainer.QueryBuilder

All Implemented Interfaces:

BaseVertexQuery<QueryContainer.QueryBuilder>

Enclosing class:

QueryContainer

public class QueryContainer.QueryBuilder
extends BasicVertexCentricQueryBuilder<QueryContainer.QueryBuilder>

Nested Class Summary

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

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

Method Summary

Modifier and Type	Method and Description
QueryContainer.QueryBuilder	direction(org.apache.tinkerpop.gremlin.structure.Direction d) Query only for relations in the given direction.
void	edges()
protected QueryContainer.QueryBuilder	getThis()
QueryContainer.QueryBuilder	has(String key) Query for edges or properties that have defined property with the given key
QueryContainer.QueryBuilder	has(String key, JanusGraphPredicate predicate, Object value)
QueryContainer.QueryBuilder	has(String type, Object value) Query only for edges or properties that have an incident property or unidirected edge matching the given value.
QueryContainer.QueryBuilder	hasNot(String key) Query for edges or properties that DO NOT have a defined property with the given key
QueryContainer.QueryBuilder	hasNot(String key, Object value) Identical to BaseVertexQuery.has(String, Object) but negates the condition, i.e.
<T extends Comparable<?>> QueryContainer.QueryBuilder	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).
QueryContainer.QueryBuilder	keys(String... keys) Query for only those properties having one of the given property keys.
QueryContainer.QueryBuilder	labels(String... labels) Query for only those edges matching one of the given edge labels.
QueryContainer.QueryBuilder	limit(int limit) Sets the retrieval limit for this query.
QueryContainer.QueryBuilder	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	properties()
void	relations()
QueryContainer.QueryBuilder	type(RelationType type)
QueryContainer.QueryBuilder	types(RelationType... types) Query for only those relations matching one of the given relation types.

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

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

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

adjacent, getSingleType, hasSingleType, hasTypes, isImplicitKeyQuery, types

Methods inherited from class java.lang.Object

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

Method Detail

getThis

protected QueryContainer.QueryBuilder getThis()

Specified by:

getThis in class BaseVertexCentricQueryBuilder<QueryContainer.QueryBuilder>

edges

public void edges()

relations

public void relations()

properties

public void properties()

has

public QueryContainer.QueryBuilder 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<QueryContainer.QueryBuilder>

Overrides:

has in class BaseVertexCentricQueryBuilder<QueryContainer.QueryBuilder>

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

hasNot

public QueryContainer.QueryBuilder 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<QueryContainer.QueryBuilder>

Overrides:

hasNot in class BaseVertexCentricQueryBuilder<QueryContainer.QueryBuilder>

Returns:

has

public QueryContainer.QueryBuilder 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<QueryContainer.QueryBuilder>

Overrides:

has in class BaseVertexCentricQueryBuilder<QueryContainer.QueryBuilder>

Returns:

this query

hasNot

public QueryContainer.QueryBuilder 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<QueryContainer.QueryBuilder>

Overrides:

hasNot in class BaseVertexCentricQueryBuilder<QueryContainer.QueryBuilder>

Returns:

this query

has

public QueryContainer.QueryBuilder has(String key,
                                       JanusGraphPredicate predicate,
                                       Object value)

Specified by:

has in interface BaseVertexQuery<QueryContainer.QueryBuilder>

Overrides:

has in class BaseVertexCentricQueryBuilder<QueryContainer.QueryBuilder>

interval

public <T extends Comparable<?>> QueryContainer.QueryBuilder 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<QueryContainer.QueryBuilder>

Overrides:

interval in class BaseVertexCentricQueryBuilder<QueryContainer.QueryBuilder>

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

types

public QueryContainer.QueryBuilder 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<QueryContainer.QueryBuilder>

Overrides:

types in class BaseVertexCentricQueryBuilder<QueryContainer.QueryBuilder>

Parameters:

types - relation types to query for

Returns:

this query

labels

public QueryContainer.QueryBuilder 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<QueryContainer.QueryBuilder>

Overrides:

labels in class BaseVertexCentricQueryBuilder<QueryContainer.QueryBuilder>

Parameters:

labels - edge labels to query for

Returns:

this query

keys

public QueryContainer.QueryBuilder 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<QueryContainer.QueryBuilder>

Overrides:

keys in class BaseVertexCentricQueryBuilder<QueryContainer.QueryBuilder>

Parameters:

keys - property keys to query for

Returns:

this query

type

public QueryContainer.QueryBuilder type(RelationType type)

Overrides:

type in class BaseVertexCentricQueryBuilder<QueryContainer.QueryBuilder>

direction

public QueryContainer.QueryBuilder 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<QueryContainer.QueryBuilder>

Overrides:

direction in class BaseVertexCentricQueryBuilder<QueryContainer.QueryBuilder>

Parameters:

d - Direction to query for

Returns:

this query

limit

public QueryContainer.QueryBuilder 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<QueryContainer.QueryBuilder>

Overrides:

limit in class BaseVertexCentricQueryBuilder<QueryContainer.QueryBuilder>

Parameters:

limit - maximum number of relations to retrieve for this query

Returns:

this query

orderBy

public QueryContainer.QueryBuilder 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<QueryContainer.QueryBuilder>

Overrides:

orderBy in class BaseVertexCentricQueryBuilder<QueryContainer.QueryBuilder>

Parameters:

key - The key of the properties on which to order

order - the ordering direction

Returns: