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.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final org.apache.commons.logging.Log	LOG	Logger for the class.

Constructor Summary

Constructors

Constructor	Description
CmsSearchConfigurationHighlighting(Map<String,String> params)	The constructor setting all configuration values.

Method Summary

Modifier and Type	Method	Description
String	getAlternateHighlightField()	Deprecated.
String	getFormatter()	Deprecated.
String	getFragmenter()	Deprecated.
Integer	getFragSize()	Deprecated.
String	getHightlightField()	Deprecated.
Integer	getMaxAlternateHighlightFieldLength()	Deprecated.
Map<String,String>	getParams()	Returns the value set for the configuration parameter.
String	getSimplePost()	Deprecated.
String	getSimplePre()	Deprecated.
Integer	getSnippetsCount()	Deprecated.
Boolean	getUseFastVectorHighlighting()	Deprecated.

Methods inherited from class java.lang.Object

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

Field Details

LOG

protected static final org.apache.commons.logging.Log LOG

Logger for the class.

Constructor Details

CmsSearchConfigurationHighlighting

public CmsSearchConfigurationHighlighting(Map<String,String> params)

The constructor setting all configuration values.

Parameters:

params - the highlighting parameters as given to solr, all without the "hl." prefix that is added automatically.

Method Details

getAlternateHighlightField

@Deprecated
public String getAlternateHighlightField()

Deprecated.

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

@Deprecated
public String getFormatter()

Deprecated.

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

@Deprecated
public String getFragmenter()

Deprecated.

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

@Deprecated
public Integer getFragSize()

Deprecated.

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

@Deprecated
public String getHightlightField()

Deprecated.

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

@Deprecated
public Integer getMaxAlternateHighlightFieldLength()

Deprecated.

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()

getParams

public Map<String,String> getParams()

Description copied from interface: I_CmsSearchConfigurationHighlighting

Returns the value set for the configuration parameter.

Specified by:

getParams in interface I_CmsSearchConfigurationHighlighting

Returns:

the value that is set, or null if the value is not set explicitly.

See Also:

• I_CmsSearchConfigurationHighlighting.getParams()

getSimplePost

@Deprecated
public String getSimplePost()

Deprecated.

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

@Deprecated
public String getSimplePre()

Deprecated.

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

@Deprecated
public Integer getSnippetsCount()

Deprecated.

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

@Deprecated
public Boolean getUseFastVectorHighlighting()

Deprecated.

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()