org.springframework.data.solr.core.query

Class HighlightOptions.FieldWithHighlightParameters

java.lang.Object

org.springframework.data.solr.core.query.SimpleField

org.springframework.data.solr.core.query.FieldWithQueryParameters<HighlightOptions.HighlightParameter>

org.springframework.data.solr.core.query.HighlightOptions.FieldWithHighlightParameters

All Implemented Interfaces:

Iterable<HighlightOptions.HighlightParameter>, Field

Enclosing class:

HighlightOptions

public static class HighlightOptions.FieldWithHighlightParameters
extends FieldWithQueryParameters<HighlightOptions.HighlightParameter>

Field with hightlight query parameters

Author:

Christoph Strobl

Constructor Summary

Constructors

Constructor and Description
FieldWithHighlightParameters(String fieldname)

Method Summary

Modifier and Type	Method and Description
HighlightOptions.FieldWithHighlightParameters	addHighlightParameter(HighlightOptions.HighlightParameter parameter) Add field specific highlight parameter
HighlightOptions.FieldWithHighlightParameters	addHighlightParameter(String parameterName, Object value) Add field specific parameter by name
String	getFormatter()
Integer	getFragsize()
Integer	getNrSnipplets()
Boolean	isMergeContigous()
HighlightOptions.FieldWithHighlightParameters	setFormatter(String formatter) set fragsize {@code f.
HighlightOptions.FieldWithHighlightParameters	setFragsize(Integer fragsize) set fragsize {@code f.
HighlightOptions.FieldWithHighlightParameters	setMergeContigous(Boolean mergeContigous) set fragsize {@code f.
HighlightOptions.FieldWithHighlightParameters	setNrSnipplets(Integer nrSnipplets) set fragsize hl.fragsize.

Methods inherited from class org.springframework.data.solr.core.query.FieldWithQueryParameters

addQueryParameter, getQueryParameter, getQueryParameters, getQueryParameterValue, hasQueryParameters, iterator, removeQueryParameter

Methods inherited from class org.springframework.data.solr.core.query.SimpleField

equals, getName, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

FieldWithHighlightParameters

public FieldWithHighlightParameters(String fieldname)

Parameters:

fieldname - must not be null/blank

Method Detail

getNrSnipplets

@Nullable
public Integer getNrSnipplets()

Returns:

null if not set

setNrSnipplets

public HighlightOptions.FieldWithHighlightParameters setNrSnipplets(Integer nrSnipplets)

set fragsize hl.fragsize.

getFragsize

@Nullable
public Integer getFragsize()

Returns:

null if not set

setFragsize

public HighlightOptions.FieldWithHighlightParameters setFragsize(Integer fragsize)

set fragsize f.<fieldname>.hl.fragsize.

Parameters:

fragsize -

isMergeContigous

@Nullable
public Boolean isMergeContigous()

Returns:

null if not set

setMergeContigous

public HighlightOptions.FieldWithHighlightParameters setMergeContigous(Boolean mergeContigous)

set fragsize f.<fieldname>.hl.fragsize.

getFormatter

@Nullable
public String getFormatter()

Returns:

null if not set

setFormatter

public HighlightOptions.FieldWithHighlightParameters setFormatter(String formatter)

set fragsize f.<formatter>.hl.fragsize.

addHighlightParameter

public HighlightOptions.FieldWithHighlightParameters addHighlightParameter(String parameterName,
                                                                           Object value)

Add field specific parameter by name

Parameters:

parameterName -

value -

addHighlightParameter

public HighlightOptions.FieldWithHighlightParameters addHighlightParameter(HighlightOptions.HighlightParameter parameter)

Add field specific highlight parameter

Parameters:

parameter -

Returns: