TextIndexingPreprocessorServices.TextExtractionResult

Enclosing interface:

TextIndexingPreprocessorServices
```
public 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
`int`	`getExtractionStatus()` Returns the extraction status supplied in a previous setResult call.
`java.lang.String`	`getLocale()` Returns the locale supplied in a previous setResult call.
`java.io.InputStream`	`getStream()` Returns the stream supplied in a previous setResult call.
`void`	`setResult(java.io.InputStream stream, int extractionStatus, java.lang.String locale)` Delivers the text extract produced by a preprocessor and/or a status indicating that extraction failed.

- Method Detail
  - setResult
```
void setResult(java.io.InputStream stream,
               int extractionStatus,
               java.lang.String locale)
```
    Delivers the text extract produced by a preprocessor and/or a status indicating that extraction failed. If the stream returned is over a temporary file created by the handler, the handler is responsible for overloading the close() method of the InputStream returned in order to delete that temporary file. (The framework will guarantee to always call close()). Similarly for any other type of resource the stream might depend on. A stream returned by the services getTextExtract method will honour these requirements.
    
    Parameters:
    
    stream - The stream of text-indexable data returned. In the case of getTextExtract this will always be plain text extracted from the specified content element. This field may be null if no useful indexable data could be produced.
    
    extractionStatus - An integer value indicating why a stream was not returned or qualifying the nature of the indexable data returned, for example that it may be incomplete for one of a number of possible reasons. The field is bitmask combining (via OR) any combination of the _AS_INT values of elements of the IndexingFailureCode enumerated type.
    
    locale - Specifies the language in which the indexable data is written, if this has been determined accurately, in the form of a standard locale string consisting of either a language code alone (eg: "en") or language plus country code (eg: "fr-ca"). If a value is returned, it will be passed to the text indexing service, causing it to bypass its normal language recognition logic and therefore potentially reducing indexing time. However, this should only be done if the language has been determined with certainty, since an incorrect value will disable some text search functionality (stemming and synonyms).
  - getStream
```
java.io.InputStream getStream()
```
    Returns the stream supplied in a previous setResult call.
  - getExtractionStatus
```
int getExtractionStatus()
```
    Returns the extraction status supplied in a previous setResult call.
  - getLocale
```
java.lang.String getLocale()
```
    Returns the locale supplied in a previous setResult call.

setResult

getStream

getExtractionStatus

getLocale