com.lucidworks.search.dsl.request

Class Highlight

java.lang.Object

com.lucidworks.search.dsl.DslBase

com.lucidworks.search.dsl.request.DslCloneable

com.lucidworks.search.dsl.request.Highlight

public class Highlight
extends DslCloneable

Specifies how matching document fragments ("highlights") are calculated and incorporated into the returned results.

Constructor Summary

Constructors

Constructor and Description
Highlight(Collection<String> fields, String pre, String post, Integer length, Integer count, Boolean defaultHighlight)

Method Summary

Modifier and Type	Method and Description
Highlight	clone()
Integer	getCount()
Boolean	getDefaultHighlight()
Collection<String>	getFields()
Integer	getLength()
String	getPost()
String	getPre()
void	setCount(Integer count)
void	setDefaultHighlight(Boolean defaultHighlight)
void	setFields(Collection<String> fields)
void	setLength(Integer length)
void	setPost(String post)
void	setPre(String pre)

Methods inherited from class com.lucidworks.search.dsl.request.DslCloneable

clone, deepClone

Methods inherited from class com.lucidworks.search.dsl.DslBase

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Highlight

public Highlight(Collection<String> fields,
                 String pre,
                 String post,
                 Integer length,
                 Integer count,
                 Boolean defaultHighlight)

Method Detail

getFields

public Collection<String> getFields()

Returns:

the fields to consider for highlighting. Wildcard-based values ("*", "text_lang_*", etc.) are allowed but should be used carefully to avoid impacting performance.

setFields

public void setFields(Collection<String> fields)

getLength

public Integer getLength()

Returns:

the target size for highlight fragments, in characters. "0" is treated as a flag value to indicate that the entire field value should be used as the fragment. Defaults to "100" if not specified.

setLength

public void setLength(Integer length)

getCount

public Integer getCount()

Returns:

the number of highlight fragments to attempt to generate per field. Defaults to 1.

setCount

public void setCount(Integer count)

getDefaultHighlight

public Boolean getDefaultHighlight()

Returns:

whether or not a default highlight fragment should be included where none could be generated. Defaults to false.

setDefaultHighlight

public void setDefaultHighlight(Boolean defaultHighlight)

getPre

public String getPre()

Returns:

the text that will be prepended to each highlighted fragment. Typically a HTML or XML opening tag, though any string may be used. Defaults to <em>

setPre

public void setPre(String pre)

getPost

public String getPost()

Returns:

the text that will be appended to each highlighted fragment. Typically a HTML or XML closing tag, though any string may be used. Defaults to </em>

setPost

public void setPost(String post)

clone

public Highlight clone()

Specified by:

clone in class DslCloneable