org.vertexium.query

Class QueryBase

java.lang.Object

org.vertexium.query.QueryBase

All Implemented Interfaces:

GraphQuery, Query, SimilarToGraphQuery

Direct Known Subclasses:

DefaultMultiVertexQuery, GraphQueryBase, VertexQueryBase

public abstract class QueryBase
extends Object
implements Query, SimilarToGraphQuery

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryBase.HasContainer
static class	QueryBase.HasNotPropertyContainer
static class	QueryBase.HasPropertyContainer
static class	QueryBase.HasValueContainer
static class	QueryBase.SortContainer

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	QueryBase(Graph graph, String[] similarToFields, String similarToText, Authorizations authorizations)
protected	QueryBase(Graph graph, String queryString, Authorizations authorizations)

Method Summary

Modifier and Type	Method and Description
Query	addAggregation(Aggregation aggregation) Add an aggregation to the query
SimilarToGraphQuery	boost(float boost) The amount of boost to apply to the similarity query.
QueryResultsIterable<Edge>	edges()
abstract 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)
Aggregation	getAggregationByName(String aggregationName)
Collection<Aggregation>	getAggregations() Gets the added aggregations
Graph	getGraph()
QueryParameters	getParameters()
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.
SimilarToGraphQuery	maxDocFrequency(int maxDocFrequency) The maximum number of documents a term can be in to be considered for a similarity match.
SimilarToGraphQuery	maxQueryTerms(int maxQueryTerms) The maximum number of terms to be searched for.
SimilarToGraphQuery	minDocFrequency(int minDocFrequency) The minimum number of documents a term must be in to be considered for a similarity match.
SimilarToGraphQuery	minTermFrequency(int minTermFrequency) The minimum number of times a term must appear in the source data to be considered for a match.
SimilarToGraphQuery	percentTermsToMatch(float percentTermsToMatch) The percentage of terms that must match to be considered similar.
<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()
abstract QueryResultsIterable<Vertex>	vertices(EnumSet<FetchHint> fetchHints)

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryBase

protected QueryBase(Graph graph,
                    String queryString,
                    Authorizations authorizations)

QueryBase

protected QueryBase(Graph graph,
                    String[] similarToFields,
                    String similarToText,
                    Authorizations authorizations)

Method Detail

vertices

public QueryResultsIterable<Vertex> vertices()

Specified by:

vertices in interface Query

vertices

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

Specified by:

vertices in interface Query

edges

public QueryResultsIterable<Edge> edges()

Specified by:

edges in interface Query

edges

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

Specified by:

edges in interface Query

hasEdgeLabel

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

Description copied from interface: Query

Adds a edge label filter to the query.

Specified by:

hasEdgeLabel in interface Query

Parameters:

edgeLabels - The edge labels to filter on.

Returns:

The query object, allowing you to chain methods.

hasEdgeLabel

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

Description copied from interface: Query

Adds a edge label filter to the query.

Specified by:

hasEdgeLabel in interface Query

Parameters:

edgeLabels - The edge labels to filter on.

Returns:

The query object, allowing you to chain methods.

edges

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

Deprecated.

Specified by:

edges in interface Query

edges

@Deprecated
public QueryResultsIterable<Edge> edges(String label)

Deprecated.

Specified by:

edges in interface Query

elements

public QueryResultsIterable<Element> elements()

Specified by:

elements in interface Query

elements

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

Specified by:

elements in interface Query

range

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

Description copied from interface: Query

Queries for properties in the given range.

Specified by:

range in interface Query

Parameters:

propertyName - Name of property.

startValue - Inclusive start value.

endValue - Inclusive end value.

Returns:

this

range

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

Description copied from interface: Query

Queries for properties in the given range.

Specified by:

range in interface Query

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

sort

public Query sort(String propertyName,
                  SortDirection direction)

Description copied from interface: Query

Sort the results by the given property name.

Specified by:

sort in interface Query

Parameters:

propertyName - The property to sort by.

direction - The direction to sort.

Returns:

The query object, allowing you to chain methods.

has

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

Description copied from interface: Query

Adds an Compare.EQUAL filter to the query.

Specified by:

has in interface 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

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

Description copied from interface: Query

Adds an Contains.NOT_IN filter to the query.

Specified by:

hasNot in interface 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

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

Description copied from interface: Query

Adds a filter to the query.

Specified by:

has in interface 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.

has

public Query has(String propertyName)

Description copied from interface: Query

Adds a has filter to the query.

Specified by:

has in interface Query

Parameters:

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

Returns:

The query object, allowing you to chain methods.

hasNot

public Query hasNot(String propertyName)

Description copied from interface: Query

Adds a hasNot filter to the query.

Specified by:

hasNot in interface Query

Parameters:

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

Returns:

The query object, allowing you to chain methods.

skip

public Query skip(int count)

Description copied from interface: Query

Skips the given number of items.

Specified by:

skip in interface Query

limit

public Query limit(Integer count)

Description copied from interface: Query

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

Specified by:

limit in interface Query

limit

public Query limit(Long count)

Description copied from interface: Query

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

Specified by:

limit in interface Query

getGraph

public Graph getGraph()

getParameters

public QueryParameters getParameters()

minTermFrequency

public SimilarToGraphQuery minTermFrequency(int minTermFrequency)

Description copied from interface: SimilarToGraphQuery

The minimum number of times a term must appear in the source data to be considered for a match.

Specified by:

minTermFrequency in interface SimilarToGraphQuery

maxQueryTerms

public SimilarToGraphQuery maxQueryTerms(int maxQueryTerms)

Description copied from interface: SimilarToGraphQuery

The maximum number of terms to be searched for.

Specified by:

maxQueryTerms in interface SimilarToGraphQuery

minDocFrequency

public SimilarToGraphQuery minDocFrequency(int minDocFrequency)

Description copied from interface: SimilarToGraphQuery

The minimum number of documents a term must be in to be considered for a similarity match.

Specified by:

minDocFrequency in interface SimilarToGraphQuery

maxDocFrequency

public SimilarToGraphQuery maxDocFrequency(int maxDocFrequency)

Description copied from interface: SimilarToGraphQuery

The maximum number of documents a term can be in to be considered for a similarity match.

Specified by:

maxDocFrequency in interface SimilarToGraphQuery

percentTermsToMatch

public SimilarToGraphQuery percentTermsToMatch(float percentTermsToMatch)

Description copied from interface: SimilarToGraphQuery

The percentage of terms that must match to be considered similar.

Specified by:

percentTermsToMatch in interface SimilarToGraphQuery

boost

public SimilarToGraphQuery boost(float boost)

Description copied from interface: SimilarToGraphQuery

The amount of boost to apply to the similarity query.

Specified by:

boost in interface SimilarToGraphQuery

isAggregationSupported

public boolean isAggregationSupported(Aggregation aggregation)

Description copied from interface: Query

Test to see if aggregation is supported.

Specified by:

isAggregationSupported in interface Query

Parameters:

aggregation - the aggregation to test.

Returns:

true, if the aggregation is supported

addAggregation

public Query addAggregation(Aggregation aggregation)

Description copied from interface: Query

Add an aggregation to the query

Specified by:

addAggregation in interface Query

Parameters:

aggregation - the aggregation to add.

Returns:

The query object, allowing you to chain methods.

getAggregations

public Collection<Aggregation> getAggregations()

Description copied from interface: Query

Gets the added aggregations

Specified by:

getAggregations in interface Query

getAggregationByName

public Aggregation getAggregationByName(String aggregationName)