TextIndexingPreprocessorServices

```
public interface TextIndexingPreprocessorServices
```
Provides a set of utility methods for use by a text indexing preprocessor including the mechanism by which it delivers the output of preprocessing.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`TextIndexingPreprocessorServices.TextExtractionResult` This interface via which the results of preprocessing are delivered and by which the getTextExtract method returns results.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addFieldValue(java.lang.String fieldName, java.lang.String fieldValue, java.util.Map<java.lang.String,java.util.Set<java.lang.String>> fields)` Helper method for adding an indexable field to the collection to be returned by A preprocessor.
`TextIndexingPreprocessorServices.TextExtractionResult`	`getTextExtract(IndependentlyPersistableObject sourceObject, int elementSequenceNumber, java.util.Map<java.lang.String,java.util.Set<java.lang.String>> fields)` Executes standard text extraction for a specified content element of a source object, returning a stream of plain text which the calling handler can then use as needed as part of producing the extract stream that it returns.

- Method Detail
  - getTextExtract
```
TextIndexingPreprocessorServices.TextExtractionResult getTextExtract(IndependentlyPersistableObject sourceObject,
                                                                     int elementSequenceNumber,
                                                                     java.util.Map<java.lang.String,java.util.Set<java.lang.String>> fields)
```
    Executes standard text extraction for a specified content element of a source object, returning a stream of plain text which the calling handler can then use as needed as part of producing the extract stream that it returns.
    
    Parameters:
    
    sourceObject - The object from which text is to be extracted
    
    elementSequenceNumber - The sequence number for the content element of the source object from which text is to be extracted.
    
    fields - The indexable fields being built by the preprocessor.
    
    Returns:
    
    A TextExtractionResult object giving the result of the extraction operation.
  - addFieldValue
```
void addFieldValue(java.lang.String fieldName,
                   java.lang.String fieldValue,
                   java.util.Map<java.lang.String,java.util.Set<java.lang.String>> fields)
```
    Helper method for adding an indexable field to the collection to be returned by A preprocessor. It is permitted to directly manipulate the Map and contained Sets but it is recommended to use this method instead.
    
    Parameters:
    
    fieldName - The name of the indexable field
    
    fieldValue - The string value of the field.
    
    fields - The collection into which the field value should be added.

getTextExtract

addFieldValue