org.neolumin.vertexium.query

Class QueryBase

java.lang.Object

org.neolumin.vertexium.query.QueryBase

All Implemented Interfaces:

GraphQuery, Query, SimilarToGraphQuery

Direct Known Subclasses:

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	QueryBase(Graph graph, String[] similarToFields, String similarToText, Map<String,PropertyDefinition> propertyDefinitions, Authorizations authorizations)
protected	QueryBase(Graph graph, String queryString, Map<String,PropertyDefinition> propertyDefinitions, Authorizations authorizations)

Method Summary

Methods

Modifier and Type	Method and Description
SimilarToGraphQuery	boost(float boost) The amount of boost to apply to the similarity query.
Iterable<Edge>	edges()
abstract Iterable<Edge>	edges(EnumSet<FetchHint> fetchHints)
Iterable<Edge>	edges(String label)
Iterable<Edge>	edges(String label, EnumSet<FetchHint> fetchHints)
Graph	getGraph()
QueryParameters	getParameters()
protected Map<String,PropertyDefinition>	getPropertyDefinitions()
<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.
Query	limit(int count)
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, T endValue) Queries for properties in the given range.
Query	skip(int count)
Iterable<Vertex>	vertices()
abstract Iterable<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,
         Map<String,PropertyDefinition> propertyDefinitions,
         Authorizations authorizations)

QueryBase

protected QueryBase(Graph graph,
         String[] similarToFields,
         String similarToText,
         Map<String,PropertyDefinition> propertyDefinitions,
         Authorizations authorizations)

Method Detail

vertices

public Iterable<Vertex> vertices()

Specified by:

vertices in interface Query

vertices

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

Specified by:

vertices in interface Query

edges

public Iterable<Edge> edges()

Specified by:

edges in interface Query

edges

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

Specified by:

edges in interface Query

edges

public Iterable<Edge> edges(String label,
                   EnumSet<FetchHint> fetchHints)

Specified by:

edges in interface Query

edges

public Iterable<Edge> edges(String label)

Specified by:

edges 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

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.

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.

skip

public Query skip(int count)

Specified by:

skip in interface Query

limit

public Query limit(int count)

Specified by:

limit in interface Query

getGraph

public Graph getGraph()

getParameters

public QueryParameters getParameters()

getPropertyDefinitions

protected Map<String,PropertyDefinition> getPropertyDefinitions()

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