Spring Data Solr

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

java.lang.Object
  extended by org.springframework.data.solr.core.query.SimpleField
      extended by org.springframework.data.solr.core.query.FieldWithQueryParameters<HighlightOptions.HighlightParameter>
          extended by 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
HighlightOptions.FieldWithHighlightParameters(String fieldname)
           
 
Method Summary
 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
getName, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

HighlightOptions.FieldWithHighlightParameters

public HighlightOptions.FieldWithHighlightParameters(String fieldname)
Parameters:
fieldname - must not be null/blank
Method Detail

getNrSnipplets

public Integer getNrSnipplets()
Returns:
null if not set

setNrSnipplets

public HighlightOptions.FieldWithHighlightParameters setNrSnipplets(Integer nrSnipplets)
set fragsize hl.fragsize.

Parameters:
fragsize -

getFragsize

public Integer getFragsize()
Returns:
null if not set

setFragsize

public HighlightOptions.FieldWithHighlightParameters setFragsize(Integer fragsize)
set fragsize f.&lt;fieldname&gt;.hl.fragsize.

Parameters:
fragsize -

isMergeContigous

public Boolean isMergeContigous()
Returns:
null if not set

setMergeContigous

public HighlightOptions.FieldWithHighlightParameters setMergeContigous(Boolean mergeContigous)
set fragsize f.&lt;fieldname&gt;.hl.fragsize.

Parameters:
fragsize -

getFormatter

public String getFormatter()
Returns:
null if not set

setFormatter

public HighlightOptions.FieldWithHighlightParameters setFormatter(String formatter)
set fragsize f.&lt;formatter&gt;.hl.fragsize.

Parameters:
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:

Spring Data Solr

Copyright © 2011-2014-2014 Pivotal. All Rights Reserved.