public abstract class

PayloadProcessorProvider

extends Object
java.lang.Object
   ↳ org.apache.lucene.index.PayloadProcessorProvider

Class Overview

Provides a PayloadProcessorProvider.DirPayloadProcessor to be used for a Directory. This allows using different PayloadProcessorProvider.DirPayloadProcessors for different directories, for e.g. to perform different processing of payloads of different directories.

NOTE: to avoid processing payloads of certain directories, you can return null in getDirProcessor(Directory).

NOTE: it is possible that the same PayloadProcessorProvider.DirPayloadProcessor will be requested for the same Directory concurrently. Therefore, to avoid concurrency issues you should return different instances for different threads. Usually, if your PayloadProcessorProvider.DirPayloadProcessor does not maintain state this is not a problem. The merge code ensures that the PayloadProcessorProvider.DirPayloadProcessor instance you return will be accessed by one thread to obtain the PayloadProcessorProvider.PayloadProcessors for different terms.

Summary

Nested Classes
class PayloadProcessorProvider.DirPayloadProcessor Returns a PayloadProcessorProvider.DirPayloadProcessor for a given Term which allows processing the payloads of different terms differently. 
class PayloadProcessorProvider.PayloadProcessor Processes the given payload. 
Public Constructors
PayloadProcessorProvider()
Public Methods
abstract PayloadProcessorProvider.DirPayloadProcessor getDirProcessor(Directory dir)
Returns a PayloadProcessorProvider.DirPayloadProcessor for the given Directory, through which PayloadProcessorProvider.PayloadProcessors can be obtained for each Term, or null if none should be used.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public PayloadProcessorProvider ()

Public Methods

public abstract PayloadProcessorProvider.DirPayloadProcessor getDirProcessor (Directory dir)

Returns a PayloadProcessorProvider.DirPayloadProcessor for the given Directory, through which PayloadProcessorProvider.PayloadProcessors can be obtained for each Term, or null if none should be used.

Throws
IOException