Package org.dizitart.no2.collection

Class FindPlan

java.lang.Object

org.dizitart.no2.collection.FindPlan

public class FindPlan
extends Object

A plan for finding documents in a collection.

Since:

4.0

Author:

Anindya Chatterjee

Constructor Summary

Constructors

Constructor	Description
FindPlan()	Instantiates a new FindPlan.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
List<Pair<String,SortOrder>>	getBlockingSortOrder()	Gets the blocking sort order.
FieldBasedFilter	getByIdFilter()	Gets the FieldBasedFilter for byId search if any.
Collator	getCollator()	Gets the Collator.
Filter	getCollectionScanFilter()	Gets the Filter for collection scan if any.
IndexDescriptor	getIndexDescriptor()	Gets the IndexDescriptor for index scan if any.
IndexScanFilter	getIndexScanFilter()	Gets the IndexScanFilter for index scan if any.
Map<String,Boolean>	getIndexScanOrder()	Gets the index scan order.
Long	getLimit()	Gets the limit count.
Long	getSkip()	Gets the skip count.
List<FindPlan>	getSubPlans()	Gets the sub plans.
int	hashCode()
boolean	isDistinct()	Gets the distinct flag.
void	setBlockingSortOrder(List<Pair<String,SortOrder>> blockingSortOrder)	Gets the blocking sort order.
void	setByIdFilter(FieldBasedFilter byIdFilter)	Gets the FieldBasedFilter for byId search if any.
void	setCollator(Collator collator)	Gets the Collator.
void	setCollectionScanFilter(Filter collectionScanFilter)	Gets the Filter for collection scan if any.
void	setDistinct(boolean distinct)	Gets the distinct flag.
void	setIndexDescriptor(IndexDescriptor indexDescriptor)	Gets the IndexDescriptor for index scan if any.
void	setIndexScanFilter(IndexScanFilter indexScanFilter)	Gets the IndexScanFilter for index scan if any.
void	setIndexScanOrder(Map<String,Boolean> indexScanOrder)	Gets the index scan order.
void	setLimit(Long limit)	Gets the limit count.
void	setSkip(Long skip)	Gets the skip count.
void	setSubPlans(List<FindPlan> subPlans)	Gets the sub plans.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FindPlan

public FindPlan()

Instantiates a new FindPlan.

Method Detail

getByIdFilter

public FieldBasedFilter getByIdFilter()

Gets the FieldBasedFilter for byId search if any.

getIndexScanFilter

public IndexScanFilter getIndexScanFilter()

Gets the IndexScanFilter for index scan if any.

getCollectionScanFilter

public Filter getCollectionScanFilter()

Gets the Filter for collection scan if any.

getIndexDescriptor

public IndexDescriptor getIndexDescriptor()

Gets the IndexDescriptor for index scan if any.

getIndexScanOrder

public Map<String,Boolean> getIndexScanOrder()

Gets the index scan order.

getBlockingSortOrder

public List<Pair<String,SortOrder>> getBlockingSortOrder()

Gets the blocking sort order.

getSkip

public Long getSkip()

Gets the skip count.

getLimit

public Long getLimit()

Gets the limit count.

isDistinct

public boolean isDistinct()

Gets the distinct flag.

getCollator

public Collator getCollator()

Gets the Collator.

getSubPlans

public List<FindPlan> getSubPlans()

Gets the sub plans.

setByIdFilter

public void setByIdFilter(FieldBasedFilter byIdFilter)

Gets the FieldBasedFilter for byId search if any.

setIndexScanFilter

public void setIndexScanFilter(IndexScanFilter indexScanFilter)

Gets the IndexScanFilter for index scan if any.

setCollectionScanFilter

public void setCollectionScanFilter(Filter collectionScanFilter)

Gets the Filter for collection scan if any.

setIndexDescriptor

public void setIndexDescriptor(IndexDescriptor indexDescriptor)

Gets the IndexDescriptor for index scan if any.

setIndexScanOrder

public void setIndexScanOrder(Map<String,Boolean> indexScanOrder)

Gets the index scan order.

setBlockingSortOrder

public void setBlockingSortOrder(List<Pair<String,SortOrder>> blockingSortOrder)

Gets the blocking sort order.

setSkip

public void setSkip(Long skip)

Gets the skip count.

setLimit

public void setLimit(Long limit)

Gets the limit count.

setDistinct

public void setDistinct(boolean distinct)

Gets the distinct flag.

setCollator

public void setCollator(Collator collator)

Gets the Collator.

setSubPlans

public void setSubPlans(List<FindPlan> subPlans)

Gets the sub plans.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object