org.vertexium.query

Interface Query

All Known Subinterfaces:

GraphQuery, GraphQueryWithGeohashAggregation, GraphQueryWithHistogramAggregation, GraphQueryWithStatisticsAggregation, GraphQueryWithTermsAggregation, MultiVertexQuery, SimilarToGraphQuery, VertexQuery

All Known Implementing Classes:

CompositeGraphQuery, DefaultGraphQuery, DefaultMultiVertexQuery, DefaultVertexQuery, GraphQueryBase, QueryBase, VertexQueryBase

public interface Query

Method Summary

Modifier and Type	Method and Description
Query	addAggregation(Aggregation aggregation) Add an aggregation to the query
QueryResultsIterable<Edge>	edges()
QueryResultsIterable<Edge>	edges(EnumSet<FetchHint> fetchHints)
QueryResultsIterable<Edge>	edges(String label) Deprecated.
QueryResultsIterable<Edge>	edges(String label, EnumSet<FetchHint> fetchHints) Deprecated.
QueryResultsIterable<Element>	elements()
QueryResultsIterable<Element>	elements(EnumSet<FetchHint> fetchHints)
Iterable<Aggregation>	getAggregations() Gets the added aggregations
Query	has(String propertyName) Adds a has filter to the query.
<T> Query	has(String propertyName, Predicate predicate, T value) Adds a filter to the query.
<T> Query	has(String propertyName, T value) Adds an Compare.EQUAL filter to the query.
<T> Query	hasEdgeLabel(Collection<String> edgeLabels) Adds a edge label filter to the query.
<T> Query	hasEdgeLabel(String... edgeLabels) Adds a edge label filter to the query.
Query	hasNot(String propertyName) Adds a hasNot filter to the query.
<T> Query	hasNot(String propertyName, T value) Adds an Contains.NOT_IN filter to the query.
boolean	isAggregationSupported(Aggregation aggregation) Test to see if aggregation is supported.
Query	limit(Integer count) Limits the number of items returned.
Query	limit(Long count) Limits the number of items returned.
<T> Query	range(String propertyName, T startValue, boolean inclusiveStartValue, T endValue, boolean inclusiveEndValue) Queries for properties in the given range.
<T> Query	range(String propertyName, T startValue, T endValue) Queries for properties in the given range.
Query	skip(int count) Skips the given number of items.
Query	sort(String propertyName, SortDirection direction) Sort the results by the given property name.
QueryResultsIterable<Vertex>	vertices()
QueryResultsIterable<Vertex>	vertices(EnumSet<FetchHint> fetchHints)

Method Detail

vertices

QueryResultsIterable<Vertex> vertices()

vertices

QueryResultsIterable<Vertex> vertices(EnumSet<FetchHint> fetchHints)

edges

QueryResultsIterable<Edge> edges()

edges

QueryResultsIterable<Edge> edges(EnumSet<FetchHint> fetchHints)

edges

@Deprecated
QueryResultsIterable<Edge> edges(String label)

Deprecated.

edges

@Deprecated
QueryResultsIterable<Edge> edges(String label,
                                             EnumSet<FetchHint> fetchHints)

Deprecated.

elements

QueryResultsIterable<Element> elements()

elements

QueryResultsIterable<Element> elements(EnumSet<FetchHint> fetchHints)

range

<T> Query range(String propertyName,
                T startValue,
                T endValue)

Queries for properties in the given range.

Parameters:

propertyName - Name of property.

startValue - Inclusive start value.

endValue - Inclusive end value.

Returns:

this

range

<T> Query range(String propertyName,
                T startValue,
                boolean inclusiveStartValue,
                T endValue,
                boolean inclusiveEndValue)

Queries for properties in the given range.

Parameters:

propertyName - Name of property.

startValue - Inclusive start value.

inclusiveStartValue - true, to include the start value

endValue - Inclusive end value.

inclusiveEndValue - true, to include the end value

Returns:

this

hasEdgeLabel

<T> Query hasEdgeLabel(String... edgeLabels)

Adds a edge label filter to the query.

Parameters:

edgeLabels - The edge labels to filter on.

Returns:

The query object, allowing you to chain methods.

hasEdgeLabel

<T> Query hasEdgeLabel(Collection<String> edgeLabels)

Adds a edge label filter to the query.

Parameters:

edgeLabels - The edge labels to filter on.

Returns:

The query object, allowing you to chain methods.

has

<T> Query has(String propertyName,
              T value)

Adds an Compare.EQUAL filter to the query.

Parameters:

propertyName - The name of the property to query on.

value - The value of the property to query for.

Returns:

The query object, allowing you to chain methods.

hasNot

<T> Query hasNot(String propertyName,
                 T value)

Adds an Contains.NOT_IN filter to the query.

Parameters:

propertyName - The name of the property to query on.

value - The value of the property to query for.

Returns:

The query object, allowing you to chain methods.

has

Query has(String propertyName)

Adds a has filter to the query.

Parameters:

propertyName - The name of the property the element must contain.

Returns:

The query object, allowing you to chain methods.

hasNot

Query hasNot(String propertyName)

Adds a hasNot filter to the query.

Parameters:

propertyName - The name of the property the element must not contain.

Returns:

The query object, allowing you to chain methods.

has

<T> Query has(String propertyName,
              Predicate predicate,
              T value)

Adds a filter to the query.

Parameters:

propertyName - The name of the property to query on.

predicate - One of Compare, TextPredicate, or GeoCompare.

value - The value of the property to query for.

Returns:

The query object, allowing you to chain methods.

skip

Query skip(int count)

Skips the given number of items.

limit

Query limit(Integer count)

Limits the number of items returned. null will return all elements.

limit

Query limit(Long count)

Limits the number of items returned. null will return all elements.

sort

Query sort(String propertyName,
           SortDirection direction)

Sort the results by the given property name.

Parameters:

propertyName - The property to sort by.

direction - The direction to sort.

Returns:

The query object, allowing you to chain methods.

isAggregationSupported

boolean isAggregationSupported(Aggregation aggregation)

Test to see if aggregation is supported.

Parameters:

aggregation - the aggregation to test.

Returns:

true, if the aggregation is supported

addAggregation

Query addAggregation(Aggregation aggregation)

Add an aggregation to the query

Parameters:

aggregation - the aggregation to add.

Returns:

The query object, allowing you to chain methods.

getAggregations

Iterable<Aggregation> getAggregations()

Gets the added aggregations