SMILA (incubation) API documentation

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

java.lang.Object
  extended by org.eclipse.smila.search.highlighting.transformer.HighlightingTransformer
      extended by org.eclipse.smila.search.highlighting.transformer.Sentence

public class Sentence
extends HighlightingTransformer

The sentence highlighting transformer is able to highlight information taking sentence boundaries into credit.

Author:
brox IT-Solutions GmbH

Field Summary
 
Fields inherited from class org.eclipse.smila.search.highlighting.transformer.HighlightingTransformer
PARAM_HL_ELEMENT_FILTER, PARAM_MARKUP_PREFIX, PARAM_MARKUP_SUFFIX, PARAM_MAX_HL_ELEMENTS, PARAM_MAX_LENGTH, PARAM_MAX_PRECEDING_CHARACTERS, PARAM_MAX_SUCCEEDING_CHARACTERS, PARAM_PRECEDING_CHARACTERS, PARAM_SORT_ALGORITHM, PARAM_SUCCEEDING_CHARACTERS, PARAM_TEXT_HANDLING
 
Constructor Summary
Sentence()
           
 
Method Summary
 java.util.ArrayList<java.lang.Object> transform(java.util.ArrayList<java.lang.Object> data, ParameterSet parameterSet)
          Performs the actual transformation/validation of result structure.
 
Methods inherited from class org.eclipse.smila.search.highlighting.transformer.HighlightingTransformer
createParameterSet, transform
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Sentence

public Sentence()
Method Detail

transform

public java.util.ArrayList<java.lang.Object> transform(java.util.ArrayList<java.lang.Object> data,
                                                       ParameterSet parameterSet)
                                                throws HighlightingTransformerException
Performs the actual transformation/validation of result structure. Transformer parameters can be accessed via the getParameterSet().getXXXParameter() methods.

Specified by:
transform in class HighlightingTransformer
Parameters:
data - the list of Strings and DHighLighted objects
parameterSet - the ParameterSet
Returns:
ArrayList
Throws:
HighlightingTransformerException - - if an error occurred during transformation
See Also:
org.eclipse.smila.search.highlighting.transformer.HighlightingTransformer#transform(java.util.ArrayList)

SMILA (incubation) API documentation