SMILA (incubation) API documentation

org.eclipse.smila.solr.util
Class HighlightingQueryConfigAdapter

java.lang.Object
  extended by org.eclipse.smila.solr.util.HighlightingQueryConfigAdapter

public class HighlightingQueryConfigAdapter
extends java.lang.Object

HighlightingQueryConfigAdapter class.

Author:
pwissel

Nested Class Summary
static class HighlightingQueryConfigAdapter.HighlightingFragmenter
          HighlightingFragmenter enum.
static class HighlightingQueryConfigAdapter.HighlightingType
          HighlightingType enum.
 
Constructor Summary
HighlightingQueryConfigAdapter()
          Default Constructor.
HighlightingQueryConfigAdapter(java.lang.String field)
          Constructor per field.
 
Method Summary
 AnyMap getAnyMap()
          Get the underlying any map.
 HighlightingQueryConfigAdapter setHighlightingAlternateField(java.lang.String value)
          Set hl.alternateField parameter.
 HighlightingQueryConfigAdapter setHighlightingAlternateFieldLength(int value)
          Set hl.maxAlternateFieldLength parameter.
 HighlightingQueryConfigAdapter setHighlightingFields(java.lang.String... values)
          Set hl.fl parameter.
 HighlightingQueryConfigAdapter setHighlightingFragmenter(HighlightingQueryConfigAdapter.HighlightingFragmenter fragmenter)
          Set hl.fragmenter parameter.
 HighlightingQueryConfigAdapter setHighlightingFragmenter(java.lang.String fragmenter)
          Set hl.fragmenter parameter.
 HighlightingQueryConfigAdapter setHighlightingFragsize(int value)
          Set hl.fragsize parameter.
 HighlightingQueryConfigAdapter setHighlightingMaxAnalyzedChars(int value)
          Set hl.maxAnalyzedChars parameter.
 HighlightingQueryConfigAdapter setHighlightingMergeContiguous(java.lang.Boolean value)
          Set hl.mergeContiguous parameter.
 HighlightingQueryConfigAdapter setHighlightingMultiTerm(java.lang.Boolean value)
          Set hl.highlinghtMultiTerm parameter.
 HighlightingQueryConfigAdapter setHighlightingRegexMaxAnalysedChars(int value)
          Set hl.regexMaxAnalysedChars parameter.
 HighlightingQueryConfigAdapter setHighlightingRegexPattern(java.lang.String value)
          Set hl.regex.pattern parameter.
 HighlightingQueryConfigAdapter setHighlightingRegexSlop(java.lang.Double value)
          Set hl.regex.slop parameter.
 HighlightingQueryConfigAdapter setHighlightingRequireFieldMatch(java.lang.Boolean value)
          Set hl.requireFieldMatch parameter.
 HighlightingQueryConfigAdapter setHighlightingSimplePost(java.lang.String value)
          Set hl.simple.post parameter.
 HighlightingQueryConfigAdapter setHighlightingSimplePre(java.lang.String value)
          Set hl.simple.pre parameter.
 HighlightingQueryConfigAdapter setHighlightingSnippets(int value)
          Set hl.snippets parameter.
 HighlightingQueryConfigAdapter setHighlightingUsePhraseHighlighter(java.lang.Boolean value)
          Set hl.usePhraseHighlighter parameter.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HighlightingQueryConfigAdapter

public HighlightingQueryConfigAdapter()
Default Constructor.


HighlightingQueryConfigAdapter

public HighlightingQueryConfigAdapter(java.lang.String field)
Constructor per field.

Parameters:
field - the field.
Method Detail

getAnyMap

public AnyMap getAnyMap()
Get the underlying any map.

Returns:
the map.

setHighlightingFields

public HighlightingQueryConfigAdapter setHighlightingFields(java.lang.String... values)
Set hl.fl parameter.

Parameters:
values - the values.
Returns:
HighlightingQueryConfigAdapter.

setHighlightingSnippets

public HighlightingQueryConfigAdapter setHighlightingSnippets(int value)
Set hl.snippets parameter.

Parameters:
value - the value.
Returns:
HighlightingQueryConfigAdapter.

setHighlightingFragsize

public HighlightingQueryConfigAdapter setHighlightingFragsize(int value)
Set hl.fragsize parameter.

Parameters:
value - the value.
Returns:
HighlightingQueryConfigAdapter.

setHighlightingMergeContiguous

public HighlightingQueryConfigAdapter setHighlightingMergeContiguous(java.lang.Boolean value)
Set hl.mergeContiguous parameter.

Parameters:
value - the value.
Returns:
HighlightingQueryConfigAdapter.

setHighlightingRequireFieldMatch

public HighlightingQueryConfigAdapter setHighlightingRequireFieldMatch(java.lang.Boolean value)
Set hl.requireFieldMatch parameter.

Parameters:
value - the value.
Returns:
HighlightingQueryConfigAdapter.

setHighlightingMaxAnalyzedChars

public HighlightingQueryConfigAdapter setHighlightingMaxAnalyzedChars(int value)
Set hl.maxAnalyzedChars parameter.

Parameters:
value - the value.
Returns:
HighlightingQueryConfigAdapter.

setHighlightingAlternateField

public HighlightingQueryConfigAdapter setHighlightingAlternateField(java.lang.String value)
Set hl.alternateField parameter.

Parameters:
value - the value.
Returns:
HighlightingQueryConfigAdapter.

setHighlightingAlternateFieldLength

public HighlightingQueryConfigAdapter setHighlightingAlternateFieldLength(int value)
Set hl.maxAlternateFieldLength parameter.

Parameters:
value - the value.
Returns:
HighlightingQueryConfigAdapter.

setHighlightingSimplePre

public HighlightingQueryConfigAdapter setHighlightingSimplePre(java.lang.String value)
Set hl.simple.pre parameter.

Parameters:
value - the value.
Returns:
HighlightingQueryConfigAdapter.

setHighlightingSimplePost

public HighlightingQueryConfigAdapter setHighlightingSimplePost(java.lang.String value)
Set hl.simple.post parameter.

Parameters:
value - the value.
Returns:
HighlightingQueryConfigAdapter.

setHighlightingFragmenter

public HighlightingQueryConfigAdapter setHighlightingFragmenter(HighlightingQueryConfigAdapter.HighlightingFragmenter fragmenter)
Set hl.fragmenter parameter.

Parameters:
fragmenter - the fragmenter.
Returns:
HighlightingQueryConfigAdapter.

setHighlightingFragmenter

public HighlightingQueryConfigAdapter setHighlightingFragmenter(java.lang.String fragmenter)
Set hl.fragmenter parameter.

Parameters:
fragmenter - the fragmenter name.
Returns:
HighlightingQueryConfigAdapter.

setHighlightingUsePhraseHighlighter

public HighlightingQueryConfigAdapter setHighlightingUsePhraseHighlighter(java.lang.Boolean value)
Set hl.usePhraseHighlighter parameter.

Parameters:
value - the value.
Returns:
HighlightingQueryConfigAdapter.

setHighlightingMultiTerm

public HighlightingQueryConfigAdapter setHighlightingMultiTerm(java.lang.Boolean value)
Set hl.highlinghtMultiTerm parameter.

Parameters:
value - the value.
Returns:
HighlightingQueryConfigAdapter.

setHighlightingRegexSlop

public HighlightingQueryConfigAdapter setHighlightingRegexSlop(java.lang.Double value)
Set hl.regex.slop parameter.

Parameters:
value - the value.
Returns:
HighlightingQueryConfigAdapter.

setHighlightingRegexPattern

public HighlightingQueryConfigAdapter setHighlightingRegexPattern(java.lang.String value)
Set hl.regex.pattern parameter.

Parameters:
value - the value.
Returns:
HighlightingQueryConfigAdapter.

setHighlightingRegexMaxAnalysedChars

public HighlightingQueryConfigAdapter setHighlightingRegexMaxAnalysedChars(int value)
Set hl.regexMaxAnalysedChars parameter.

Parameters:
value - teh value.
Returns:
HighlightingQueryConfigAdapter.

SMILA (incubation) API documentation