Package org.opensearch.search.pipeline.common

Class SplitResponseProcessor

java.lang.Object

org.opensearch.search.pipeline.AbstractProcessor

org.opensearch.search.pipeline.common.SplitResponseProcessor

All Implemented Interfaces:

Processor, SearchResponseProcessor

public class SplitResponseProcessor
extends AbstractProcessor
implements SearchResponseProcessor

Processor that sorts an array of items. Throws exception is the specified field is not an array.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.search.pipeline.Processor

Processor.PipelineContext, Processor.PipelineSource

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRESERVE_TRAILING	Optional key for handling empty trailing fields.
static final String	SEPARATOR	Key defining the delimiter used to split the string.
static final String	SPLIT_FIELD	Key defining the string field to be split.
static final String	TARGET_FIELD	Optional key to put the split values in a different field.
static final String	TYPE	Key to reference this processor type from a search pipeline.

Method Summary

Modifier and Type	Method	Description
String	getSeparator()	Getter function for separator
String	getSplitField()	Getter function for splitField
String	getTargetField()	Getter function for targetField
String	getType()
boolean	isPreserveTrailing()	Getter function for preserveTrailing
SearchResponse	processResponse(SearchRequest request, SearchResponse response)

Methods inherited from class org.opensearch.search.pipeline.AbstractProcessor

getDescription, getTag, isIgnoreFailure

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.search.pipeline.Processor

getDescription, getTag, isIgnoreFailure

Methods inherited from interface org.opensearch.search.pipeline.SearchResponseProcessor

processResponse, processResponseAsync

Field Details

TYPE

public static final String TYPE

Key to reference this processor type from a search pipeline.

See Also:

• Constant Field Values

SPLIT_FIELD

public static final String SPLIT_FIELD

Key defining the string field to be split.

See Also:

• Constant Field Values

SEPARATOR

public static final String SEPARATOR

Key defining the delimiter used to split the string. This can be a regular expression pattern.

See Also:

• Constant Field Values

PRESERVE_TRAILING

public static final String PRESERVE_TRAILING

Optional key for handling empty trailing fields.

See Also:

• Constant Field Values

TARGET_FIELD

public static final String TARGET_FIELD

Optional key to put the split values in a different field.

See Also:

• Constant Field Values

Method Details

getSplitField

public String getSplitField()

Getter function for splitField

Returns:

sortField

getSeparator

public String getSeparator()

Getter function for separator

Returns:

separator

isPreserveTrailing

public boolean isPreserveTrailing()

Getter function for preserveTrailing

Returns:

preserveTrailing;

getTargetField

public String getTargetField()

Getter function for targetField

Returns:

targetField

getType

public String getType()

Specified by:

getType in interface Processor

processResponse

public SearchResponse processResponse(SearchRequest request,
 SearchResponse response)
                               throws Exception

Specified by:

processResponse in interface SearchResponseProcessor

Throws:

Exception