com.tinkerpop.blueprints

Interface Query

All Known Subinterfaces:

GraphQuery, VertexQuery

All Known Implementing Classes:

DefaultGraphQuery, DefaultQuery, DefaultVertexQuery, WrappedGraphQuery, WrapperVertexQuery

public interface Query

Author:

Matthias Broecheler (me@matthiasb.com), Marko A. Rodriguez (http://markorodriguez.com), Luca Garulli (http://www.orientechnologies.com), Daniel Kuppitz (daniel.kuppitz@shoproach.com)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Query.Compare Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
Iterable<Edge>	edges() Execute the query and return the matching edges.
Query	has(String key) Filter out elements that do not have a property with provided key.
Query	has(String key, Object value) Filter out elements that do not have a property value equal to provided value.
Query	has(String key, Predicate predicate, Object value) Filter out the element if it does not have a property with a comparable value.
<T extends Comparable<T>> Query	has(String key, T value, Query.Compare compare) Deprecated.
Query	hasNot(String key) Filter out elements that have a property with provided key.
Query	hasNot(String key, Object value) Filter out elements that have a property value equal to provided value.
<T extends Comparable<?>> Query	interval(String key, T startValue, T endValue) Filter out the element of its property value is not within the provided interval.
Query	limit(int limit) Filter out the element if the take number of incident/adjacent elements to retrieve has already been reached.
Iterable<Vertex>	vertices() Execute the query and return the vertices on the other end of the matching edges.

Method Detail

has

Query has(String key)

Filter out elements that do not have a property with provided key.

Parameters:

key - the key of the property

Returns:

the modified query object

hasNot

Query hasNot(String key)

Filter out elements that have a property with provided key.

Parameters:

key - the key of the property

Returns:

the modified query object

has

Query has(String key,
        Object value)

Filter out elements that do not have a property value equal to provided value.

Parameters:

key - the key of the property

value - the value to check against

Returns:

the modified query object

hasNot

Query hasNot(String key,
           Object value)

Filter out elements that have a property value equal to provided value.

Parameters:

key - the key of the property

value - the value to check against

Returns:

the modified query object

has

Query has(String key,
        Predicate predicate,
        Object value)

Filter out the element if it does not have a property with a comparable value.

Parameters:

key - the key of the property

predicate - the comparator to use for comparison

value - the value to check against

Returns:

the modified query object

has

@Deprecated
<T extends Comparable<T>> Query has(String key,
                                             T value,
                                             Query.Compare compare)

Deprecated.

Filter out the element if it does not have a property with a comparable value.

Parameters:

key - the key of the property

value - the value to check against

compare - the comparator to use for comparison

Returns:

the modified query object

interval

<T extends Comparable<?>> Query interval(String key,
                                       T startValue,
                                       T endValue)

Filter out the element of its property value is not within the provided interval.

Parameters:

key - the key of the property

startValue - the inclusive start value of the interval

endValue - the exclusive end value of the interval

Returns:

the modified query object

limit

Query limit(int limit)

Filter out the element if the take number of incident/adjacent elements to retrieve has already been reached.

Parameters:

limit - the take number of elements to return

Returns:

the modified query object

edges

Iterable<Edge> edges()

Execute the query and return the matching edges.

Returns:

the unfiltered incident edges

vertices

Iterable<Vertex> vertices()

Execute the query and return the vertices on the other end of the matching edges.

Returns:

the unfiltered adjacent vertices