Package org.apache.jackrabbit.oak.plugins.index.aggregate

Class AggregateIndexPlan

  • All Implemented Interfaces:
    java.lang.Cloneable, QueryIndex.IndexPlan
    public class AggregateIndexPlan
extends java.lang.Object
implements QueryIndex.IndexPlan
    An index plan for multiple query indexes.

    • Method Detail

      • getCostPerExecution

        public double getCostPerExecution()
        Description copied from interface: QueryIndex.IndexPlan
        The cost to execute the query once. The returned value should approximately match the number of disk read operations plus the number of network roundtrips (worst case).
        Specified by:
        getCostPerExecution in interface QueryIndex.IndexPlan
        Returns:
        the cost per execution, in estimated number of I/O operations

      • getCostPerEntry

        public double getCostPerEntry()
        Description copied from interface: QueryIndex.IndexPlan
        The cost to read one entry from the cursor. The returned value should approximately match the number of disk read operations plus the number of network roundtrips (worst case).
        Specified by:
        getCostPerEntry in interface QueryIndex.IndexPlan
        Returns:
        the lookup cost per entry, in estimated number of I/O operations

      • getEstimatedEntryCount

        public long getEstimatedEntryCount()
        Description copied from interface: QueryIndex.IndexPlan
        The estimated number of entries in the cursor that is returned by the query method, when using this plan. This value does not have to be accurate.
        Specified by:
        getEstimatedEntryCount in interface QueryIndex.IndexPlan
        Returns:
        the estimated number of entries

      • isDelayed

        public boolean isDelayed()
        Whether any base plan is delayed.
        Specified by:
        isDelayed in interface QueryIndex.IndexPlan
        Returns:
        true if yes

      • isFulltextIndex

        public boolean isFulltextIndex()
        Whether any base plan is a full text index.
        Specified by:
        isFulltextIndex in interface QueryIndex.IndexPlan
        Returns:
        true if yes

      • includesNodeData

        public boolean includesNodeData()
        Whether all base plan include node data.
        Specified by:
        includesNodeData in interface QueryIndex.IndexPlan
        Returns:
        true if yes

      • getPropertyRestriction

        @Nullable
public @Nullable Filter.PropertyRestriction getPropertyRestriction()
        Description copied from interface: QueryIndex.IndexPlan
        The property restriction for this index plan or null if this index plan isn't base on a property restriction. E.g. a plan based on an order by clause in the query.
        Specified by:
        getPropertyRestriction in interface QueryIndex.IndexPlan
        Returns:
        the restriction this plan is based on or null.

      • getAttribute

        @Nullable
public @Nullable java.lang.Object getAttribute​(java.lang.String name)
        Description copied from interface: QueryIndex.IndexPlan
        Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
        Specified by:
        getAttribute in interface QueryIndex.IndexPlan
        Parameters:
        name - String specifying the name of the attribute
        Returns:
        an Object containing the value of the attribute, or null if the attribute does not exist