org.eclipse.smila.search.highlighting.transformer
Class HighlightingTransformer

java.lang.Object
  org.eclipse.smila.search.highlighting.transformer.HighlightingTransformer

Direct Known Subclasses:

ComplexHLResultAggregation, MaxTextLength, Sentence

public abstract class HighlightingTransformer
extends java.lang.Object

Abstract base class for HighlightingTransformer implementations.

Field Summary

static java.lang.String	PARAM_HL_ELEMENT_FILTER Constant for the parameter HLElementFilter.
static java.lang.String	PARAM_MARKUP_PREFIX Constant for the parameter MarkupPrefix.
static java.lang.String	PARAM_MARKUP_SUFFIX Constant for the parameter MarkupSuffix.
static java.lang.String	PARAM_MAX_HL_ELEMENTS Constant for the parameter MaxHLElements.
static java.lang.String	PARAM_MAX_LENGTH Constant for the parameter MaxLength.
static java.lang.String	PARAM_MAX_PRECEDING_CHARACTERS Constant for the parameter MaxPrecedingCharacters.
static java.lang.String	PARAM_MAX_SUCCEEDING_CHARACTERS Constant for the parameter MaxSucceedingCharacters.
static java.lang.String	PARAM_PRECEDING_CHARACTERS Constant for the parameter PrecedingCharacters.
static java.lang.String	PARAM_SORT_ALGORITHM Constant for the parameter SortAlgorithm.
static java.lang.String	PARAM_SUCCEEDING_CHARACTERS Constant for the parameter SucceedingCharacters.
static java.lang.String	PARAM_TEXT_HANDLING Constant for the parameter TextHandling.

Constructor Summary

HighlightingTransformer()

Method Summary

protected ParameterSet	createParameterSet(DParameterSet dParameterSet) Creates a ParameterSet from a given DParameterSet configuration, merging it with the DParameterDefinition (applying defaults).
Annotation	transform(Annotation highlight, DParameterSet highlightConfig) Performs the transformation of the given highlight annotation and returns the modified annotation.
protected abstract java.util.ArrayList<java.lang.Object>	transform(java.util.ArrayList<java.lang.Object> data, ParameterSet parameterSet) Deprecated. use Annotation transform(Annotation highlight) instead

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_HL_ELEMENT_FILTER

public static final java.lang.String PARAM_HL_ELEMENT_FILTER

Constant for the parameter HLElementFilter.

See Also:

Constant Field Values

PARAM_MARKUP_PREFIX

public static final java.lang.String PARAM_MARKUP_PREFIX

Constant for the parameter MarkupPrefix.

See Also:

Constant Field Values

PARAM_MARKUP_SUFFIX

public static final java.lang.String PARAM_MARKUP_SUFFIX

Constant for the parameter MarkupSuffix.

See Also:

Constant Field Values

PARAM_MAX_HL_ELEMENTS

public static final java.lang.String PARAM_MAX_HL_ELEMENTS

Constant for the parameter MaxHLElements.

See Also:

Constant Field Values

PARAM_MAX_LENGTH

public static final java.lang.String PARAM_MAX_LENGTH

Constant for the parameter MaxLength.

See Also:

Constant Field Values

PARAM_MAX_PRECEDING_CHARACTERS

public static final java.lang.String PARAM_MAX_PRECEDING_CHARACTERS

Constant for the parameter MaxPrecedingCharacters.

See Also:

Constant Field Values

PARAM_MAX_SUCCEEDING_CHARACTERS

public static final java.lang.String PARAM_MAX_SUCCEEDING_CHARACTERS

Constant for the parameter MaxSucceedingCharacters.

See Also:

Constant Field Values

PARAM_PRECEDING_CHARACTERS

public static final java.lang.String PARAM_PRECEDING_CHARACTERS

Constant for the parameter PrecedingCharacters.

See Also:

Constant Field Values

PARAM_SORT_ALGORITHM

public static final java.lang.String PARAM_SORT_ALGORITHM

Constant for the parameter SortAlgorithm.

See Also:

Constant Field Values

PARAM_SUCCEEDING_CHARACTERS

public static final java.lang.String PARAM_SUCCEEDING_CHARACTERS

Constant for the parameter SucceedingCharacters.

See Also:

Constant Field Values

PARAM_TEXT_HANDLING

public static final java.lang.String PARAM_TEXT_HANDLING

Constant for the parameter TextHandling.

See Also:

Constant Field Values

Constructor Detail

HighlightingTransformer

public HighlightingTransformer()

Method Detail

transform

protected abstract java.util.ArrayList<java.lang.Object> transform(java.util.ArrayList<java.lang.Object> data,
                                                                   ParameterSet parameterSet)
                                                            throws HighlightingTransformerException

Deprecated. use Annotation transform(Annotation highlight) instead

Performs the actual transformation/validation of result structure. Transformer parameters can be accessed via the getParameterSet().getXXXParameter() methods.

Parameters:

data - the list of Strings and DHighLighted objects

parameterSet - the ParameterSet

Returns:

ArrayList

Throws:

HighlightingTransformerException - - if an error occurred during transformation

transform

public Annotation transform(Annotation highlight,
                            DParameterSet highlightConfig)
                     throws HighlightingTransformerException,
                            ParameterException

Performs the transformation of the given highlight annotation and returns the modified annotation.

Parameters:

highlight - the highlight annotation

highlightConfig - the highlightConfig

Returns:

the transformed highlight annotation

Throws:

HighlightingTransformerException - if any transformation error occurs

ParameterException - if there is any configuration error

createParameterSet

protected ParameterSet createParameterSet(DParameterSet dParameterSet)
                                   throws ParameterException

Creates a ParameterSet from a given DParameterSet configuration, merging it with the DParameterDefinition (applying defaults).

Parameters:

dParameterSet - the DParameterSet

Returns:

a ParameterSet

Throws:

ParameterException - if any error occurs