com.exalead.search.v30

Class HighlightOperation

java.lang.Object

com.exalead.search.v30.HitOperation

com.exalead.search.v30.MetaSpecificOperation

com.exalead.search.v30.HighlightOperation

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class HighlightOperation
extends MetaSpecificOperation
implements com.exalead.util.Checkable, java.io.Serializable

No documentation for this element.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HighlightOperation.RelaxAndNodesPolicy

Nested classes/interfaces inherited from class com.exalead.search.v30.MetaSpecificOperation

MetaSpecificOperation.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	analysisConfig
java.lang.String	analysisPipeline
static java.lang.String	DEFAULT_HIGHLIGHT_EXTRA_PREFIX_HANDLERS
static java.lang.String	DEFAULT_HIGHLIGHT_FACET_IDS
static int	DEFAULT_MAX_BYTES_TO_PROCESS
static int	DEFAULT_MAX_CONSECUTIVE_SEPARATORS
static int	DEFAULT_MIN_NB_WORDS_IN_RELEVANT_SENTENCE
static boolean	DEFAULT_MINIMAL_PATTERN_HIGHLIGHT
static java.lang.String	DEFAULT_RELAX_AND_NODES_POLICY
java.lang.String	highlightExtraPrefixHandlers
java.lang.String	highlightFacetIds
int	maxBytesToProcess
int	maxConsecutiveSeparators
boolean	minimalPatternHighlight
int	minNbWordsInRelevantSentence
java.lang.String	relaxAndNodesPolicy

Fields inherited from class com.exalead.search.v30.MetaSpecificOperation

name

Constructor Summary

Constructors

Constructor and Description
HighlightOperation()
HighlightOperation(HighlightOperation o) Copy constructor
HighlightOperation(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	accept(HitOperation.Visitor visitor)
void	accept(MetaSpecificOperation.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this HighlightOperation.
static HighlightOperation	fromString(java.lang.String s) String representation of this HighlightOperation.
java.lang.String	getAnalysisConfig() Analysis config in which analysisPipeline is searched for tokenization config and extra semantic processors.
java.lang.String	getAnalysisPipeline() Pipeline in analysisConfig searched for tokenization config and extra semantic processors.
java.lang.String	getHighlightExtraPrefixHandlers()
java.lang.String	getHighlightFacetIds()
int	getMaxBytesToProcess() Maximum number of bytes to process in the input text.
int	getMaxConsecutiveSeparators() Maximum number of consecutive separators.
int	getMinNbWordsInRelevantSentence() Minimum number of words for a sentence to be considered for snippetization
java.lang.String	getRelaxAndNodesPolicy() Relax query AND nodes (handle them as if they were OR nodes).
HighlightOperation.RelaxAndNodesPolicy	getRelaxAndNodesPolicyAsEnum() Relax query AND nodes (handle them as if they were OR nodes).
static boolean	isA(java.lang.String str, HighlightOperation.RelaxAndNodesPolicy item)
boolean	isMinimalPatternHighlight() If true, only highlights the alphanumerical part of the pattern.
static boolean	isOneOf(java.lang.String str, HighlightOperation.RelaxAndNodesPolicy... items)
HighlightOperation	makeCopy() Creates and returns a deep copy of this HighlightOperation.
static HighlightOperation	readFrom(java.io.InputStream is) Read this HighlightOperation from an XML fragment.
void	setAnalysisConfig(java.lang.String analysisConfig) Analysis config in which analysisPipeline is searched for tokenization config and extra semantic processors.
void	setAnalysisPipeline(java.lang.String analysisPipeline) Pipeline in analysisConfig searched for tokenization config and extra semantic processors.
void	setHighlightExtraPrefixHandlers(java.lang.String highlightExtraPrefixHandlers)
void	setHighlightFacetIds(java.lang.String highlightFacetIds)
void	setMaxBytesToProcess(int maxBytesToProcess) Maximum number of bytes to process in the input text.
void	setMaxConsecutiveSeparators(int maxConsecutiveSeparators) Maximum number of consecutive separators.
void	setMinimalPatternHighlight(boolean minimalPatternHighlight) If true, only highlights the alphanumerical part of the pattern.
void	setMinNbWordsInRelevantSentence(int minNbWordsInRelevantSentence) Minimum number of words for a sentence to be considered for snippetization
void	setRelaxAndNodesPolicy(HighlightOperation.RelaxAndNodesPolicy item) Relax query AND nodes (handle them as if they were OR nodes).
void	setRelaxAndNodesPolicy(java.lang.String relaxAndNodesPolicy) Relax query AND nodes (handle them as if they were OR nodes).
java.lang.String	toString() String representation of this HighlightOperation.
HighlightOperation	withAnalysisConfig(java.lang.String analysisConfig)
HighlightOperation	withAnalysisPipeline(java.lang.String analysisPipeline)
HighlightOperation	withHighlightExtraPrefixHandlers(java.lang.String highlightExtraPrefixHandlers)
HighlightOperation	withHighlightFacetIds(java.lang.String highlightFacetIds)
HighlightOperation	withMaxBytesToProcess(int maxBytesToProcess)
HighlightOperation	withMaxBytesToProcess(java.lang.Integer maxBytesToProcess)
HighlightOperation	withMaxConsecutiveSeparators(int maxConsecutiveSeparators)
HighlightOperation	withMaxConsecutiveSeparators(java.lang.Integer maxConsecutiveSeparators)
HighlightOperation	withMinimalPatternHighlight(boolean minimalPatternHighlight)
HighlightOperation	withMinimalPatternHighlight(java.lang.Boolean minimalPatternHighlight)
HighlightOperation	withMinNbWordsInRelevantSentence(int minNbWordsInRelevantSentence)
HighlightOperation	withMinNbWordsInRelevantSentence(java.lang.Integer minNbWordsInRelevantSentence)
HighlightOperation	withName(java.lang.String name)
HighlightOperation	withRelaxAndNodesPolicy(java.lang.String relaxAndNodesPolicy)
void	writeTo(java.io.OutputStream os) Write this HighlightOperation as an XML fragment

Methods inherited from class com.exalead.search.v30.MetaSpecificOperation

getName, setName

Methods inherited from class java.lang.Object

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

Field Detail

highlightFacetIds

public java.lang.String highlightFacetIds

DEFAULT_HIGHLIGHT_FACET_IDS

public static final java.lang.String DEFAULT_HIGHLIGHT_FACET_IDS

See Also:

Constant Field Values

highlightExtraPrefixHandlers

public java.lang.String highlightExtraPrefixHandlers

DEFAULT_HIGHLIGHT_EXTRA_PREFIX_HANDLERS

public static final java.lang.String DEFAULT_HIGHLIGHT_EXTRA_PREFIX_HANDLERS

See Also:

Constant Field Values

minNbWordsInRelevantSentence

public int minNbWordsInRelevantSentence

DEFAULT_MIN_NB_WORDS_IN_RELEVANT_SENTENCE

public static final int DEFAULT_MIN_NB_WORDS_IN_RELEVANT_SENTENCE

See Also:

Constant Field Values

maxBytesToProcess

public int maxBytesToProcess

DEFAULT_MAX_BYTES_TO_PROCESS

public static final int DEFAULT_MAX_BYTES_TO_PROCESS

See Also:

Constant Field Values

maxConsecutiveSeparators

public int maxConsecutiveSeparators

DEFAULT_MAX_CONSECUTIVE_SEPARATORS

public static final int DEFAULT_MAX_CONSECUTIVE_SEPARATORS

See Also:

Constant Field Values

relaxAndNodesPolicy

public java.lang.String relaxAndNodesPolicy

DEFAULT_RELAX_AND_NODES_POLICY

public static final java.lang.String DEFAULT_RELAX_AND_NODES_POLICY

See Also:

Constant Field Values

minimalPatternHighlight

public boolean minimalPatternHighlight

DEFAULT_MINIMAL_PATTERN_HIGHLIGHT

public static final boolean DEFAULT_MINIMAL_PATTERN_HIGHLIGHT

See Also:

Constant Field Values

analysisConfig

public java.lang.String analysisConfig

analysisPipeline

public java.lang.String analysisPipeline

Constructor Detail

HighlightOperation

public HighlightOperation()

HighlightOperation

public HighlightOperation(java.lang.String name)

HighlightOperation

public HighlightOperation(HighlightOperation o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          HighlightOperation.RelaxAndNodesPolicy item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              HighlightOperation.RelaxAndNodesPolicy... items)

setRelaxAndNodesPolicy

public void setRelaxAndNodesPolicy(HighlightOperation.RelaxAndNodesPolicy item)

Relax query AND nodes (handle them as if they were OR nodes). Value can be null or one of

• never
• toplevel
• always

getRelaxAndNodesPolicyAsEnum

public HighlightOperation.RelaxAndNodesPolicy getRelaxAndNodesPolicyAsEnum()

Relax query AND nodes (handle them as if they were OR nodes). Value can be null or one of

• never
• toplevel
• always

withName

public HighlightOperation withName(java.lang.String name)

Overrides:

withName in class MetaSpecificOperation

setHighlightFacetIds

public void setHighlightFacetIds(java.lang.String highlightFacetIds)

getHighlightFacetIds

public java.lang.String getHighlightFacetIds()

withHighlightFacetIds

public HighlightOperation withHighlightFacetIds(java.lang.String highlightFacetIds)

setHighlightExtraPrefixHandlers

public void setHighlightExtraPrefixHandlers(java.lang.String highlightExtraPrefixHandlers)

getHighlightExtraPrefixHandlers

public java.lang.String getHighlightExtraPrefixHandlers()

withHighlightExtraPrefixHandlers

public HighlightOperation withHighlightExtraPrefixHandlers(java.lang.String highlightExtraPrefixHandlers)

setMinNbWordsInRelevantSentence

public void setMinNbWordsInRelevantSentence(int minNbWordsInRelevantSentence)

Minimum number of words for a sentence to be considered for snippetization

getMinNbWordsInRelevantSentence

public int getMinNbWordsInRelevantSentence()

Minimum number of words for a sentence to be considered for snippetization

withMinNbWordsInRelevantSentence

public HighlightOperation withMinNbWordsInRelevantSentence(int minNbWordsInRelevantSentence)

withMinNbWordsInRelevantSentence

public HighlightOperation withMinNbWordsInRelevantSentence(java.lang.Integer minNbWordsInRelevantSentence)

setMaxBytesToProcess

public void setMaxBytesToProcess(int maxBytesToProcess)

Maximum number of bytes to process in the input text. The remaining bytes are not taken into account for the operation. (0=deactivated)

getMaxBytesToProcess

public int getMaxBytesToProcess()

Maximum number of bytes to process in the input text. The remaining bytes are not taken into account for the operation. (0=deactivated)

withMaxBytesToProcess

public HighlightOperation withMaxBytesToProcess(int maxBytesToProcess)

withMaxBytesToProcess

public HighlightOperation withMaxBytesToProcess(java.lang.Integer maxBytesToProcess)

setMaxConsecutiveSeparators

public void setMaxConsecutiveSeparators(int maxConsecutiveSeparators)

Maximum number of consecutive separators. When there are more than this number of separators, they are replaced with a single space character.

getMaxConsecutiveSeparators

public int getMaxConsecutiveSeparators()

Maximum number of consecutive separators. When there are more than this number of separators, they are replaced with a single space character.

withMaxConsecutiveSeparators

public HighlightOperation withMaxConsecutiveSeparators(int maxConsecutiveSeparators)

withMaxConsecutiveSeparators

public HighlightOperation withMaxConsecutiveSeparators(java.lang.Integer maxConsecutiveSeparators)

setRelaxAndNodesPolicy

public void setRelaxAndNodesPolicy(java.lang.String relaxAndNodesPolicy)

Relax query AND nodes (handle them as if they were OR nodes). Value can be null or one of

• never
• toplevel
• always

getRelaxAndNodesPolicy

public java.lang.String getRelaxAndNodesPolicy()

Relax query AND nodes (handle them as if they were OR nodes). Value can be null or one of

• never
• toplevel
• always

withRelaxAndNodesPolicy

public HighlightOperation withRelaxAndNodesPolicy(java.lang.String relaxAndNodesPolicy)

setMinimalPatternHighlight

public void setMinimalPatternHighlight(boolean minimalPatternHighlight)

If true, only highlights the alphanumerical part of the pattern. For example, *foo* will only highlight foo in the word football.

isMinimalPatternHighlight

public boolean isMinimalPatternHighlight()

If true, only highlights the alphanumerical part of the pattern. For example, *foo* will only highlight foo in the word football.

withMinimalPatternHighlight

public HighlightOperation withMinimalPatternHighlight(boolean minimalPatternHighlight)

withMinimalPatternHighlight

public HighlightOperation withMinimalPatternHighlight(java.lang.Boolean minimalPatternHighlight)

setAnalysisConfig

public void setAnalysisConfig(java.lang.String analysisConfig)

Analysis config in which analysisPipeline is searched for tokenization config and extra semantic processors.

getAnalysisConfig

public java.lang.String getAnalysisConfig()

Analysis config in which analysisPipeline is searched for tokenization config and extra semantic processors.

withAnalysisConfig

public HighlightOperation withAnalysisConfig(java.lang.String analysisConfig)

setAnalysisPipeline

public void setAnalysisPipeline(java.lang.String analysisPipeline)

Pipeline in analysisConfig searched for tokenization config and extra semantic processors.

getAnalysisPipeline

public java.lang.String getAnalysisPipeline()

Pipeline in analysisConfig searched for tokenization config and extra semantic processors.

withAnalysisPipeline

public HighlightOperation withAnalysisPipeline(java.lang.String analysisPipeline)

makeCopy

public HighlightOperation makeCopy()

Creates and returns a deep copy of this HighlightOperation.

Overrides:

makeCopy in class MetaSpecificOperation

readFrom

public static HighlightOperation readFrom(java.io.InputStream is)
                                   throws javax.xml.bind.JAXBException

Read this HighlightOperation from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this HighlightOperation as an XML fragment

Overrides:

writeTo in class MetaSpecificOperation

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static HighlightOperation fromString(java.lang.String s)
                                     throws javax.xml.bind.JAXBException,
                                            java.io.UnsupportedEncodingException

String representation of this HighlightOperation.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this HighlightOperation.

Overrides:

toString in class MetaSpecificOperation

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this HighlightOperation.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class MetaSpecificOperation

Throws:

com.exalead.util.TypedException

accept

public void accept(MetaSpecificOperation.Visitor visitor)
            throws com.exalead.util.TypedException

Specified by:

accept in class MetaSpecificOperation

Throws:

com.exalead.util.TypedException

accept

public void accept(HitOperation.Visitor visitor)
            throws com.exalead.util.TypedException

Specified by:

accept in class HitOperation

Throws:

com.exalead.util.TypedException