org.apache.lucene.index

Class IndexDeletionPolicy

    • Constructor Detail

      • IndexDeletionPolicy

        protected IndexDeletionPolicy()
        Sole constructor, typically called by sub-classes constructors.
    • Method Detail

      • onInit

        public abstract void onInit(List<? extends IndexCommit> commits)
                             throws IOException

        This is called once when a writer is first instantiated to give the policy a chance to remove old commit points.

        The writer locates all index commits present in the index directory and calls this method. The policy may choose to delete some of the commit points, doing so by calling method delete() of IndexCommit.

        Note: the last CommitPoint is the most recent one, i.e. the "front index state". Be careful not to delete it, unless you know for sure what you are doing, and unless you can afford to lose the index content while doing that.

        Parameters:
        commits - List of current point-in-time commits, sorted by age (the 0th one is the oldest commit). Note that for a new index this method is invoked with an empty list.
        Throws:
        IOException
      • onCommit

        public abstract void onCommit(List<? extends IndexCommit> commits)
                               throws IOException

        This is called each time the writer completed a commit. This gives the policy a chance to remove old commit points with each commit.

        The policy may now choose to delete old commit points by calling method delete() of IndexCommit.

        This method is only called when IndexWriter.commit() or IndexWriter.close() is called, or possibly not at all if the IndexWriter.rollback() is called.

        Note: the last CommitPoint is the most recent one, i.e. the "front index state". Be careful not to delete it, unless you know for sure what you are doing, and unless you can afford to lose the index content while doing that.

        Parameters:
        commits - List of IndexCommit, sorted by age (the 0th one is the oldest commit).
        Throws:
        IOException