com.tinkerpop.blueprints.util.wrappers

Class WrapperVertexQuery

java.lang.Object

com.tinkerpop.blueprints.util.wrappers.WrapperVertexQuery

All Implemented Interfaces:

Query, VertexQuery

public abstract class WrapperVertexQuery
extends Object
implements VertexQuery

A WrapperQuery is useful for wrapping the construction and results of a Vertex.query(). Any necessary Iterable wrapping must occur when Vertex.vertices() or Vertex.edges() is called.

Author:

Marko A. Rodriguez (http://markorodriguez.com)

Nested Class Summary

Nested classes/interfaces inherited from interface com.tinkerpop.blueprints.Query

Query.Compare

Field Summary

Fields

Modifier and Type	Field and Description
protected VertexQuery	query

Constructor Summary

Constructors

Constructor and Description
WrapperVertexQuery(VertexQuery query)

Method Summary

Methods

Modifier and Type	Method and Description
long	count() Execute the query and return the number of edges that are unfiltered.
VertexQuery	direction(Direction direction) The direction of the edges to retrieve.
abstract Iterable<Edge>	edges() Execute the query and return the matching edges.
VertexQuery	has(String key) Filter out elements that do not have a property with provided key.
VertexQuery	has(String key, Object value) Filter out elements that do not have a property value equal to provided value.
VertexQuery	has(String key, Predicate compare, Object value) Filter out the element if it does not have a property with a comparable value.
<T extends Comparable<T>> VertexQuery	has(String key, T value, Query.Compare compare) Filter out the element if it does not have a property with a comparable value.
VertexQuery	hasNot(String key) Filter out elements that have a property with provided key.
VertexQuery	hasNot(String key, Object value) Filter out elements that have a property value equal to provided value.
<T extends Comparable<?>> VertexQuery	interval(String key, T startValue, T endValue) Filter out the element of its property value is not within the provided interval.
VertexQuery	labels(String... labels) Filter out the edge if its label is not in set of provided labels.
VertexQuery	limit(int limit) Filter out the element if the take number of incident/adjacent elements to retrieve has already been reached.
Object	vertexIds() Return the raw ids of the vertices on the other end of the edges.
abstract Iterable<Vertex>	vertices() Execute the query and return the vertices on the other end of the matching edges.

Methods inherited from class java.lang.Object

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

Field Detail

query

protected VertexQuery query

Constructor Detail

WrapperVertexQuery

public WrapperVertexQuery(VertexQuery query)

Method Detail

has

public VertexQuery has(String key)

Description copied from interface: Query

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

Specified by:

has in interface Query

Specified by:

has in interface VertexQuery

Parameters:

key - the key of the property

Returns:

the modified query object

hasNot

public VertexQuery hasNot(String key)

Description copied from interface: Query

Filter out elements that have a property with provided key.

Specified by:

hasNot in interface Query

Specified by:

hasNot in interface VertexQuery

Parameters:

key - the key of the property

Returns:

the modified query object

has

public VertexQuery has(String key,
              Object value)

Description copied from interface: Query

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

Specified by:

has in interface Query

Specified by:

has in interface VertexQuery

Parameters:

key - the key of the property

value - the value to check against

Returns:

the modified query object

hasNot

public VertexQuery hasNot(String key,
                 Object value)

Description copied from interface: Query

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

Specified by:

hasNot in interface Query

Specified by:

hasNot in interface VertexQuery

Parameters:

key - the key of the property

value - the value to check against

Returns:

the modified query object

has

public VertexQuery has(String key,
              Predicate compare,
              Object value)

Description copied from interface: Query

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

Specified by:

has in interface Query

Specified by:

has in interface VertexQuery

Parameters:

key - the key of the property

compare - the comparator to use for comparison

value - the value to check against

Returns:

the modified query object

has

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

Description copied from interface: Query

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

Specified by:

has in interface Query

Specified by:

has in interface VertexQuery

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

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

Description copied from interface: Query

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

Specified by:

interval in interface Query

Specified by:

interval in interface VertexQuery

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

direction

public VertexQuery direction(Direction direction)

Description copied from interface: VertexQuery

The direction of the edges to retrieve.

Specified by:

direction in interface VertexQuery

Parameters:

direction - whether to retrieve the incoming, outgoing, or both directions

Returns:

the modified query object

limit

public VertexQuery limit(int limit)

Description copied from interface: Query

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

Specified by:

limit in interface Query

Specified by:

limit in interface VertexQuery

Parameters:

limit - the take number of elements to return

Returns:

the modified query object

labels

public VertexQuery labels(String... labels)

Description copied from interface: VertexQuery

Filter out the edge if its label is not in set of provided labels.

Specified by:

labels in interface VertexQuery

Parameters:

labels - the labels to check against

Returns:

the modified query object

count

public long count()

Description copied from interface: VertexQuery

Execute the query and return the number of edges that are unfiltered.

Specified by:

count in interface VertexQuery

Returns:

the number of unfiltered edges

vertexIds

public Object vertexIds()

Description copied from interface: VertexQuery

Return the raw ids of the vertices on the other end of the edges.

Specified by:

vertexIds in interface VertexQuery

Returns:

the raw ids of the vertices on the other end of the edges

edges

public abstract Iterable<Edge> edges()

Description copied from interface: Query

Execute the query and return the matching edges.

Specified by:

edges in interface Query

Returns:

the unfiltered incident edges

vertices

public abstract Iterable<Vertex> vertices()

Description copied from interface: Query

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

Specified by:

vertices in interface Query

Returns:

the unfiltered adjacent vertices