TextIndexingPreprocessor

```
public interface TextIndexingPreprocessor
```
An interface to be implemented as a text indexing preprocessor handler that runs on the server. A text indexing preprocessor handler is referenced by a CmTextIndexingPreprocessorAction object. A CmTextIndexingPreprocessorAction object is set on a CmTextIndexingPreprocessorDefinition object, which is associated with a class definition. When an instance of the class is full text indexed, the text indexing preprocessor handler is invoked.
You can implement a text indexing preprocessor handler as a Java or JavaScript component. You can check in a Java text indexing preprocessor as a CodeModule object, or you can specify a Java text indexing preprocessor in the classpath of the application server where the Content Engine is running.

See Also:

Text Indexing Preprocessor Concepts

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`getOutputContentType()` Returns the content type (MIME type) of the text extract this preprocessor produces for the objects that it preprocesses.
`boolean`	`preprocess(CmTextIndexingPreprocessorAction action, TextIndexingPreprocessorServices services, IndependentlyPersistableObject sourceObject, java.util.Map<java.lang.String,java.util.Set<java.lang.String>> fields, TextIndexingPreprocessorServices.TextExtractionResult result)` Preprocesses a specified object that is being full text indexed.

- Method Detail
  - getOutputContentType
```
java.lang.String getOutputContentType()
```
    Returns the content type (MIME type) of the text extract this preprocessor produces for the objects that it preprocesses. All handlers should return "text/plain".
  - preprocess
```
boolean preprocess(CmTextIndexingPreprocessorAction action,
                   TextIndexingPreprocessorServices services,
                   IndependentlyPersistableObject sourceObject,
                   java.util.Map<java.lang.String,java.util.Set<java.lang.String>> fields,
                   TextIndexingPreprocessorServices.TextExtractionResult result)
```
    Preprocesses a specified object that is being full text indexed. The handler can provide a text extract and additional fields for indexing. The handler can decline to preprocess the object in which case it will be passed to any other preprocessors defined for the class or will be full text indexed in the normal way.
    
    Parameters:
    
    action - The CmTextIndexingPreprocessorAction object defining the handler.
    
    services - An implementation of the TextIndexingPreprocessorServices interface providing utility functions for use by the preprocessor.
    
    sourceObject - The object to preprocess
    
    fields - The fields to be indexed. This will be pre-populated with entries for all the CBR-enabled properties of the source object and can be extended by the handler.
    
    result - The object through which the handler can report success or failure of the operation.
    
    Returns:
    
    True if the handler preprocessed the object, false if it declined to do so.

getOutputContentType

preprocess