Package org.opencms.jsp.search.config

Class CmsSearchConfigurationHighlighting

java.lang.Object

org.opencms.jsp.search.config.CmsSearchConfigurationHighlighting

All Implemented Interfaces:

I_CmsSearchConfigurationHighlighting

public class CmsSearchConfigurationHighlighting
extends Object
implements I_CmsSearchConfigurationHighlighting

Search configuration for highlighting options.

Constructor Summary

Constructors

Constructor	Description
CmsSearchConfigurationHighlighting(String field, Integer snippetCount, Integer fragSize, String alternateField, Integer maxAlternateFieldLength, String pre, String post, String formatter, String fragmenter, Boolean useFastVectorHighlighting)	The constructor setting all configuration values.

Method Summary

Modifier and Type	Method	Description
String	getAlternateHighlightField()	Returns the index field whose content should be used if no highlighting snippet is available.
String	getFormatter()	Returns the formatter that should be used for highlighting.
String	getFragmenter()	Returns the fragmenter that should be used for highlighting.
Integer	getFragSize()	Returns the maximal size a highlighted snippet should have.
String	getHightlightField()	Returns the index field that should be used for highlighting.
Integer	getMaxAlternateHighlightFieldLength()	Returns the maximal length of the snippet that should be shown from the alternative field, if no highlighting snippet was found.
String	getSimplePost()	Returns the String that should be inserted directly after the term that should be highlighted.
String	getSimplePre()	Returns the String that should be inserted directly in front of the term that should be highlighted.
Integer	getSnippetsCount()	Returns the number of highlighted snippets that should be returned.
Boolean	getUseFastVectorHighlighting()	Returns the flag, that indicates if fast vector highlighting should be used.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsSearchConfigurationHighlighting

public CmsSearchConfigurationHighlighting(String field,
 Integer snippetCount,
 Integer fragSize,
 String alternateField,
 Integer maxAlternateFieldLength,
 String pre,
 String post,
 String formatter,
 String fragmenter,
 Boolean useFastVectorHighlighting)

The constructor setting all configuration values.

Parameters:

field - The fields that should be used for highlighting. (Solr: hl.fl)

snippetCount - The number of snippets to return. (Solr: hl.snippets)

fragSize - The size of a snippet (in letters). (Solr: hl.fragsize)

alternateField - A field that should be displayed if no highlighting snippet is found. (Solr: hl.alternateField)

maxAlternateFieldLength - The maximal length of the snippet shown from the alternative field (in letters). (Solr: hl.maxAlternateFieldLength)

pre - The String added in front of the highlighted part. (Solr: hl.simple.pre)

post - The String added behind the highlighted part. (Solr: hl.simple.post)

formatter - The formatter used for highlighting. (Solr: hl.formatter)

fragmenter - The fragmenter used for highlighting. (Solr: hl.fragmenter)

useFastVectorHighlighting - Flag, indicating if fast vector highlighting should be used. (Solr: hl.useFastVectorHighlighting)

Method Details

getAlternateHighlightField

public String getAlternateHighlightField()

Description copied from interface: I_CmsSearchConfigurationHighlighting

Returns the index field whose content should be used if no highlighting snippet is available.

Specified by:

getAlternateHighlightField in interface I_CmsSearchConfigurationHighlighting

Returns:

The index field whose content should be used if no highlighting snippet is available. (Solr: hl.alternateField)

See Also:

• I_CmsSearchConfigurationHighlighting.getAlternateHighlightField()

getFormatter

public String getFormatter()

Description copied from interface: I_CmsSearchConfigurationHighlighting

Returns the formatter that should be used for highlighting.

Specified by:

getFormatter in interface I_CmsSearchConfigurationHighlighting

Returns:

The formatter that should be used for highlighting. (Solr: hl.formatter)

See Also:

• I_CmsSearchConfigurationHighlighting.getFormatter()

getFragmenter

public String getFragmenter()

Description copied from interface: I_CmsSearchConfigurationHighlighting

Returns the fragmenter that should be used for highlighting.

Specified by:

getFragmenter in interface I_CmsSearchConfigurationHighlighting

Returns:

The fragmenter that should be used for highlighting. (Solr: hl.fragmenter)

See Also:

• I_CmsSearchConfigurationHighlighting.getFragmenter()

getFragSize

public Integer getFragSize()

Description copied from interface: I_CmsSearchConfigurationHighlighting

Returns the maximal size a highlighted snippet should have.

Specified by:

getFragSize in interface I_CmsSearchConfigurationHighlighting

Returns:

The maximal size a highlighted snippet should have. (Solr: hl.fragsize)

See Also:

• I_CmsSearchConfigurationHighlighting.getFragSize()

getHightlightField

public String getHightlightField()

Description copied from interface: I_CmsSearchConfigurationHighlighting

Returns the index field that should be used for highlighting.

Specified by:

getHightlightField in interface I_CmsSearchConfigurationHighlighting

Returns:

The index field that should be used for highlighting.

See Also:

• I_CmsSearchConfigurationHighlighting.getHightlightField()

getMaxAlternateHighlightFieldLength

public Integer getMaxAlternateHighlightFieldLength()

Description copied from interface: I_CmsSearchConfigurationHighlighting

Returns the maximal length of the snippet that should be shown from the alternative field, if no highlighting snippet was found.

Specified by:

getMaxAlternateHighlightFieldLength in interface I_CmsSearchConfigurationHighlighting

Returns:

The maximal length of the snippet that should be shown from the alternative field, if no highlighting snippet was found. (Solr: hl.maxAlternateFieldLength)

See Also:

• I_CmsSearchConfigurationHighlighting.getMaxAlternateHighlightFieldLength()

getSimplePost

public String getSimplePost()

Description copied from interface: I_CmsSearchConfigurationHighlighting

Returns the String that should be inserted directly after the term that should be highlighted.

Specified by:

getSimplePost in interface I_CmsSearchConfigurationHighlighting

Returns:

The String that should be inserted directly after the term that should be highlighted. (Solr: hl.simple.post)

See Also:

• I_CmsSearchConfigurationHighlighting.getSimplePost()

getSimplePre

public String getSimplePre()

Description copied from interface: I_CmsSearchConfigurationHighlighting

Returns the String that should be inserted directly in front of the term that should be highlighted.

Specified by:

getSimplePre in interface I_CmsSearchConfigurationHighlighting

Returns:

The String that should be inserted directly in front the term that should be highlighted. (Solr: hl.simple.pre)

See Also:

• I_CmsSearchConfigurationHighlighting.getSimplePre()

getSnippetsCount

public Integer getSnippetsCount()

Description copied from interface: I_CmsSearchConfigurationHighlighting

Returns the number of highlighted snippets that should be returned.

Specified by:

getSnippetsCount in interface I_CmsSearchConfigurationHighlighting

Returns:

The number of highlighted snippets that should be returned. (Solr: hl.snippets)

See Also:

• I_CmsSearchConfigurationHighlighting.getSnippetsCount()

getUseFastVectorHighlighting

public Boolean getUseFastVectorHighlighting()

Description copied from interface: I_CmsSearchConfigurationHighlighting

Returns the flag, that indicates if fast vector highlighting should be used.

Specified by:

getUseFastVectorHighlighting in interface I_CmsSearchConfigurationHighlighting

Returns:

The flag, that indicates if fast vector highlighting should be used. (Solr: hl.useFastVectorHighlighting)

See Also:

• I_CmsSearchConfigurationHighlighting.getUseFastVectorHighlighting()