lumis.portal.bigdata.query

Class HighlightConfig

java.lang.Object

lumis.portal.bigdata.query.HighlightConfig

@StableMinor(version="12.5",
             sinceVersion="8.1")
public class HighlightConfig
extends Object

A search highlight configuration.

Since:

8.1.0

Version:

$Revision: 24140 $ $Date: 2020-09-14 21:50:42 +0000 (Mon, 14 Sep 2020) $

Constructor Summary

Constructors

Constructor and Description
HighlightConfig()

Method Summary

Modifier and Type	Method and Description
HighlightConfig	addHighlightFields(Collection<String> highlightFieldIds) Adds the given field identifiers as highlighted fields.
HighlightConfig	addHighlightFields(String... highlightFieldIds) Adds the given field identifiers as highlighted fields.
String	getEndHighlightTag() Returns the custom end highlight tag.
Integer	getFragmentSize() Returns the highlight fragment size.
List<String>	getHighlightFieldIds() Returns the highlight fields identifiers.
Integer	getNumberOfFragments() Returns the maximum number of fragments returned by the search.
String	getStartHighlightTag() Returns the custom start highlight tag.
HighlightConfig	setEndHighlightTag(String endHighlightTag) Sets the end highlight custom tag.
HighlightConfig	setFragmentSize(Integer fragmentSize) Sets the highlight fragment size.
HighlightConfig	setNumberOfFragments(Integer numberOfFragments) Sets the maximum number of fragments returned by the search.
HighlightConfig	setStartHighlightTag(String startHighlightTag) Sets the start highlight custom tag.

Methods inherited from class java.lang.Object

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

Constructor Detail

HighlightConfig

public HighlightConfig()

Method Detail

addHighlightFields

public HighlightConfig addHighlightFields(String... highlightFieldIds)

Adds the given field identifiers as highlighted fields.

Parameters:

highlightFieldIds - the field identifiers.

Returns:

this highlight configuration.

Since:

8.1.0

addHighlightFields

public HighlightConfig addHighlightFields(Collection<String> highlightFieldIds)

Adds the given field identifiers as highlighted fields.

Parameters:

highlightFieldIds - the field identifiers.

Returns:

this highlight configuration.

Since:

8.1.0

getHighlightFieldIds

public List<String> getHighlightFieldIds()

Returns the highlight fields identifiers.

Returns:

the highlight fields identifiers.

Since:

8.1.0

setEndHighlightTag

public HighlightConfig setEndHighlightTag(String endHighlightTag)

Sets the end highlight custom tag.

Parameters:

endHighlightTag - the end highlight custom tag.

Returns:

this highlight configuration.

Since:

8.1.0

setStartHighlightTag

public HighlightConfig setStartHighlightTag(String startHighlightTag)

Sets the start highlight custom tag.

Parameters:

startHighlightTag - the start highlight custom tag.

Returns:

this highlight configuration.

Since:

8.1.0

getStartHighlightTag

public String getStartHighlightTag()

Returns the custom start highlight tag.

Returns:

the custom start highlight tag.

Since:

8.1.0

getEndHighlightTag

public String getEndHighlightTag()

Returns the custom end highlight tag.

Returns:

the custom end highlight tag.

Since:

8.1.0

setFragmentSize

public HighlightConfig setFragmentSize(Integer fragmentSize)

Sets the highlight fragment size.

Parameters:

fragmentSize - the highlight fragment size.

Returns:

this highlight configuration.

Since:

8.1.0

getFragmentSize

public Integer getFragmentSize()

Returns the highlight fragment size.

Returns:

the highlight fragment size.

Since:

8.1.0

setNumberOfFragments

public HighlightConfig setNumberOfFragments(Integer numberOfFragments)

Sets the maximum number of fragments returned by the search.

Parameters:

numberOfFragments - the maximum number of fragments returned by the search.

Returns:

this highlight configuration.

Since:

8.1.0

getNumberOfFragments

public Integer getNumberOfFragments()

Returns the maximum number of fragments returned by the search.

Returns:

the maximum number of fragments returned by the search.

Since:

8.1.0