org.vertexium.query

Class QueryParameters

java.lang.Object

org.vertexium.query.QueryParameters

Direct Known Subclasses:

QueryStringQueryParameters, SimilarToQueryParameters

public abstract class QueryParameters
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_SKIP

Constructor Summary

Constructors

Constructor and Description
QueryParameters(Authorizations authorizations)

Method Summary

Modifier and Type	Method and Description
void	addEdgeLabel(String edgeLabel)
void	addHasContainer(QueryBase.HasContainer hasContainer)
void	addIds(Collection<String> ids) When called the first time, all ids are added to the filter.
void	addSortContainer(QueryBase.SortContainer sortContainer)
abstract QueryParameters	clone()
protected QueryParameters	cloneTo(QueryParameters result)
Authorizations	getAuthorizations()
List<String>	getEdgeLabels()
List<QueryBase.HasContainer>	getHasContainers()
List<String>	getIds() Get the ids of the elements that should be searched in this query.
Long	getLimit()
Double	getMinScore()
ScoringStrategy	getScoringStrategy()
long	getSkip()
List<QueryBase.SortContainer>	getSortContainers()
void	setLimit(Integer limit)
void	setLimit(Long limit)
void	setMinScore(Double minScore)
void	setScoringStrategy(ScoringStrategy scoringStrategy)
void	setSkip(long skip)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SKIP

public static final int DEFAULT_SKIP

See Also:

Constant Field Values

Constructor Detail

QueryParameters

public QueryParameters(Authorizations authorizations)

Method Detail

addHasContainer

public void addHasContainer(QueryBase.HasContainer hasContainer)

getLimit

public Long getLimit()

setLimit

public void setLimit(Integer limit)

setLimit

public void setLimit(Long limit)

getSkip

public long getSkip()

setSkip

public void setSkip(long skip)

getMinScore

public Double getMinScore()

setMinScore

public void setMinScore(Double minScore)

getAuthorizations

public Authorizations getAuthorizations()

getHasContainers

public List<QueryBase.HasContainer> getHasContainers()

getSortContainers

public List<QueryBase.SortContainer> getSortContainers()

addSortContainer

public void addSortContainer(QueryBase.SortContainer sortContainer)

getEdgeLabels

public List<String> getEdgeLabels()

addEdgeLabel

public void addEdgeLabel(String edgeLabel)

getScoringStrategy

public ScoringStrategy getScoringStrategy()

setScoringStrategy

public void setScoringStrategy(ScoringStrategy scoringStrategy)

getIds

public List<String> getIds()

Get the ids of the elements that should be searched in this query.

Returns:

null if all elements should be searched. A List of element ids otherwise. Empty list indicates that all elements are filtered out.

addIds

public void addIds(Collection<String> ids)

When called the first time, all ids are added to the filter. When called two or more times, the provided id's are and'ed with the those provided in the previous lists.

Parameters:

ids - The ids of the elements that should be searched in this query.

clone

public abstract QueryParameters clone()

Overrides:

clone in class Object

cloneTo

protected QueryParameters cloneTo(QueryParameters result)

toString

public String toString()

Overrides:

toString in class Object