Package org.elasticsearch.client.indices

Class AnalyzeRequest

java.lang.Object

org.elasticsearch.client.indices.AnalyzeRequest

All Implemented Interfaces:

Validatable, ToXContent, ToXContentObject

public class AnalyzeRequest
extends Object
implements Validatable, ToXContentObject

A request to analyze text

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AnalyzeRequest.CustomAnalyzerBuilder	Helper class to build custom analyzer definitions

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Fields inherited from interface org.elasticsearch.client.Validatable

EMPTY

Method Summary

Modifier and Type	Method	Description
String	analyzer()	Returns the named analyzer used for analysis, if defined
String[]	attributes()
AnalyzeRequest	attributes(String... attributes)
static AnalyzeRequest.CustomAnalyzerBuilder	buildCustomAnalyzer(String tokenizer)	Analyzes text using a custom analyzer built from global components
static AnalyzeRequest.CustomAnalyzerBuilder	buildCustomAnalyzer(String index, String tokenizer)	Analyzes text using a custom analyzer built from components defined on an index
static AnalyzeRequest.CustomAnalyzerBuilder	buildCustomAnalyzer(String index, Map<String,Object> tokenizerSettings)	Analyzes text using a custom analyzer built from components defined on an index
static AnalyzeRequest.CustomAnalyzerBuilder	buildCustomAnalyzer(Map<String,Object> tokenizerSettings)	Analyzes text using a custom analyzer built from global components
static AnalyzeRequest.CustomAnalyzerBuilder	buildCustomNormalizer()	Analyzes text using a custom normalizer built from global components
static AnalyzeRequest.CustomAnalyzerBuilder	buildCustomNormalizer(String index)	Analyzes text using a custom normalizer built from components defined on an index
List<org.elasticsearch.client.indices.AnalyzeRequest.NameOrDefinition>	charFilters()	Returns the custom character filters used for analysis, if defined
boolean	explain()
AnalyzeRequest	explain(boolean explain)	Set whether or not detailed explanations of analysis should be returned
String	field()	Returns the field to take an Analyzer from, if defined
String	index()	Returns the index that the request should be executed against, or null if no index is specified
String	normalizer()	Returns the named tokenizer used for analysis, if defined
String[]	text()	Returns the text to be analyzed
List<org.elasticsearch.client.indices.AnalyzeRequest.NameOrDefinition>	tokenFilters()	Returns the custom token filters used for analysis, if defined
org.elasticsearch.client.indices.AnalyzeRequest.NameOrDefinition	tokenizer()	Returns a custom Tokenizer used for analysis, if defined
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
static AnalyzeRequest	withField(String index, String field, String... text)	Analyzes text using the analyzer defined on a specific field within an index
static AnalyzeRequest	withGlobalAnalyzer(String analyzer, String... text)	Analyzes text using a global analyzer
static AnalyzeRequest	withIndexAnalyzer(String index, String analyzer, String... text)	Analyzes text using a named analyzer on an index
static AnalyzeRequest	withNormalizer(String index, String normalizer, String... text)	Analyzes text using a named normalizer on an index

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Methods inherited from interface org.elasticsearch.client.Validatable

validate

Method Detail

withGlobalAnalyzer

public static AnalyzeRequest withGlobalAnalyzer(String analyzer,
                                                String... text)

Analyzes text using a global analyzer

buildCustomAnalyzer

public static AnalyzeRequest.CustomAnalyzerBuilder buildCustomAnalyzer(String tokenizer)

Analyzes text using a custom analyzer built from global components

buildCustomAnalyzer

public static AnalyzeRequest.CustomAnalyzerBuilder buildCustomAnalyzer(Map<String,Object> tokenizerSettings)

Analyzes text using a custom analyzer built from global components

buildCustomAnalyzer

public static AnalyzeRequest.CustomAnalyzerBuilder buildCustomAnalyzer(String index,
                                                                       String tokenizer)

Analyzes text using a custom analyzer built from components defined on an index

buildCustomAnalyzer

public static AnalyzeRequest.CustomAnalyzerBuilder buildCustomAnalyzer(String index,
                                                                       Map<String,Object> tokenizerSettings)

Analyzes text using a custom analyzer built from components defined on an index

withIndexAnalyzer

public static AnalyzeRequest withIndexAnalyzer(String index,
                                               String analyzer,
                                               String... text)

Analyzes text using a named analyzer on an index

withField

public static AnalyzeRequest withField(String index,
                                       String field,
                                       String... text)

Analyzes text using the analyzer defined on a specific field within an index

withNormalizer

public static AnalyzeRequest withNormalizer(String index,
                                            String normalizer,
                                            String... text)

Analyzes text using a named normalizer on an index

buildCustomNormalizer

public static AnalyzeRequest.CustomAnalyzerBuilder buildCustomNormalizer()

Analyzes text using a custom normalizer built from global components

buildCustomNormalizer

public static AnalyzeRequest.CustomAnalyzerBuilder buildCustomNormalizer(String index)

Analyzes text using a custom normalizer built from components defined on an index

index

public String index()

Returns the index that the request should be executed against, or null if no index is specified

text

public String[] text()

Returns the text to be analyzed

analyzer

public String analyzer()

Returns the named analyzer used for analysis, if defined

normalizer

public String normalizer()

Returns the named tokenizer used for analysis, if defined

tokenizer

public org.elasticsearch.client.indices.AnalyzeRequest.NameOrDefinition tokenizer()

Returns a custom Tokenizer used for analysis, if defined

tokenFilters

public List<org.elasticsearch.client.indices.AnalyzeRequest.NameOrDefinition> tokenFilters()

Returns the custom token filters used for analysis, if defined

charFilters

public List<org.elasticsearch.client.indices.AnalyzeRequest.NameOrDefinition> charFilters()

Returns the custom character filters used for analysis, if defined

field

public String field()

Returns the field to take an Analyzer from, if defined

explain

public AnalyzeRequest explain(boolean explain)

Set whether or not detailed explanations of analysis should be returned

explain

public boolean explain()

attributes

public AnalyzeRequest attributes(String... attributes)

attributes

public String[] attributes()

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException