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 Details

    • FindPlan

      public FindPlan()
      Instantiates a new FindPlan.

  • Method Details

    • 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