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

Class IndexUpdate

java.lang.Object
org.apache.jackrabbit.oak.plugins.index.IndexUpdate
All Implemented Interfaces:
NodeTraversalCallback.PathSource, Editor
public class IndexUpdate extends Object implements Editor, NodeTraversalCallback.PathSource

  • Field Details

    • INDEX_JCR_TYPE_INVALID_LOG_LIMITER

      public static final long INDEX_JCR_TYPE_INVALID_LOG_LIMITER

  • Constructor Details

  • Method Details

    • enter

      public void enter(NodeState before, NodeState after) throws CommitFailedException
      Description copied from interface: Editor
      Called before the given before and after states are compared. The implementation can use this method to initialize any internal state needed for processing the results of the comparison. For example an implementation could look up the effective node type of the after state to know what constraints to apply to on the content changes.
      Specified by:
      enter in interface Editor
      Parameters:
      before - before state, non-existent if this node was added
      after - after state, non-existent if this node was removed
      Throws:
      CommitFailedException - if this commit should be rejected

    • isReindexingPerformed

      public boolean isReindexingPerformed()

    • getReindexStats

      public List<String> getReindexStats()

    • getUpdatedIndexPaths

      public Set<String> getUpdatedIndexPaths()

    • setTraversalRateEstimator

      public void setTraversalRateEstimator(org.apache.jackrabbit.oak.plugins.index.progress.TraversalRateEstimator estimator)

    • setNodeCountEstimator

      public void setNodeCountEstimator(org.apache.jackrabbit.oak.plugins.index.progress.NodeCountEstimator nodeCountEstimator)

    • getIndexingStats

      public String getIndexingStats()

    • setIgnoreReindexFlags

      public void setIgnoreReindexFlags(boolean ignoreReindexFlag)

    • getPath

      public String getPath()
      Returns the path of this node, building it lazily when first requested.
      Specified by:
      getPath in interface NodeTraversalCallback.PathSource

    • leave

      public void leave(NodeState before, NodeState after) throws CommitFailedException
      Description copied from interface: Editor
      Called after the given before and after states are compared. The implementation can use this method to post-process information collected during the content diff. For example an implementation that during the diff just recorded the fact that this node was modified in some way could then use this method to trigger an index update based on that modification flag.
      Specified by:
      leave in interface Editor
      Parameters:
      before - before state, non-existent if this node was added
      after - after state, non-existent if this node was removed
      Throws:
      CommitFailedException - if this commit should be rejected

    • propertyAdded

      public void propertyAdded(PropertyState after) throws CommitFailedException
      Description copied from interface: Editor
      Processes an added property.
      Specified by:
      propertyAdded in interface Editor
      Parameters:
      after - the added property
      Throws:
      CommitFailedException - if processing failed

    • propertyChanged

      public void propertyChanged(PropertyState before, PropertyState after) throws CommitFailedException
      Description copied from interface: Editor
      Processes a changed property.
      Specified by:
      propertyChanged in interface Editor
      Parameters:
      before - the original property
      after - the changed property
      Throws:
      CommitFailedException - if processing failed

    • propertyDeleted

      public void propertyDeleted(PropertyState before) throws CommitFailedException
      Description copied from interface: Editor
      Processes a removed property.
      Specified by:
      propertyDeleted in interface Editor
      Parameters:
      before - the removed property
      Throws:
      CommitFailedException - if processing failed

    • childNodeAdded

      @NotNull public @NotNull Editor childNodeAdded(String name, NodeState after) throws CommitFailedException
      Description copied from interface: Editor
      Processes an added child node.
      Specified by:
      childNodeAdded in interface Editor
      Parameters:
      name - name of the added node
      after - the added child node
      Returns:
      an editor for processing the subtree below the added node, or null if the subtree does not need processing
      Throws:
      CommitFailedException - if processing failed

    • childNodeChanged

      @NotNull public @NotNull Editor childNodeChanged(String name, NodeState before, NodeState after) throws CommitFailedException
      Description copied from interface: Editor
      Processes a changed child node. This method gets called for all child nodes that may contain changes between the before and after states.
      Specified by:
      childNodeChanged in interface Editor
      Parameters:
      name - name of the changed node
      before - child node before the change
      after - child node after the change
      Returns:
      an editor for processing the subtree below the added node, or null if the subtree does not need processing
      Throws:
      CommitFailedException - if processing failed

    • childNodeDeleted

      @Nullable public @Nullable Editor childNodeDeleted(String name, NodeState before) throws CommitFailedException
      Description copied from interface: Editor
      Processes a deleted child node.
      Specified by:
      childNodeDeleted in interface Editor
      Parameters:
      name - name of the deleted node
      before - the deleted child node
      Returns:
      an editor for processing the subtree below the removed node, or null if the subtree does not need processing
      Throws:
      CommitFailedException - if processing failed

    • commitProgress

      public void commitProgress(IndexCommitCallback.IndexProgress indexProgress)

    • withMissingProviderStrategy

      public IndexUpdate withMissingProviderStrategy(IndexUpdate.MissingIndexProviderStrategy missingProvider)