com.ibm.commerce.foundation.server.services.search.expression

Class AbstractSearchExpression

java.lang.Object

com.ibm.commerce.foundation.server.services.search.expression.AbstractSearchExpression

Direct Known Subclasses:

AbstractSolrSearchExpressionProvider, AbstractSolrSearchQueryPostprocessor, AbstractSolrSearchQueryPreprocessor, SolrRESTSearchExpressionProcessor, SolrSearchExpressionProcessor

public abstract class AbstractSearchExpression
extends java.lang.Object

This is the abstract class for processing search query expressions.

Constructor Summary

Constructors

Constructor and Description
AbstractSearchExpression()

Method Summary

Modifier and Type	Method and Description
void	addControlParameterValue(java.lang.String controlParameterName, java.lang.String controlParameterValue) Adds new value for a given control parameter in the SelectionCriteria object.
java.lang.String	getControlParameterValue(java.lang.String controlParameterName) Returns the first value in the given control parameter of the current SelectionCriteria object.
java.util.List	getControlParameterValues(java.lang.String controlParameterName) Returns a list of values for the given control parameter of the current SelectionCriteria object.
void	removeControlParameterValue(java.lang.String controlParameterName, java.lang.String controlParameterValue) Removes an existing value for a given control parameter in the SelectionCriteria object.
void	resetControlParameter(java.lang.String controlParameterName) Clears out the content and resets the given control parameter of the current SelectionCriteria object.
void	setControlParameterValue(java.lang.String controlParameterName, java.lang.String controlParameterValue) Assigns the given value to the first value in the given control parameter of the current SelectionCriteria object.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSearchExpression

public AbstractSearchExpression()

Method Detail

getControlParameterValue

public java.lang.String getControlParameterValue(java.lang.String controlParameterName)

Returns the first value in the given control parameter of the current SelectionCriteria object.

Parameters:

controlParameterName - Name of the control parameter

Returns:

control parameter value

getControlParameterValues

public java.util.List getControlParameterValues(java.lang.String controlParameterName)

Returns a list of values for the given control parameter of the current SelectionCriteria object.

Parameters:

controlParameterName - Name of the control parameter

Returns:

control parameter value

setControlParameterValue

public void setControlParameterValue(java.lang.String controlParameterName,
                                     java.lang.String controlParameterValue)

Assigns the given value to the first value in the given control parameter of the current SelectionCriteria object.

Parameters:

controlParameterName - Name of the control parameter

controlParameterValue - Value of the control parameter

addControlParameterValue

public void addControlParameterValue(java.lang.String controlParameterName,
                                     java.lang.String controlParameterValue)

Adds new value for a given control parameter in the SelectionCriteria object. If the control parameter does not exist it will be created and added to the SelectionCriteria object.

Parameters:

controlParameterName - Name of the control parameter

controlParameterValue - Additional value to be added

removeControlParameterValue

public void removeControlParameterValue(java.lang.String controlParameterName,
                                        java.lang.String controlParameterValue)

Removes an existing value for a given control parameter in the SelectionCriteria object. If the control parameter does not exist it will be ignored.

Parameters:

controlParameterName - Name of the control parameter

controlParameterValue - Value to be removed

resetControlParameter

public void resetControlParameter(java.lang.String controlParameterName)

Clears out the content and resets the given control parameter of the current SelectionCriteria object.

Parameters:

controlParameterName - Name of the control parameter