Package co.elasticsearch.enterprisesearch.client.model.request.search

Class ResultField

java.lang.Object

co.elasticsearch.enterprisesearch.client.model.request.search.ResultField

public class ResultField
extends Object

Represents a field in a search results document

Constructor Summary

Constructors

Constructor	Description
ResultField()	Create a blank result field
ResultField(String name)	Create a result field with the given name

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getName()	The name of the field
int	hashCode()
ResultField	setName(String name)	The name of the field
ResultField	setRaw(co.elasticsearch.enterprisesearch.client.model.request.search.ResultFieldRendered raw)	An exact representation of the value within a field.
ResultField	setSnippet(co.elasticsearch.enterprisesearch.client.model.request.search.ResultFieldRendered snippet)	A snippet is an HTML escaped representation of the value within a field, where query matches are captured in <em> tags.
ResultField	withoutRaw()	Disable the return of the raw representation of this field
ResultField	withoutSnippet()	Disable the return of the snippet representation of this field
ResultField	withRaw()	Enable the return of the raw representation of this field
ResultField	withRaw(int size)	Enable the return of the raw representation of this field, with the given field size max
ResultField	withSnippet()	Enable the return of the snippet representation of this field
ResultField	withSnippet(int size)	Enable the return of the snippet representation of this field, with the given max length
ResultField	withSnippet(int size, Boolean fallback)	Enable the return of the snippet representation of this field, with given max length, and fallback field config
ResultField	withSnippet(Boolean fallback)	Enable the return of the snippet representation of this field, with fallback field config

Methods inherited from class java.lang.Object

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

Constructor Detail

ResultField

public ResultField()

Create a blank result field

ResultField

public ResultField(String name)

Create a result field with the given name

Parameters:

name - the field name

Method Detail

withRaw

public ResultField withRaw()

Enable the return of the raw representation of this field

Returns:

this field

withRaw

public ResultField withRaw(int size)

Enable the return of the raw representation of this field, with the given field size max

Parameters:

size - the maximum number of characters to return

Returns:

this field

withoutRaw

public ResultField withoutRaw()

Disable the return of the raw representation of this field

Returns:

this field

withSnippet

public ResultField withSnippet()

Enable the return of the snippet representation of this field

Returns:

this field

withSnippet

public ResultField withSnippet(int size)

Enable the return of the snippet representation of this field, with the given max length

Parameters:

size - Character length of the snippet returned. Must be at least 20; defaults to 100.

Returns:

this field

withSnippet

public ResultField withSnippet(int size,
                               Boolean fallback)

Enable the return of the snippet representation of this field, with given max length, and fallback field config

Parameters:

size - Character length of the snippet returned. Must be at least 20; defaults to 100.

fallback - If true, return the raw text field if no snippet is found. If false, only use snippets.

Returns:

this field

withSnippet

public ResultField withSnippet(Boolean fallback)

Enable the return of the snippet representation of this field, with fallback field config

Parameters:

fallback - If true, return the raw text field if no snippet is found. If false, only use snippets.

Returns:

this field

withoutSnippet

public ResultField withoutSnippet()

Disable the return of the snippet representation of this field

Returns:

this field

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getName

public String getName()

The name of the field

Returns:

the field name

setName

public ResultField setName(String name)

The name of the field

Parameters:

name - the field name

Returns:

this.

setRaw

public ResultField setRaw(co.elasticsearch.enterprisesearch.client.model.request.search.ResultFieldRendered raw)

An exact representation of the value within a field. And it is exact! It is not HTML escaped.

Parameters:

raw - The raw field

Returns:

this.

setSnippet

public ResultField setSnippet(co.elasticsearch.enterprisesearch.client.model.request.search.ResultFieldRendered snippet)

A snippet is an HTML escaped representation of the value within a field, where query matches are captured in <em> tags.

Parameters:

snippet - The snippet field

Returns:

this.