org.apache.lucene.index
Class UpgradeIndexMergePolicy

java.lang.Object
  extended by org.apache.lucene.index.MergePolicy
      extended by org.apache.lucene.index.UpgradeIndexMergePolicy
All Implemented Interfaces:
Closeable

public class UpgradeIndexMergePolicy
extends MergePolicy

This MergePolicy is used for upgrading all existing segments of an index when calling IndexWriter.optimize(). All other methods delegate to the base MergePolicy given to the constructor. This allows for an as-cheap-as possible upgrade of an older index by only upgrading segments that are created by previous Lucene versions. Optimize does no longer really optimize it is just used to "optimize" older segment versions away.

In general one would use IndexUpgrader, but for a fully customizeable upgrade, you can use this like any other MergePolicy and call IndexWriter.optimize():

  IndexWriterConfig iwc = new IndexWriterConfig(Version.LUCENE_XX, new KeywordAnalyzer());
  iwc.setMergePolicy(new UpgradeIndexMergePolicy(iwc.getMergePolicy()));
  IndexWriter w = new IndexWriter(dir, iwc);
  w.optimize();
  w.close();
 

Warning: This merge policy may reorder documents if the index was partially upgraded before calling optimize (e.g., documents were added). If your application relies on "monotonicity" of doc IDs (which means that the order in which the documents were added to the index is preserved), do a full optimize instead. Please note, the delegate MergePolicy may also reorder documents.

See Also:
IndexUpgrader
WARNING: This API is experimental and might change in incompatible ways in the next release.

Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.lucene.index.MergePolicy
MergePolicy.MergeAbortedException, MergePolicy.MergeException, MergePolicy.MergeSpecification, MergePolicy.OneMerge
 
Field Summary
protected  MergePolicy base
           
 
Fields inherited from class org.apache.lucene.index.MergePolicy
writer
 
Constructor Summary
UpgradeIndexMergePolicy(MergePolicy base)
          Wrap the given MergePolicy and intercept optimize requests to only upgrade segments written with previous Lucene versions.
 
Method Summary
 void close()
          Release all resources for the policy.
 MergePolicy.MergeSpecification findMerges(SegmentInfos segmentInfos)
          Determine what set of merge operations are now necessary on the index.
 MergePolicy.MergeSpecification findMergesForOptimize(SegmentInfos segmentInfos, int maxSegmentCount, Map<SegmentInfo,Boolean> segmentsToOptimize)
          Determine what set of merge operations is necessary in order to optimize the index.
 MergePolicy.MergeSpecification findMergesToExpungeDeletes(SegmentInfos segmentInfos)
          Determine what set of merge operations is necessary in order to expunge all deletes from the index.
 void setIndexWriter(IndexWriter writer)
          Sets the IndexWriter to use by this merge policy.
protected  boolean shouldUpgradeSegment(SegmentInfo si)
          Returns if the given segment should be upgraded.
 String toString()
           
 boolean useCompoundFile(SegmentInfos segments, SegmentInfo newSegment)
          Returns true if a new segment (regardless of its origin) should use the compound file format.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

base

protected final MergePolicy base
Constructor Detail

UpgradeIndexMergePolicy

public UpgradeIndexMergePolicy(MergePolicy base)
Wrap the given MergePolicy and intercept optimize requests to only upgrade segments written with previous Lucene versions.

Method Detail

shouldUpgradeSegment

protected boolean shouldUpgradeSegment(SegmentInfo si)
Returns if the given segment should be upgraded. The default implementation will return !Constants.LUCENE_MAIN_VERSION.equals(si.getVersion()), so all segments created with a different version number than this Lucene version will get upgraded.


setIndexWriter

public void setIndexWriter(IndexWriter writer)
Description copied from class: MergePolicy
Sets the IndexWriter to use by this merge policy. This method is allowed to be called only once, and is usually set by IndexWriter. If it is called more than once, SetOnce.AlreadySetException is thrown.

Overrides:
setIndexWriter in class MergePolicy
See Also:
SetOnce

findMerges

public MergePolicy.MergeSpecification findMerges(SegmentInfos segmentInfos)
                                          throws CorruptIndexException,
                                                 IOException
Description copied from class: MergePolicy
Determine what set of merge operations are now necessary on the index. IndexWriter calls this whenever there is a change to the segments. This call is always synchronized on the IndexWriter instance so only one thread at a time will call this method.

Specified by:
findMerges in class MergePolicy
Parameters:
segmentInfos - the total set of segments in the index
Throws:
CorruptIndexException
IOException

findMergesForOptimize

public MergePolicy.MergeSpecification findMergesForOptimize(SegmentInfos segmentInfos,
                                                            int maxSegmentCount,
                                                            Map<SegmentInfo,Boolean> segmentsToOptimize)
                                                     throws CorruptIndexException,
                                                            IOException
Description copied from class: MergePolicy
Determine what set of merge operations is necessary in order to optimize the index. IndexWriter calls this when its IndexWriter.optimize() method is called. This call is always synchronized on the IndexWriter instance so only one thread at a time will call this method.

Specified by:
findMergesForOptimize in class MergePolicy
Parameters:
segmentInfos - the total set of segments in the index
maxSegmentCount - requested maximum number of segments in the index (currently this is always 1)
segmentsToOptimize - contains the specific SegmentInfo instances that must be merged away. This may be a subset of all SegmentInfos. If the value is True for a given SegmentInfo, that means this segment was an original segment present in the to-be-optimized index; else, it was a segment produced by a cascaded merge.
Throws:
CorruptIndexException
IOException

findMergesToExpungeDeletes

public MergePolicy.MergeSpecification findMergesToExpungeDeletes(SegmentInfos segmentInfos)
                                                          throws CorruptIndexException,
                                                                 IOException
Description copied from class: MergePolicy
Determine what set of merge operations is necessary in order to expunge all deletes from the index.

Specified by:
findMergesToExpungeDeletes in class MergePolicy
Parameters:
segmentInfos - the total set of segments in the index
Throws:
CorruptIndexException
IOException

useCompoundFile

public boolean useCompoundFile(SegmentInfos segments,
                               SegmentInfo newSegment)
                        throws IOException
Description copied from class: MergePolicy
Returns true if a new segment (regardless of its origin) should use the compound file format.

Specified by:
useCompoundFile in class MergePolicy
Throws:
IOException

close

public void close()
Description copied from class: MergePolicy
Release all resources for the policy.

Specified by:
close in interface Closeable
Specified by:
close in class MergePolicy

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.