com.illucit.instatrie.splitter

Class HighlightedString

java.lang.Object

com.illucit.instatrie.splitter.HighlightedString

All Implemented Interfaces:

Serializable

public class HighlightedString
extends Object
implements Serializable

Result class to store the highlights of a search query in a model string.

Author:

Christian Simon

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HighlightedString.Highlight POJO to store highlight interval coordinates (position and length).
static class	HighlightedString.HighlightSegment POJO to store single segment in highlighted string.

Constructor Summary

Constructors

Constructor and Description
HighlightedString(String value) Construct hightlighted String instance without highlighting.
HighlightedString(String value, Collection<HighlightedString.Highlight> highlights) Construct hightlighted String.
HighlightedString(String value, HighlightedString.Highlight[] highlights) Construct hightlighted String.

Method Summary

Modifier and Type	Method and Description
List<HighlightedString.HighlightSegment>	getSegments() Get all highlighted segments.

Methods inherited from class java.lang.Object

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

Constructor Detail

HighlightedString

public HighlightedString(String value)

Construct hightlighted String instance without highlighting.

Parameters:

value - model value string

HighlightedString

public HighlightedString(String value,
                         HighlightedString.Highlight[] highlights)

Construct hightlighted String. It is required that the highlights do not overlap or exceed the length of the string.

Parameters:

value - model value string

highlights - array of highlights (found prefixes in model string)

HighlightedString

public HighlightedString(String value,
                         Collection<HighlightedString.Highlight> highlights)

Construct hightlighted String. It is required that the highlights do not overlap or exceed the length of the string.

Parameters:

value - model value string

highlights - collection of highlights (found prefixes in model string)

Method Detail

getSegments

public List<HighlightedString.HighlightSegment> getSegments()

Get all highlighted segments. The segments are disjunct and form the whole model value string on concatenation, while each segment can be either highlighted or not. Adjacent segments should not have the same highlighted characteristic. If highlights are overlapping or exceeding the string size, those parts of the highlights are ignored.

Returns:

list of segments in order